/ConfigStorage

ESP_ConfigStore is a library for the ESP32/ESP8266 Arduino platform to store configuration parameters in the file system.

Primary LanguageC++MIT LicenseMIT

ConfigStorage

ConfigStorage is a library for the ESP32/ESP8266 Arduino platform to store configuration parameters in the file system using LittleFS or SPIFFS. Using the ArduinoJson library the parameters are stored in memory as a JSON document and saved as a JSON file.

GitHub



Table of Contents



Prerequisites

  1. Arduino IDE 1.8.19+ for Arduino. GitHub release
  2. ESP32 Core 2.0.2+ for ESP32-based boards. Latest release
  3. ESP8266 Core 3.0.2+ for ESP8266-based boards. Latest release. SPIFFS is deprecated from ESP8266 core 2.7.1+, to use LittleFS.
  4. LittleFS_esp32 v1.0.6+ for ESP32-based boards using LittleFS with ESP32 core v1.0.5-. To install, check arduino-library-badge. Notice: This LittleFS_esp32 library has been integrated to Arduino ESP32 core v1.0.6+ and you don't need to install it if using ESP32 core v1.0.6+
  5. ArduinoJson v6.19.4+ for embedded C++. To install, check arduino-library-badge.


Installation

Use Arduino Library Manager

The best and easiest way is to use Arduino Library Manager. Search for ConfigStorage, then select / install the latest version. You can also use this link arduino-library-badge for more detailed instructions.

Manual Install

  1. Navigate to ConfigStorage page.
  2. Download the latest release ConfigStorage-main.zip.
  3. Extract the zip file to ConfigStorage-main directory
  4. Copy the whole ConfigStorage-main folder to Arduino libraries' directory such as ~/Arduino/libraries/.

VS Code & PlatformIO:

  1. Install VS Code
  2. Install PlatformIO
  3. Install ConfigStorage library by using Library Manager. Search for ConfigStorage in Platform.io Author's Libraries
  4. Use included platformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at Project Configuration File