rebase eeprom lib and add partition

Author: fedy0

libraries/EEPROM/examples/eeprom_class/eeprom_class.ino

@@ -1,50 +1,64 @@
 /*
-  ESP32 eeprom_class example with EEPROM library
+  ESP32 eeprom_class example with EEPROM library and custom partiton
+
   This simple example demonstrates using EEPROM library to store different data in
-  ESP32 Flash memory in a multiple user-defined EEPROM class objects.
+  ESP32 Flash memory in a multiple user-defined EEPROM partition (0x1000 or 4KB max size or less).
+  Note: You must maintain a minimum sector address/offset of 4KB between partitions
+  Usage: EEPROMClass ANY_OBJECT_NAME("partition_name", size);
+  
+  Partition example created in the same sketch folder as this example 
+  (See ./eeprom_class/partitions.csv)
   
+  #Name,   Type, SubType, Offset,   Size,    Flags
+  nvs,     data, nvs,     0x9000,   0x5000,
+  otadata, data, ota,     0xe000,   0x2000,
+  app0,    app,  ota_0,   0x10000,  0x140000,
+  app1,    app,  ota_1,   0x150000, 0x140000,
+  eeprom0, data, 0x99,    0x290000, 0x1000,
+  eeprom1, data, 0x9a,    0x291000, 0x500,
+  eeprom2, data, 0x9b,    0x292000, 0x100,
+  spiffs,  data, spiffs,  0x293000, 0x16d000,
+
   Created for arduino-esp32 on 25 Dec, 2017
   by Elochukwu Ifediora (fedy0)
-  converted to nvs by lbernstone - 06/22/2019
 */
 
 #include "EEPROM.h"
 
-// Instantiate eeprom objects with parameter/argument names and sizes
-EEPROMClass  NAMES("eeprom0");
-EEPROMClass  HEIGHT("eeprom1");
-EEPROMClass  AGE("eeprom2");
+// Instantiate eeprom objects with parameter/argument names and size same as in the partition table
+EEPROMClass  NAMES("eeprom0", 0x1000);
+EEPROMClass  HEIGHT("eeprom1", 0x500);
+EEPROMClass  AGE("eeprom2", 0x100);
 
 void setup() {
+  // put your setup code here, to run once:
   Serial.begin(115200);
-  delay(1000);
   Serial.println("Testing EEPROMClass\n");
-  if (!NAMES.begin(0x500)) {
+  if (!NAMES.begin(NAMES.length())) {
     Serial.println("Failed to initialise NAMES");
     Serial.println("Restarting...");
     delay(1000);
     ESP.restart();
   }
-  if (!HEIGHT.begin(0x200)) {
+  if (!HEIGHT.begin(HEIGHT.length())) {
     Serial.println("Failed to initialise HEIGHT");
     Serial.println("Restarting...");
     delay(1000);
     ESP.restart();
   }
-  if (!AGE.begin(0x100)) {
+  if (!AGE.begin(AGE.length())) {
     Serial.println("Failed to initialise AGE");
     Serial.println("Restarting...");
     delay(1000);
     ESP.restart();
   }
 
-  const char* name = "Teo Swee Ann";
-  char rname[32];
+  char* name = "Teo Swee Ann";
   double height = 5.8;
   uint32_t age = 47;
 
-  // Write: Variables ---> EEPROM stores
-  NAMES.writeString(0, name);
+  // Write: Variables ---> EEPROM partitions
+  NAMES.put(0, name);
   HEIGHT.put(0, height);
   AGE.put(0, age);
   Serial.print("name: ");   Serial.println(name);
@@ -53,25 +67,26 @@ void setup() {
   Serial.println("------------------------------------\n");
 
   // Clear variables
-  rname[0] = '\0';
+  name = NULL;
   height = 0;
   age = 0;
-  Serial.print("name: ");   Serial.println(rname);
+  Serial.print("name: ");   Serial.println(name);
   Serial.print("height: "); Serial.println(height);
   Serial.print("age: ");    Serial.println(age);
   Serial.println("------------------------------------\n");
 
-  // Read: Variables <--- EEPROM stores
-  NAMES.get(0, rname);
+  // Read: Variables <--- EEPROM partitions
+  NAMES.get(0, name);
   HEIGHT.get(0, height);
   AGE.get(0, age);
-  Serial.print("name: ");   Serial.println(rname);
+  Serial.print("name: ");   Serial.println(name);
   Serial.print("height: "); Serial.println(height);
   Serial.print("age: ");    Serial.println(age);
 
   Serial.println("Done!");
 }
 
 void loop() {
-  delay(0xFFFFFFFF);
+  // put your main code here, to run repeatedly:
+
 }

libraries/EEPROM/examples/eeprom_class/partitions.csv

@@ -0,0 +1,9 @@
+#Name,   Type, SubType, Offset,   Size,    Flags
+nvs,     data, nvs,     0x9000,   0x5000,
+otadata, data, ota,     0xe000,   0x2000,
+app0,    app,  ota_0,   0x10000,  0x140000,
+app1,    app,  ota_1,   0x150000, 0x140000,
+eeprom0, data, 0x99,    0x290000, 0x1000,
+eeprom1, data, 0x9a,    0x291000, 0x500,
+eeprom2, data, 0x9b,    0x292000, 0x100,
+spiffs,  data, spiffs,  0x293000, 0x16d000,

libraries/EEPROM/examples/eeprom_extra/eeprom_extra.ino

@@ -1,7 +1,12 @@
 /*
   ESP32 eeprom_extra example with EEPROM library
 
-  This simple example demonstrates using other EEPROM library resources
+  This simple example demonstrates using other EEPROM library resources.
+  
+  You need to define AT LEAST a flash partition for EEPROM  with the name below
+  eeprom, data, 0x99, "start address", 0x1000
+  
+  Note: For this Arduino sketch, "eeprom" is already defined in ./eeprom_extra/partitions.csv
 
   Created for arduino-esp32 on 25 Dec, 2017
   by Elochukwu Ifediora (fedy0)
@@ -13,7 +18,7 @@ void setup() {
   // put your setup code here, to run once:
   Serial.begin(115200);
   Serial.println("\nTesting EEPROM Library\n");
-  if (!EEPROM.begin(1000)) {
+  if (!EEPROM.begin(0x1000)) {                      // Default Size = 4KB 
     Serial.println("Failed to initialise EEPROM");
     Serial.println("Restarting...");
     delay(1000);
@@ -22,7 +27,7 @@ void setup() {
 
   int address = 0;
 
-  EEPROM.writeByte(address, -128);                  // -2^7
+  EEPROM.writeByte(address, 128);                   // 2^7
   address += sizeof(byte);
 
   EEPROM.writeChar(address, 'A');                   // Same as writyByte and readByte
@@ -49,11 +54,11 @@ void setup() {
   EEPROM.writeULong(address, 4294967295);           // Same as writeUInt and readUInt
   address += sizeof(unsigned long);
 
-  int64_t value = -1223372036854775808LL;             // -2^63
+  int64_t value = -9223372036854775808;             // -2^63
   EEPROM.writeLong64(address, value);
   address += sizeof(int64_t);
 
-  uint64_t  Value = 18446744073709551615ULL;           // 2^64 - 1
+  uint64_t  Value = 18446744073709551615;           // 2^64 - 1
   EEPROM.writeULong64(address, Value);
   address += sizeof(uint64_t);
 
@@ -75,6 +80,7 @@ void setup() {
   address += 21;
 
   // See also the general purpose writeBytes() and readBytes() for BLOB in EEPROM library
+  
   EEPROM.commit();
   address = 0;
 
@@ -127,10 +133,9 @@ void setup() {
   address += sizeof(bool);
 
   Serial.println(EEPROM.readString(address));
-  address += sentence.length() + 1;
+  address += sentence.length() + 1;                 // To skip NULL termination in the string
 
   Serial.println(EEPROM.readString(address));
-  address += 21;
 }
 
 void loop() {

libraries/EEPROM/examples/eeprom_extra/partitions.csv

@@ -0,0 +1,7 @@
+#Name,   Type, SubType, Offset,   Size,    Flags
+nvs,     data, nvs,     0x9000,   0x5000,
+otadata, data, ota,     0xe000,   0x2000,
+app0,    app,  ota_0,   0x10000,  0x140000,
+app1,    app,  ota_1,   0x150000, 0x140000,
+eeprom,  data, 0x99,    0x290000, 0x1000,
+spiffs,  data, spiffs,  0x291000, 0x16F000,

libraries/EEPROM/examples/eeprom_write/partitions.csv

@@ -0,0 +1,7 @@
+#Name,   Type, SubType, Offset,   Size,    Flags
+nvs,     data, nvs,     0x9000,   0x5000,
+otadata, data, ota,     0xe000,   0x2000,
+app0,    app,  ota_0,   0x10000,  0x140000,
+app1,    app,  ota_1,   0x150000, 0x140000,
+eeprom,  data, 0x99,    0x290000, 0x1000,
+spiffs,  data, spiffs,  0x291000, 0x16F000,