https://github.com/mxv3a/cyclic-data-log
Log custom data in flash memory on ESP32, STM32, and BW16
https://github.com/mxv3a/cyclic-data-log
bw16 eeprom esp32 logger stm32
Last synced: 2 months ago
JSON representation
Log custom data in flash memory on ESP32, STM32, and BW16
- Host: GitHub
- URL: https://github.com/mxv3a/cyclic-data-log
- Owner: MXV3A
- License: mit
- Created: 2024-12-18T12:11:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-03T13:10:33.000Z (over 1 year ago)
- Last Synced: 2025-08-19T05:44:54.372Z (10 months ago)
- Topics: bw16, eeprom, esp32, logger, stm32
- Language: C++
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cyclic-Data-Log
Log custom data in persistent memory.
Used to log sensor data for diagnosing problems in case of a crash, or for saving settings while keeping past settings as fallback.
This Library is written for and tested on ESP32 (Espressif), STM32 (STMicroelectronics), and BW16 (AmebaD).
## Installation
Download or Clone this repository and pull the folder into the Arduino libraries folder or use the 'Add .ZIP Libraries' function in the ArduinoIDE.
## Using the Log
### 1 - Describe the data to be logged
```c
struct Entry{
int timestamp;
int sensor1;
int sensor2;
};
```
### 2 - Create a Log
```c
DataLog log;
```
### 3 - Add an Entry
```c
Entry newentry = {time(NULL), analogRead(GPIO_NUM_4), 25};
log.addEntry(&newentry);
```
The log adds the entry to the persistent memory and remembers all entries even after a reset. If the log is full the oldest entry will be overwritten.
### 4 - Read an Entry
```c
Entry readentry;
log.readEntry(-1, &readentry);
```
With 0 being the oldest entry, -1 the newest entry.
### 5 - Full Program
```c
#include
struct Entry{
int timestamp;
int sensor1;
int sensor2;
};
void setup(){
Serial.begin(115200);
pinMode(GPIO_NUM_4, INPUT);
DataLog log;
Entry readentry;
if(log.readEntry(-1, &readentry) != -1){
Serial.println("Logged Sensor Value: "+String(readentry.sensor1));
}
Entry newentry = {time(NULL), analogRead(GPIO_NUM_4), 25};
log.addEntry(&newentry);
delay(10000);
ESP.restart();
}
void loop(){}
```
(For other microcontrollers see examples)
## If EEPROM is also used by another Library
Go into DataLog.h and edit the following Macros
```c
//Change to Full Size of EEPROM in use
//If EEPROM range is used but not covered by this number it will be erased
#define EEPROM_MAX_SIZE 4096
//Change to start and end of where the data log should be.
//Memory outside this area is not touched by the library
#define LOG_START_ADDRESS 0
#define LOG_END_ADDRESS EEPROM_MAX_SIZE
```
### Example
For EEPROM memory with this intended layout:
Change Macros to these numbers:
```c
#define EEPROM_MAX_SIZE 1024
#define LOG_START_ADDRESS 256
#define LOG_END_ADDRESS 768
```