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

Commit

Permalink
v1.3.1 to clean-up
Browse files Browse the repository at this point in the history
### Releases v1.3.1

1. Clean-up by reducing the number of library files
  • Loading branch information
khoih-prog committed Jan 25, 2022
1 parent e6d9272 commit cb32e93
Show file tree
Hide file tree
Showing 11 changed files with 262 additions and 32 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ BBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB BBBBBBBBBB

```
Start StoreNameAndSurname on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.0
FlashStorage_SAMD v1.3.1
EEPROM length: 1024
EEPROM is empty, writing WRITTEN_SIGNATURE and some example data:
Insert your name : John
Expand All @@ -589,7 +589,7 @@ You can reset to check emulated-EEPROM data retention.

```
Start StoreNameAndSurname on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.0
FlashStorage_SAMD v1.3.1
EEPROM length: 1024
Hi John Doe, nice to see you again :-)
Clearing WRITTEN_SIGNATURE for next try
Expand All @@ -604,7 +604,7 @@ Done clearing signature in emulated EEPROM. You can reset now

```
Start EEPROM_Clear on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.0
FlashStorage_SAMD v1.3.1
Emulated EEPROM length (bytes) = 1024
Expand All @@ -616,7 +616,7 @@ Done clearing emulated EEPROM. Time spent (ms) = 11

```
Start EEPROM_Clear on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.0
FlashStorage_SAMD v1.3.1
Emulated EEPROM length (bytes) = 2048
Done clearing emulated EEPROM. Time spent (ms) = 22
```
Expand All @@ -625,7 +625,7 @@ Done clearing emulated EEPROM. Time spent (ms) = 22

```
Start EEPROM_Clear on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.0
FlashStorage_SAMD v1.3.1
Emulated EEPROM length (bytes) = 4096
Done clearing emulated EEPROM. Time spent (ms) = 42
```
Expand All @@ -638,7 +638,7 @@ Done clearing emulated EEPROM. Time spent (ms) = 42

```
Start EEPROM_get on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.0
FlashStorage_SAMD v1.3.1
EEPROM length: 1024
EEPROM doesn't store valid data, writing WRITTEN_SIGNATURE and some example data
Float written to EEPROM: 123.456
Expand All @@ -655,7 +655,7 @@ Reset to see how you can retrieve the values by using EEPROM_get!

```
Start EEPROM_get on SEEED_XIAO_M0
FlashStorage_SAMD v1.3.0
FlashStorage_SAMD v1.3.1
EEPROM length: 1024
EEPROM has valid data with WRITTEN_SIGNATURE. Now read some example data
Read float from EEPROM: 123.456
Expand Down Expand Up @@ -722,6 +722,8 @@ Submit issues to: [FlashStorage_SAMD issues](https://github.com/khoih-prog/Flash
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` and`SAMD21J1xA`
9. Clean-up by reducing the number of library files


---
---
Expand Down
6 changes: 6 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
## Table of Contents

* [Changelog](#changelog)
* [Releases v1.3.1](#releases-v131)
* [Releases v1.3.0](#releases-v130)
* [Releases v1.2.1](#releases-v121)
* [Releases v1.2.0](#releases-v120)
Expand All @@ -24,6 +25,11 @@

## Changelog

### Releases v1.3.1

1. Clean-up by reducing the number of library files


### Releases v1.3.0

1. Fix `multiple-definitions` linker error.
Expand Down
4 changes: 2 additions & 2 deletions examples/multiFileProject/multiFileProject.ino
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
#error This code is designed to run on SAMD21/SAMD51 platform! Please check your Tools->Board setting.
#endif

#define FLASH_STORAGE_SAMD_VERSION_MIN_TARGET "FlashStorage_SAMD v1.3.0"
#define FLASH_STORAGE_SAMD_VERSION_MIN 1003000
#define FLASH_STORAGE_SAMD_VERSION_MIN_TARGET "FlashStorage_SAMD v1.3.1"
#define FLASH_STORAGE_SAMD_VERSION_MIN 1003001

#include "multiFileProject.h"

Expand Down
6 changes: 6 additions & 0 deletions keywords.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,10 @@ getCommitASAP KEYWORD2

# LITERAL1

FLASH_STORAGE_SAMD_VERSION LITERAL1
FLASH_STORAGE_SAMD_VERSION_MAJOR LITERAL1
FLASH_STORAGE_SAMD_VERSION_MINOR LITERAL1
FLASH_STORAGE_SAMD_VERSION_PATCH LITERAL1
FLASH_STORAGE_SAMD_VERSION_INT LITERAL1

EEPROM_EMULATION_SIZE LITERAL1
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "FlashStorage_SAMD",
"version": "1.3.0",
"version": "1.3.1",
"keywords": "storage,data,flash,flashstorage,flash-storage,eeprom,emulated-eeprom",
"description": "The FlashStorage library aims to provide a convenient way to store and retrieve user's data using the non-volatile flash memory of SAMD21/SAMD51. It's using the buffered read and write to minimize the access to Flash. It now supports writing and reading the whole object, not just byte-and-byte.",
"authors": [
Expand Down
4 changes: 2 additions & 2 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name=FlashStorage_SAMD
version=1.3.0
version=1.3.1
author=Cristian Maglie <c.maglie@bug.st>, Khoi Hoang <khoih.prog@gmail.com>
maintainer=Khoi Hoang <khoih.prog@gmail.com>
license=MIT
icense=GPLv3
sentence=The FlashStorage library aims to provide a convenient way to store and retrieve user's data using the non-volatile flash memory of SAMD21/SAMD51. It's using the buffered read and write to minimize the access to Flash. It now supports writing and reading the whole object, not just byte-and-byte.
paragraph=Useful if the EEPROM is not available or too small. Currently, ATSAMD21 and ATSAMD51 are supported (and consequently every board based on this cpu like the Arduino Zero, Aduino MKR1000, Nano-33 IoT, Itsy-Bitsy M4, etc).
url=https://github.com/khoih-prog/FlashStorage_SAMD
Expand Down
7 changes: 3 additions & 4 deletions src/FlashStorage_SAMD.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@
You should have received a copy of the GNU Lesser General Public License along with this library.
If not, see (https://www.gnu.org/licenses/)
Version: 1.3.0
Version: 1.3.1
Version Modified By Date Comments
------- ----------- ---------- -----------
1.0.0 K Hoang 28/03/2020 Initial coding to add support to SAMD51 besides SAMD21
1.1.0 K Hoang 26/01/2021 Add supports to put() and get() for writing and reading the whole object. Fix bug.
1.2.0 K Hoang 18/08/2021 Optimize code. Add debug option
1.2.1 K Hoang 10/10/2021 Update `platform.ini` and `library.json`
1.3.0 K Hoang 10/10/2021 Fix `multiple-definitions` linker error. Add support to many more boards.
1.3.0 K Hoang 25/01/2022 Fix `multiple-definitions` linker error. Add support to many more boards.
1.3.1 K Hoang 25/01/2022 Reduce number of library files
******************************************************************************************************************************************/

// The .hpp contains only definitions, and can be included as many times as necessary, without `Multiple Definitions` Linker Error
Expand All @@ -41,8 +42,6 @@
#ifndef FlashStorage_SAMD_h
#define FlashStorage_SAMD_h

#include <FlashAsEEPROM_SAMD.h>

#include <FlashStorage_SAMD.hpp>
#include <FlashStorage_SAMD_Impl.h>

Expand Down
Loading

0 comments on commit cb32e93

Please sign in to comment.