Skip to content

Commit f633ad2

Browse files
porreyporrey
authored
Merge v2.0.1 changes (#11)
* Update EEPROM-Base.h * Updated Version * Update EEPROM-Base.h * Updated Changed return type to reference. Reformatted comments for Doxygen. * Updates comments * Update EEPROM-Base.h * Updated branch * Set Master branch * Update README.md * Update EEPROM-Cache.h * Update README.md * Update README.md * Update README.md * Update README.md * Update EEPROM-Vars.h * Update EEPROM-Display.h
1 parent 0b9f71b commit f633ad2

13 files changed

+415
-235
lines changed

‎.github/workflows/arduino-esp8266-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
concurrency:
99
group: "Arduino ESP8266 Build"
1010
cancel-in-progress: false
11-
11+
1212
jobs:
1313
build:
1414
runs-on: ubuntu-latest

‎.github/workflows/arduino-uno-r4-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
concurrency:
99
group: "Arduino UNO R4 WiFi Build"
1010
cancel-in-progress: false
11-
11+
1212
jobs:
1313
build:
1414
runs-on: ubuntu-latest

‎.github/workflows/particle-build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
concurrency:
99
group: "Particle-Build"
1010
cancel-in-progress: false
11-
11+
1212
jobs:
1313
compile:
1414
runs-on: ubuntu-latest
@@ -24,7 +24,7 @@ jobs:
2424
- name: Authenticate Particle CLI
2525
run: |
2626
particle login --token ${{ secrets.PARTICLE_ACCESS_TOKEN }}
27-
27+
2828
- name: Compile tests.ino firmware
2929
run: |
3030
particle compile photon examples/General/tests --saveTo firmware.bin || exit 1

‎README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
![Arduino Mega 2560 Build](https://github.com/porrey/EEPROM-Storage/actions/workflows/arduino-mega-2560-build.yml/badge.svg?branch=master)
2-
![Arduino Uno R4 Build](https://github.com/porrey/EEPROM-Storage/actions/workflows/arduino-uno-r4-build.yml/badge.svg?branch=master)
3-
![Arduino ESP8266 Build](https://github.com/porrey/EEPROM-Storage/actions/workflows/arduino-esp8266-build.yml/badge.svg?branch=master)
4-
![Particle Build](https://github.com/porrey/EEPROM-Storage/actions/workflows/particle-build.yml/badge.svg?branch=master)
5-
![GitHub release](https://img.shields.io/github/v/release/porrey/EEPROM-Storage?label=Latest%20Release)
1+
[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/porrey/EEPROM-Storage/.github/workflows/arduino-mega-2560-build.yml?style=for-the-badge&label=Arduino%20Mega%202560%20Build&logo=github)](https://github.com/porrey/EEPROM-Storage/actions/workflows/arduino-mega-2560-build.yml)
2+
[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/porrey/EEPROM-Storage/.github/workflows/arduino-uno-r4-build.yml?style=for-the-badge&label=Arduino%20Uno%20R4%20Build&logo=github)](https://github.com/porrey/EEPROM-Storage/actions/workflows/arduino-uno-r4-build.yml)
3+
[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/porrey/EEPROM-Storage/.github/workflows/arduino-esp8266-build.yml?style=for-the-badge&label=Arduino%20ESP8266%20Build&logo=github)](https://github.com/porrey/EEPROM-Storage/actions/workflows/arduino-esp8266-build.yml)
4+
[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/porrey/EEPROM-Storage/.github/workflows/particle-build.yml?style=for-the-badge&label=Particle%20Build&logo=github)](https://github.com/porrey/EEPROM-Storage/actions/workflows/particle-build.yml)
5+
[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/porrey/EEPROM-Storage/.github/workflows/arduino-lint.yml?style=for-the-badge&label=Arduino%20Lint&logo=github)](https://github.com/porrey/EEPROM-Storage/actions/workflows/arduino-lint.yml)
6+
7+
[![GitHub release](https://img.shields.io/github/v/release/porrey/EEPROM-Storage?style=for-the-badge&label=Latest%20Release&branch=master&logo=github)](https://github.com/porrey/EEPROM-Storage/releases/)
8+
![GitHub license](https://img.shields.io/github/license/porrey/EEPROM-Storage.svg?style=for-the-badge&logo=github)
9+
![GitHub issues](https://img.shields.io/github/issues/porrey/EEPROM-Storage.svg?style=for-the-badge&logo=github)
10+
[![Custom Badge](https://img.shields.io/badge/Library-Documentation-purple?style=for-the-badge&logo=github)](https://porrey.github.io/EEPROM-Storage)
611

712
# EEPROM-Storage Library
813
## Overview
@@ -11,9 +16,9 @@ The EEPROM Storage library provides the ability to access variables stored in EE
1116
Detailed library class and code documentation can be found here: https://porrey.github.io/EEPROM-Storage
1217

1318
## EEPROMStorage\<T\> vs EEPROMCache\<T\>
14-
There are two classes that provide the similar access to EEEPROM. The first is the Direct Storage class which reads and writes to directly to and from EEPROM. The second is the Cache Access whichs reads and writes from memory and writes to the EEPROM when directed.
19+
There are two classes that provide the similar access to EEEPROM. The first is the Direct Storage class which reads and writes to directly to and from EEPROM. The second is the Cache Access which reads and writes from memory and writes to the EEPROM when directed.
1520

16-
Other than the `restore()` and `commit()` (*see description below*) methods on the cache based class, these objects can be used interchangably.
21+
Other than the `restore()` and `commit()` (*see description below*) methods on the cache based class, these objects can be used interchangeably.
1722

1823
### Direct Storage (EEPROMStorage\<T\>)
1924
This class writes directly to the EEPROM whenever the variable value is updated and reads directly from EEPROM when the variable value is accessed.
@@ -152,6 +157,8 @@ The `EEPROMStorage` class also defines a `get()` method that can be used.
152157
int x = myInt.get();
153158

154159
## Platform/Boards Used in Testing
160+
The library was compile and loaded onto the boards listed below for testing.
161+
155162
1. Arduino on Mega 2560
156163
2. Arduino on ESP8266 [ESPino (ESP-12 Module)]
157164
3. Particle on Argon with OS version 6.2.1

‎library.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"type": "git",
1111
"url": "https://github.com/porrey/EEPROM-Storage.git"
1212
},
13-
"version": "2.0.0",
13+
"version": "2.0.1",
1414
"frameworks": "arduino",
1515
"platforms": "avr, renesas_uno, esp8266",
1616
"license": "LGPL-3",

‎library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=EEPROM-Storage
2-
version=2.0.0
2+
version=2.0.1
33
author=Daniel Porrey
44
license=LGPL-3
55
sentence=Generic class to wrap an EEPROM variable on the Particle and Arduino platforms.

0 commit comments

Comments
 (0)