Preferences (community library)

Summary

Name Value
Name Preferences
Version 2.0.0
Installs 617
Author Volodymyr Shymanskyy
Maintainer Volodymyr Shymanskyy vshymanskyi@gmail.com
URL https://github.com/vshymanskyy/Preferences
Download .tar.gz

Preferences library for ESP8266 and Particle Gen3 devices, with ESP32-compatible API

Example Build Testing

Device OS Version:

This table is generated from an automated build. Success only indicates that the code compiled successfully.

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

Preferences

Preferences library for ESP8266 and Particle Gen3 devices. ESP32-compatible API.

Stand With Ukraine

How does it work?

Preferences are stored in the internal flash filesystem in a bunch of /nvs/{namespace}/{property} files. Filesystem should handle flash wearing, bad sectors and atomic rename file operation. LittleFS handles all that, so this is the default FS driver for ESP8266. Particle Gen3 devices also operate on LittleFS filesystem.

Supported devices

  • Arduino ESP8266 with LittleFS or SPIFFS
  • Particle Argon, Boron, Xenon, Tracker, BSOM

Can be easily adjusted for any device with a reliable and POSIX-compatible filesystem

API

Check out ESP32 Preferences library API. Differences:

  • partition_label argument is not supported in begin()
  • getType() and freeEntries() methods are not supported (returning dummy values)

Browse Library Files