Skip to content

Commit 308e131

Browse files
mcsprearlephilhower
authored andcommitted
Update EEPROM library documentation (#6548)
Update EEPROM description with mention of current implementation limitations Move ESP_EEPROM to Other Libraries, update description from upstream README Add https://github.com/xoseperez/eeprom_rotate to Other Libraries as an alternative
1 parent 69f3e81 commit 308e131

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

doc/libraries.rst

+4-8
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ EEPROM library uses one sector of flash located just after the SPIFFS.
2929

3030
`Three examples <https://github.com/esp8266/Arduino/tree/master/libraries/EEPROM>`__ included.
3131

32+
Note that the sector needs to be re-flashed every time the changed EEPROM data needs to be saved, thus will wear out the flash memory very quickly even if small amounts of data are written. Consider using one of the EEPROM libraries mentioned down below.
33+
3234
I2C (Wire library)
3335
------------------
3436

@@ -141,14 +143,6 @@ Servo
141143

142144
This library exposes the ability to control RC (hobby) servo motors. It will support up to 24 servos on any available output pin. By default the first 12 servos will use Timer0 and currently this will not interfere with any other support. Servo counts above 12 will use Timer1 and features that use it will be affected. While many RC servo motors will accept the 3.3V IO data pin from a ESP8266, most will not be able to run off 3.3v and will require another power source that matches their specifications. Make sure to connect the grounds between the ESP8266 and the servo motor power supply.
143145

144-
Improved EEPROM library for ESP (ESP_EEPROM)
145-
--------------------------------------------
146-
147-
An improved EEPROM library for ESPxxxx. Uses flash memory as per the standard ESP EEPROM library but reduces reflash - so reducing wear and improving commit() performance.
148-
149-
As actions on the flash need to stop the interrupts, an EEPROM reflash could noticably affect anything using PWM, etc.
150-
151-
152146
Other libraries (not included with the IDE)
153147
-------------------------------------------
154148

@@ -189,3 +183,5 @@ Libraries that don't rely on low-level access to AVR registers should work well.
189183
- `MFRC522 <https://github.com/miguelbalboa/rfid>`__ - A library for using the Mifare RC522 RFID-tag reader/writer.
190184
- `Ping <https://github.com/dancol90/ESP8266Ping>`__ - lets the ESP8266 ping a remote machine.
191185
- `AsyncPing <https://github.com/akaJes/AsyncPing>`__ - fully asynchronous Ping library (have full ping statistic and hardware MAC address).
186+
- `ESP_EEPROM <https://github.com/jwrw/ESP_EEPROM>`__ - This library writes a new copy of your data when you save (commit) it and keeps track of where in the sector the most recent copy is kept using a bitmap. The flash sector only needs to be erased when there is no more space for copies in the flash sector.
187+
- `EEPROM Rotate <https://github.com/xoseperez/eeprom_rotate>`__ - Instead of using a single sector to persist the data from the emulated EEPROM, this library uses a number of sectors to do so: a sector pool.

0 commit comments

Comments
 (0)