awonak/libGravity
1
1
Fork 0
Code Issues Pull Requests Packages Releases 2 Activity

code cleanup for consistency

Browse Source
This commit is contained in:
Adam Wonak
2025-06-17 07:27:22 -07:00
parent 6c75a85929
commit 966f5b767b
2 changed files with 26 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
examples/Gravity/save_state.cpp
View File

@ -7,7 +7,7 @@
StateManager::StateManager() : _isDirty(false), _lastChangeTime(0) {} StateManager::StateManager() : _isDirty(false), _lastChangeTime(0) {}
bool StateManager::initialize(AppState& app) { bool StateManager::initialize(AppState& app) {
if (isDataValid()) { if (_isDataValid()) {
static EepromData load_data; static EepromData load_data;
EEPROM.get(sizeof(Metadata), load_data); EEPROM.get(sizeof(Metadata), load_data);
@ -38,10 +38,10 @@ bool StateManager::initialize(AppState& app) {
} }
} }
void StateManager::save(const AppState& app) { void StateManager::_save(const AppState& app) {
// Ensure interrupts do not cause corrupt data writes. // Ensure interrupts do not cause corrupt data writes.
noInterrupts(); noInterrupts();
_save_worker(app); _saveState(app);
interrupts(); interrupts();
} }
@ -57,8 +57,8 @@ void StateManager::reset(AppState& app) {
} }
noInterrupts(); noInterrupts();
_metadata_worker(); // Write the new metadata _saveMetadata(); // Write the new metadata
_save_worker(app); // Write the new (default) app state _saveState(app); // Write the new (default) app state
interrupts(); interrupts();
_isDirty = false; _isDirty = false;
@ -67,7 +67,7 @@ void StateManager::reset(AppState& app) {
void StateManager::update(const AppState& app) { void StateManager::update(const AppState& app) {
// Check if a save is pending and if enough time has passed. // Check if a save is pending and if enough time has passed.
if (_isDirty && (millis() - _lastChangeTime > SAVE_DELAY_MS)) { if (_isDirty && (millis() - _lastChangeTime > SAVE_DELAY_MS)) {
save(app); _save(app);
_isDirty = false; // Clear the flag, we are now "clean". _isDirty = false; // Clear the flag, we are now "clean".
} }
} }
@ -77,15 +77,15 @@ void StateManager::markDirty() {
_lastChangeTime = millis(); _lastChangeTime = millis();
} }
bool StateManager::isDataValid() { bool StateManager::_isDataValid() {
Metadata load_meta; Metadata load_meta;
EEPROM.get(0, load_meta); EEPROM.get(0, load_meta);
bool nameMatch = (strcmp(load_meta.sketchName, CURRENT_SKETCH_NAME) == 0); bool name_match = (strcmp(load_meta.sketch_name, SKETCH_NAME) == 0);
bool versionMatch = (load_meta.version == CURRENT_SKETCH_VERSION); bool version_match = (load_meta.version == SKETCH_VERSION);
return nameMatch && versionMatch; return name_match && version_match;
} }
void StateManager::_save_worker(const AppState& app) { void StateManager::_saveState(const AppState& app) {
static EepromData save_data; static EepromData save_data;
// Populate main app state // Populate main app state
@ -111,9 +111,9 @@ void StateManager::_save_worker(const AppState& app) {
EEPROM.put(sizeof(Metadata), save_data); EEPROM.put(sizeof(Metadata), save_data);
} }
void StateManager::_metadata_worker() { void StateManager::_saveMetadata() {
Metadata currentMeta; Metadata current_meta;
strcpy(currentMeta.sketchName, CURRENT_SKETCH_NAME); strcpy(current_meta.sketch_name, SKETCH_NAME);
currentMeta.version = CURRENT_SKETCH_VERSION; current_meta.version = SKETCH_VERSION;
EEPROM.put(0, currentMeta); EEPROM.put(0, current_meta);
} }

19
examples/Gravity/save_state.h
View File

@ -8,8 +8,11 @@
struct AppState; struct AppState;
// Define the constants for the current firmware. // Define the constants for the current firmware.
const char CURRENT_SKETCH_NAME[] = "Gravity"; const char SKETCH_NAME[] = "Gravity";
const byte CURRENT_SKETCH_VERSION = 3; const byte SKETCH_VERSION = 3;
// Define the minimum amount of time between EEPROM writes.
static const unsigned long SAVE_DELAY_MS = 2000;
/** /**
* @brief Manages saving and loading of the application state to and from EEPROM. * @brief Manages saving and loading of the application state to and from EEPROM.
@ -30,7 +33,7 @@ class StateManager {
private: private:
// This struct holds the data that identifies the firmware version. // This struct holds the data that identifies the firmware version.
struct Metadata { struct Metadata {
char sketchName[16]; char sketch_name[16];
byte version; byte version;
}; };
struct ChannelState { struct ChannelState {
@ -51,15 +54,13 @@ class StateManager {
ChannelState channel_data[Gravity::OUTPUT_COUNT]; ChannelState channel_data[Gravity::OUTPUT_COUNT];
}; };
void save(const AppState& app); void _save(const AppState& app);
bool _isDataValid();
bool isDataValid(); void _saveState(const AppState& app);
void _save_worker(const AppState& app); void _saveMetadata();
void _metadata_worker();
bool _isDirty; bool _isDirty;
unsigned long _lastChangeTime; unsigned long _lastChangeTime;
static const unsigned long SAVE_DELAY_MS = 2000;
}; };
#endif // SAVE_STATE_H #endif // SAVE_STATE_H