Skip to content
This repository has been archived by the owner on Jan 29, 2023. It is now read-only.

khoih-prog/FlashStorage_SAMD

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits

.github

.github

 
 

Packages_Patches

Packages_Patches

 
 

examples

examples

 
 

platformio

platformio

 
 

src

src

 
 

utils

utils

 
 

.codespellrc

.codespellrc

 
 

.gitignore

.gitignore

 
 

CONTRIBUTING.md

CONTRIBUTING.md

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

changelog.md

changelog.md

 
 

keywords.txt

keywords.txt

 
 

library.json

library.json

 
 

library.properties

library.properties

 
 

Repository files navigation

FlashStorage_SAMD library for Arduino

arduino-library-badge GitHub release GitHub contributions welcome GitHub issues

Donate to my libraries using BuyMeACoffee

Table of Contents

Important Change from v1.3.0

Please have a look at HOWTO Fix Multiple Definitions Linker Error

Why do we need this FlashStorage_SAMD library

Features

The FlashStorage_SAMD library, based on and modified from Cristian Maglie's FlashStorage, provides a convenient way to store and retrieve user's data using emulated-EEPROM, from the non-volatile flash memory of SAMD21/SAMD51 boards.

The flash memory, generally used to store the firmware code, can also be used to store / retrieve more user's data and faster than from EEPROM. Thanks to the buffered data writing and reading, the flash access time is greatly reduced to increase the life of the flash.

Currently supported Boards

  • Arduino SAMD21 (ZERO, MKR, NANO_33_IOT, etc.).
  • Adafruit SAM21 (Itsy-Bitsy M0, Metro M0, Feather M0, Gemma M0, etc.).
  • Adafruit SAM51 (Itsy-Bitsy M4, Metro M4, Grand Central M4, Feather M4 Express, etc.).
  • Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)
  • Industruino DG21
  • Industruino 420MAKER
  • Sparkfun SAMD21 boards such as SparkFun_RedBoard_Turbo, SparkFun_Qwiic_Micro, etc.
  • Sparkfun SAMD51 boards such as SparkFun_SAMD51_Thing_Plus, SparkFun_SAMD51_MicroMod, etc.

Prerequisites

  1. Arduino IDE 1.8.19+ for Arduino. GitHub release
  2. Arduino SAMD core 1.8.13+ for SAMD ARM Cortex-M0+ boards. GitHub release
  3. Adafruit SAMD core 1.7.11+ for SAMD ARM Cortex-M0+ and M4 boards (Nano 33 IoT, etc.). GitHub release
  4. Seeeduino SAMD core 1.8.3+ for SAMD21/SAMD51 boards (XIAO M0, Wio Terminal, etc.). Latest release
  5. IndustruinoSAMD core 1.0.3+ for SAMD21 boards (Industruino DG21, etc.).
  6. IndustruinoSAML core 1.0.0+ for SAML21 boards (Industruino 420MAKER, etc.).
  7. Sparkfun SAMD core 1.8.4+ for SAMD21/SAMD51 boards (SparkFun_RedBoard_Turbo, SparkFun_SAMD51_Thing_Plus, etc.).

Installation

Use Arduino Library Manager

The best and easiest way is to use Arduino Library Manager. Search for FlashStorage_SAMD, then select / install the latest version.

Manual Install

Another way to install is to:

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

VS Code & PlatformIO

  1. Install VS Code
  2. Install PlatformIO
  3. Install FlashStorage_SAMD library by using Library Manager. Search for FlashStorage_SAMD 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

Packages' Patches

1. For Arduino SAMD boards

To be able to compile without error and automatically detect and display BOARD_NAME on Arduino SAMD (Nano-33-IoT, etc) boards, you have to copy the whole Arduino SAMD Packages_Patches directory into Arduino SAMD directory (~/.arduino15/packages/arduino/hardware/samd/1.8.13).

For core version v1.8.10+

Supposing the Arduino SAMD version is 1.8.13. Now only one file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/1.8.13/platform.txt

Whenever a new version is installed, remember to copy this files into the new version directory. For example, new version is x.yy.zz

This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.zz/platform.txt

For core version v1.8.9-

Supposing the Arduino SAMD version is 1.8.9. These files must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/1.8.9/platform.txt
  • ~/.arduino15/packages/arduino/hardware/samd/1.8.9/cores/arduino/Arduino.h

Whenever a new version is installed, remember to copy these files into the new version directory. For example, new version is x.yy.z

These files must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.z/platform.txt
  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.z/cores/arduino/Arduino.h

This is mandatory to fix the notorious Arduino SAMD compiler error. See Improve Arduino compatibility with the STL (min and max macro)

 ...\arm-none-eabi\include\c++\7.2.1\bits\stl_algobase.h:243:56: error: macro "min" passed 3 arguments, but takes just 2
     min(const _Tp& __a, const _Tp& __b, _Compare __comp)

Whenever the above-mentioned compiler error issue is fixed with the new Arduino SAMD release, you don't need to copy the Arduino.h file anymore.

2. For Adafruit SAMD boards

To be able to compile without error and automatically detect and display BOARD_NAME on Adafruit SAMD (Itsy-Bitsy M4, etc) boards, you have to copy the files in Adafruit SAMD Packages_Patches into Adafruit samd directory (~/.arduino15/packages/adafruit/hardware/samd/1.7.11).

Supposing the Adafruit SAMD core version is 1.7.11. This file must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.11/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.11/cores/arduino/Print.h
  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.11/cores/arduino/Print.cpp

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/cores/arduino/Print.h
  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/cores/arduino/Print.cpp

3. For Seeeduino SAMD boards

To be able to compile without error and automatically detect and display BOARD_NAME on Seeeduino SAMD (XIAO M0, Wio Terminal, etc) boards, you have to copy the files in Seeeduino SAMD Packages_Patches into Seeeduino samd directory (~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3).

Supposing the Seeeduino SAMD core version is 1.8.3. This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/platform.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/cores/arduino/Arduino.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/cores/arduino/Print.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/cores/arduino/Print.cpp

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/platform.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Arduino.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Print.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Print.cpp

4. For SparkFun SAMD boards

To be able to compile without error and automatically detect and display BOARD_NAME on SparkFun SAMD (XIAO SparkFun_RedBoard_Turbo, SparkFun_SAMD51_Thing_Plus, etc) boards, you have to copy the file SparkFun SAMD Packages_Patches into SparkFun samd directory (~/.arduino15/packages/SparkFun/hardware/samd/1.8.3).

Supposing the SparkFun SAMD core version is 1.8.3. This file must be copied into the directory:

  • ~/.arduino15/packages/SparkFun/hardware/samd/1.8.3/cores/arduino/Print.h
  • ~/.arduino15/packages/SparkFun/hardware/samd/1.8.3/cores/arduino/Print.cpp
  • ~/.arduino15/packages/SparkFun/hardware/samd/1.8.3/cores/arduino51/Print.h
  • ~/.arduino15/packages/SparkFun/hardware/samd/1.8.3/cores/arduino51/Print.cpp

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/SparkFun/hardware/samd/x.yy.zz/cores/arduino/Print.h
  • ~/.arduino15/packages/SparkFun/hardware/samd/x.yy.zz/cores/arduino/Print.cpp
  • ~/.arduino15/packages/SparkFun/hardware/samd/x.yy.zz/cores/arduino51/Print.h
  • ~/.arduino15/packages/SparkFun/hardware/samd/x.yy.zz/cores/arduino51/Print.cpp

HOWTO Fix Multiple Definitions Linker Error

The current library implementation, using xyz-Impl.h instead of standard xyz.cpp, possibly creates certain Multiple Definitions Linker error in certain use cases.

You can include this .hpp file

// Can be included as many times as necessary, without `Multiple Definitions` Linker Error
#include "FlashStorage_SAMD.hpp"     //https://github.com/khoih-prog/FlashStorage_SAMD

in many files. But be sure to use the following .h file in just 1 .h, .cpp or .ino file, which must not be included in any other file, to avoid Multiple Definitions Linker Error

// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include "FlashStorage_SAMD.h"           //https://github.com/khoih-prog/FlashStorage_SAMD

Check the new multiFileProject example for a HOWTO demo.

Have a look at the discussion in Different behaviour using the src_cpp or src_h lib #80

Limited number of writes

The flash memory has a limited amount of write cycles. Typical flash memories can perform about 10000 writes cycles to the same flash block before starting to "wear out" and begin to lose the ability to retain data.

So BEWARE: IMPROPER USE OF THIS LIBRARY CAN QUICKLY AND PERMANENTLY DESTROY THE FLASH MEMORY OF YOUR MICRO, in particular you should avoid to call the write() function too often and make sure that in the entire life of the micro the number of calls to write stay well below the above limit of 10000 (it's a good rule-of-thumb to keep that number in mind even if the manufacturer of the micro guarantees a bigger number of cycles).

The same caution must be taken if you're using the EEPROM API emulation (see below) with the EEPROM.commit() function.

Usage

Using FlashStorage objects directly

First of all you must declare a global FlashStorage object for each data you intend to store in the flash memory.

For example if you want to store the age of a person, you must declare an age_storage like this:

FlashStorage(age_storage, int);

this instruction means "create a FlashStorage to store an int variable and call it age_storage". Now you can use age_storage as a place to safely store an integer:

void readAndStoreUserAge() 
{
  Serial.println("Please enter your age:");
  String age = Serial.readStringUntil('\n');

  age_storage.write(age.toInt());  // <-- save the age
}

after a reset of the microcontroller to retrieve the stored age you can use:

int user_age = age_storage.read();

Using the alternative EEPROM-like API

Include FlashStorage_SAMD.h to get an EEPROM emulation with the internal flash memory.

See EmulateEEPROM sketch for an example.

The API is very similar to the well-known Arduino EEPROM library API, but with 4 additional functions:

  • bool isValid() returns true if data in the emulated-EEPROM is valid (the data written to flash at least once by EEPROM.commit() or EEPROM.put()). Otherwise emulated-EEPROM data is "undefined" and the function returns false.
  • void commit() store the EEPROM data in flash. Use this with care: Every call writes the complete emulated-EEPROM data to flash. This will reduce the remaining flash-write-cycles. Don't call this method in a loop or you will kill your flash soon.
  • void setCommitASAP(bool value = true) to set or clear the _commitASAP private variable (default is true to be safe). If _commitASAP is false, the call to EEPROM.put() won't force the EEPROM.commit() to extend the flash life. You'll have to remember to call EEPROM.commit() manually to save the emulated-EEPROM data into flash or data will be lost.
  • bool getCommitASAP() to return the current value of _commitASAP.

Examples

  1. EEPROM_Clear
  2. EEPROM_CRC
  3. EEPROM_get
  4. EEPROM_iteration
  5. EEPROM_put
  6. EEPROM_read
  7. EEPROM_update
  8. EEPROM_write
  9. EmulateEEPROM
  10. FlashStoreAndRetrieve
  11. StoreNameAndSurname
  12. multiFileProject New

Examples from other libraries

1. Library BlynkEthernet_WM

  1. AM2315_W5500
  2. DHT11_W5500
  3. ENC28J60_Blynk
  4. ENC28J60_Blynk_Email
  5. ENC28J60_WM_Config
  6. EthernetENC_Blynk_SAMD
  7. W5500_Blynk
  8. W5500_Blynk_Email
  9. W5500_WM_Config
  10. W5500_Blynk_Email_SAMD
  11. W5500_Blynk_SAMD
  12. W5500_WM_Config_SAMD

2. Library Blynk_Esp8266AT_WM

  1. SAMD_ESP8266Shield

3. Library Blynk_WiFiNINA_WM

  1. SAMD_WiFiNINA_WM

4. Library ESP_AT_WiFiManager

  1. AutoConnect
  2. AutoConnectWithFeedback
  3. ConfigOnStartup
  4. ConfigOnSwitch

5. Library ESP_AT_WM_Lite

  1. SAMD_ESP8266Shield

6. Library WiFiManager_NINA_Lite

  1. SAMD_WiFiNINA
  2. SAMD_WiFiNINA_MQTT

7. Library DoubleResetDetector_Generic

  1. minimal

8. Library MultiResetDetector_Generic

  1. minimal

Example StoreNameAndSurname

FlashStorage_SAMD/examples/StoreNameAndSurname/StoreNameAndSurname.ino

Lines 26 to 128 in 102e13e

// Demonstrate how to use FlashStorage_SAMD with an API that is similar to the EEPROM library to Store and retrieve structured data.
//#define EEPROM_EMULATION_SIZE (4 * 1024)
// Use 0-2. Larger for more debugging messages
#define FLASH_DEBUG 0
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include <FlashStorage_SAMD.h>
const int WRITTEN_SIGNATURE = 0xBEEFDEED;
// Create a structure that is big enough to contain a name
// and a surname. The "valid" variable is set to "true" once
// the structure is filled with actual data for the first time.
typedef struct
{
char name[100];
char surname[100];
} Person;
void setup()
{
Serial.begin(115200);
while (!Serial);
delay(200);
Serial.print(F("\nStart StoreNameAndSurname on "));
Serial.println(BOARD_NAME);
Serial.println(FLASH_STORAGE_SAMD_VERSION);
Serial.print("EEPROM length: ");
Serial.println(EEPROM.length());
// Check signature at address 0
int signature;
// Create a "Person" variable and call it "owner"
uint16_t storedAddress = 0;
Person owner;
EEPROM.get(storedAddress, signature);
// If the EEPROM is empty then no WRITTEN_SIGNATURE
if (signature == WRITTEN_SIGNATURE)
{
EEPROM.get(storedAddress + sizeof(signature), owner);
// Say hello to the returning user!
Serial.print("Hi ");
Serial.print(owner.name);
Serial.print(" ");
Serial.print(owner.surname);
Serial.println(", nice to see you again :-)");
Serial.println("Clearing WRITTEN_SIGNATURE for next try");
EEPROM.put(0, 0);
Serial.println("Done clearing signature in emulated EEPROM. You can reset now");
}
else
{
Serial.println("EEPROM is empty, writing WRITTEN_SIGNATURE and some example data:");
EEPROM.put(storedAddress, WRITTEN_SIGNATURE);
// ...in this case we ask for user data.
Serial.setTimeout(30000);
Serial.print("Insert your name : ");
String name = Serial.readStringUntil('\n');
Serial.println(name);
Serial.print("Insert your surname : ");
String surname = Serial.readStringUntil('\n');
Serial.println(surname);
// Fill the "owner" structure with the data entered by the user...
name.toCharArray(owner.name, 100);
surname.toCharArray(owner.surname, 100);
// ...and finally save everything into emulated-EEPROM
EEPROM.put(storedAddress + sizeof(signature), owner);
if (!EEPROM.getCommitASAP())
{
Serial.println("CommitASAP not set. Need commit()");
EEPROM.commit();
}
// Print a confirmation of the data inserted.
Serial.print("<< Your name: ");
Serial.print(owner.name);
Serial.print(". Your surname: ");
Serial.print(owner.surname);
Serial.println(" >> have been saved. Thank you!");
Serial.println("You can reset to check emulated-EEPROM data retention.");
}
}
void loop()
{
// Do nothing...
}

Debug Terminal Output Samples

1. W5500_Blynk on Adafruit SAMD51 ITSYBITSY_M4 using W5500 Ethernet shield

The following is the sample terminal output when running example W5500_Blynk on Adafruit SAMD51 ITSYBITSY_M4 using W5500 Ethernet shield

1.1. No Config Data with LOAD_DEFAULT_CONFIG_DATA = false => Config Portal don't loads default Credential

Start W5500_Blynk on ITSYBITSY_M4
[936] ChkCrR:CrCCSum=0xaf50,CrRCSum=0xffffffff
[936] CCSum=0x0,RCSum=0x0
[936] Invalid Stored Dynamic Data. Load default from Sketch
[937] SaveEEPROM,Sz=1024,DataSz=0,WCSum=0x1d4d
[944] CrCCSum=0x29a6
[944] MAC:FE-A8-80-C6-CE-A3
_pinCS = 0
W5100 init, using SS_PIN_DEFAULT = 10, new ss_pin = 10, W5100Class::ss_pin = 1
W5100::init: W5500, SSIZE =8192
[2632] IP:192.168.2.153
[2633] b:Stay in CfgPortal:No CfgDat
[2633] CfgIP=192.168.2.153
F
Your stored Credentials :
MQTT Server = default-mqtt-server
Port = 1883
MQTT UserName = default-mqtt-username
MQTT PWD = default-mqtt-password
Subs Topics = default-mqtt-SubTopic
Pubs Topics = default-mqtt-PubTopic
FFFFF
[339285] SaveEEPROM,Sz=1024,DataSz=0,WCSum=0x2e89
[339292] CrCCSum=0x219f

1.2. Input valid credentials with LOAD_DEFAULT_CONFIG_DATA = false. Click Save => reboot

Start W5500_Blynk on ITSYBITSY_M4
[1547] ChkCrR:CrCCSum=0x219f,CrRCSum=0x219f
[1547] CCSum=0x0,RCSum=0x0
[1548] CrCCSum=0x219f,CrRCSum=0x219f
[1548] ======= Start Stored Config Data =======
[1548] Hdr=W5X00,BName=Seeeduino_W5500_BlynkWM
[1548] Svr=account.duckdns.org,Tok=new_token1
[1549] Svr1=account.ddns.net,Tok1=new_token2
[1549] Prt=8080,SIP=192.168.2.220
[1549] connectEthernet: Use static_IP=192.168.2.220
[1549] MAC:FE-A1-D4-BC-E8-CB

W5100 init, using SS_PIN_DEFAULT = 10, new ss_pin = 10, W5100Class::ss_pin = 1
W5100::init: W5500, SSIZE =8192
[3131] IP:192.168.2.220
[3131] bg:ECon.TryB
[3131] 
    ___  __          __
   / _ )/ /_ _____  / /__
  / _  / / // / _ \/  '_/
 /____/_/\_, /_//_/_/\_\
        /___/ v0.6.1 on Arduino Zero

[3132] BlynkArduinoClient.connect: Connecting to account.duckdns.org:8080
[3244] Ready (ping: 6ms).
[3311] Connected to BlynkServer=account.duckdns.org,Token=new_token1
[3311] bg:EBCon
Conn2Blynk: server = account.duckdns.org, port = 8080
Token = new_token1, IP = 192.168.2.220
B
Your stored Credentials :
MQTT Server = new-mqtt-server
Port = 1883
MQTT UserName = new-mqtt-username
MQTT PWD = new-mqtt-password
Subs Topics = new-mqtt-SubTopic
Pubs Topics = new-mqtt-PubTopic
BBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB

2. StoreNameAndSurname on SAMD21 SEEED_XIAO_M0

2.1. No data => input then save

Start StoreNameAndSurname on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.2
EEPROM length: 1024
EEPROM is empty, writing WRITTEN_SIGNATURE and some example data:
Insert your name : John

Insert your surname : Doe

<< Your name: John. Your surname: Doe >> have been saved. Thank you!
You can reset to check emulated-EEPROM data retention.

2.2. Data retention after reset

Start StoreNameAndSurname on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.2
EEPROM length: 1024
Hi John Doe, nice to see you again :-)
Clearing WRITTEN_SIGNATURE for next try
Done clearing signature in emulated EEPROM. You can reset now

3. EEPROM_Clear on SAMD21 SEEED_XIAO_M0

3.1. 1ms to clear 1K bytes emulated-EEPROM

Start EEPROM_Clear on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.2

Emulated EEPROM length (bytes) = 1024

Done clearing emulated EEPROM. Time spent (ms) = 11

3.2. 22ms to clear 2K bytes emulated-EEPROM

Start EEPROM_Clear on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.2
Emulated EEPROM length (bytes) = 2048
Done clearing emulated EEPROM. Time spent (ms) = 22

3.3. 42ms to clear 4K bytes emulated-EEPROM

Start EEPROM_Clear on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.2
Emulated EEPROM length (bytes) = 4096
Done clearing emulated EEPROM. Time spent (ms) = 42

4. EEPROM_get on SAMD21 SEEED_XIAO_M0

4.1. No valid data, write signature and data

Start EEPROM_get on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.2
EEPROM length: 1024
EEPROM doesn't store valid data, writing WRITTEN_SIGNATURE and some example data
Float written to EEPROM: 123.456
Done writing custom object to EEPROM: 
===============
Field1: 3.14159
Field2: 65
Name: Working!
===============
Reset to see how you can retrieve the values by using EEPROM_get!

4.2. Valid signature and data, read data

Start EEPROM_get on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.2
EEPROM length: 1024
EEPROM has valid data with WRITTEN_SIGNATURE. Now read some example data
Read float from EEPROM: 123.456
Read custom object from EEPROM: 
===============
Field1: 3.14159
Field2: 65
Name: Working!
===============

FAQ

Can I use a single object to store more stuff?

Yes, you can declare a struct with more fields and call a EEPROM.put() to store the entire structure. See the StoreNameAndSurname for how to do it.

The content of the FlashStorage is erased each time a new sketch is uploaded?

Yes, every time you upload a new sketch, the previous content of the FlashStorage is erased.

Do you recommend to use FLASH instead of EEPROM?

No. If your board provides an integrated-EEPROM, it's advisable to use that because EEPROM has longer lifetime, number of write cycles, etc.).

In the absence of an integrated-EEPROM or its size is too small for your use-case, you can use this library to use a small portion flash memory as emulated-EEPROM, provided that you keep in mind the limits as in Limited number of writes

Troubleshooting

If you get compilation errors, more often than not, you may need to install a newer version of the core for Arduino boards.

Sometimes, the library will only work if you update the board core to the latest version because I am using newly added functions.

Issues

Submit issues to: FlashStorage_SAMD issues

TO DO

  1. Search for bug and improvement.
  2. Similar features for remaining Arduino boards

DONE

  1. Basic emulated-EEPROM for SAMD21/SAMD51.
  2. Add EEPROM.put() and EEPROM.get() functions to read/write the whole struct in emulated-EEPROM
  3. Similar features for STM32F/L/H/G/WB/MP1.
  4. Add Table of Contents
  5. Add support to Industruino SAMD21 DG21 and Industruino SAML21 420MAKER boards
  6. Add support to Sparkfun SAMD21 and SAMD51 boards
  7. Fix multiple-definitions linker error.
  8. Add support to many more boards, such as SAMD21E1xA, SAMD21G1xA andSAMD21J1xA
  9. Clean-up by reducing the number of library files
  10. Make compatible with old libraries and codes

Contributions and thanks

  1. Based on and modified from Cristian Maglie's FlashStorage. Most of the credits go to Cristian Maglie
cmaglie
⭐️⭐️ Cristian Maglie

Contributing

If you want to contribute to this project:

  • Report bugs and errors
  • Ask for enhancements
  • Create issues and pull requests
  • Tell other people about this library

License

  • The library is licensed under LGPLv3

About

The FlashStorage_SAMD library provides a convenient way to store and retrieve user's data using the non-volatile flash memory

Topics

data flash storage arduino-library eeprom samd samd21 samd51 seeeduino flash-storage seeeduino-xiao flashstorage-samd emulated-eeprom

Resources

Readme

License

GPL-3.0 license
Activity

Stars

30 stars

Watchers

5 watching

Forks

5 forks
Report repository

Releases 7

v1.3.2 to make compatible with old libraries and codes Latest
Jan 26, 2022
+ 6 releases

Packages

No packages published

Languages