Full repo version bump to v2.0.0

Merge pull request 'Fix Save/Load State' (#28 ) from fix-save-state into main
Reviewed-on: #28
2025-08-17 11:04:25 -07:00 · 2025-08-17 17:18:56 +00:00 · 2025-08-16 11:00:31 -07:00 · 2025-08-16 10:58:42 -07:00 · 2025-08-16 10:47:06 -07:00 · 2025-08-16 10:06:11 -07:00
16 changed files with 60 additions and 46 deletions
--- a/firmware/Gravity/Gravity.ino
+++ b/firmware/Gravity/Gravity.ino
@ -2,7 +2,7 @@
 * @file Gravity.ino
 * @author Adam Wonak (https://github.com/awonak/)
 * @brief Alt firmware version of Gravity by Sitka Instruments.
- * @version v2.0.0 - June 2025 awonak - Full rewrite
+ * @version v2.0.0 - August 2025 awonak - Full rewrite
 * @version v1.0 - August 2023 Oleksiy H - Initial release
 * @date 2025-07-04
 *
@ -227,8 +227,16 @@ void HandleEncoderPressed() {
                case PARAM_MAIN_LOAD_DATA:
                    if (app.selected_sub_param < StateManager::MAX_SAVE_SLOTS) {
                        app.selected_save_slot = app.selected_sub_param;
+                        // Load pattern data into app state.
                        stateManager.loadData(app, app.selected_save_slot);
-                        InitGravity(app);
+                        // Load global performance settings if they have changed.
+                        if (gravity.clock.Tempo() != app.tempo) {
+                            gravity.clock.SetTempo(app.tempo);
+                        }
+                        // Load global settings only clock is not active.
+                        if (gravity.clock.IsPaused()) {
+                            InitGravity(app);
+                        }
                    }
                    break;
                case PARAM_MAIN_FACTORY_RESET:
--- a/firmware/Gravity/app_state.h
+++ b/firmware/Gravity/app_state.h
@ -2,8 +2,8 @@
 * @file app_state.h
 * @author Adam Wonak (https://github.com/awonak/)
 * @brief Alt firmware version of Gravity by Sitka Instruments.
- * @version 2.0.1
- * @date 2025-07-04
+ * @version 2.0.0
+ * @date 2025-08-17
 *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/firmware/Gravity/channel.h
+++ b/firmware/Gravity/channel.h
@ -2,8 +2,8 @@
 * @file channel.h
 * @author Adam Wonak (https://github.com/awonak/)
 * @brief Alt firmware version of Gravity by Sitka Instruments.
- * @version 2.0.1
- * @date 2025-07-04
+ * @version 2.0.0
+ * @date 2025-08-17
 *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/firmware/Gravity/display.h
+++ b/firmware/Gravity/display.h
@ -2,8 +2,8 @@
 * @file display.h
 * @author Adam Wonak (https://github.com/awonak/)
 * @brief Alt firmware version of Gravity by Sitka Instruments.
- * @version 2.0.1
- * @date 2025-07-04
+ * @version 2.0.0
+ * @date 2025-08-17
 *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/firmware/Gravity/euclidean.h
+++ b/firmware/Gravity/euclidean.h
@ -2,8 +2,8 @@
 * @file euclidean.h
 * @author Adam Wonak (https://github.com/awonak/)
 * @brief Alt firmware version of Gravity by Sitka Instruments.
- * @version 2.0.1
- * @date 2025-07-04
+ * @version 2.0.0
+ * @date 2025-08-17
 *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/firmware/Gravity/save_state.cpp
+++ b/firmware/Gravity/save_state.cpp
@ -2,8 +2,8 @@
 * @file save_state.cpp
 * @author Adam Wonak (https://github.com/awonak/)
 * @brief Alt firmware version of Gravity by Sitka Instruments.
- * @version 2.0.1
- * @date 2025-07-04
+ * @version 2.0.0
+ * @date 2025-08-17
 *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
@ -33,54 +33,66 @@ const int StateManager::EEPROM_DATA_START_ADDR = sizeof(StateManager::Metadata);
 StateManager::StateManager() : _isDirty(false), _lastChangeTime(0) {}

 bool StateManager::initialize(AppState& app) {
+    noInterrupts();
+    bool success = false;
    if (_isDataValid()) {
        // Load global settings.
        _loadMetadata(app);
        // Load app data from the transient slot.
        _loadState(app, TRANSIENT_SLOT);
-        return true;
+        success = true;
    }
    // EEPROM does not contain save data for this firmware & version.
    else {
        // Erase EEPROM and initialize state. Save default pattern to all save slots.
        factoryReset(app);
-        return false;
    }
+    interrupts();
+    return success;
 }

 bool StateManager::loadData(AppState& app, byte slot_index) {
    // Check if slot_index is within max range + 1 for transient.
    if (slot_index >= MAX_SAVE_SLOTS + 1) return false;

+    noInterrupts();
+
    // Load the state data from the specified EEPROM slot and update the app state save slot.
    _loadState(app, slot_index);
    app.selected_save_slot = slot_index;
-    // Persist this change in the global metadata.
-    _saveMetadata(app);
+    // Persist this change in the global metadata on next update.
+    _isDirty = true;

+    interrupts();
    return true;
 }

 // Save app state to user specified save slot.
 void StateManager::saveData(const AppState& app) {
+    noInterrupts();
    // Check if slot_index is within max range + 1 for transient.
    if (app.selected_save_slot >= MAX_SAVE_SLOTS + 1) return;

    _saveState(app, app.selected_save_slot);
    _saveMetadata(app);
    _isDirty = false;
+    interrupts();
 }

 // Save transient state if it has changed and enough time has passed since last save.
 void StateManager::update(const AppState& app) {
    if (_isDirty && (millis() - _lastChangeTime > SAVE_DELAY_MS)) {
+        noInterrupts();
        _saveState(app, TRANSIENT_SLOT);
        _saveMetadata(app);
        _isDirty = false;
+        interrupts();
    }
 }

 void StateManager::reset(AppState& app) {
+    noInterrupts();
+
    AppState default_app;
    app.tempo = default_app.tempo;
    app.selected_param = default_app.selected_param;
@ -98,6 +110,7 @@ void StateManager::reset(AppState& app) {
    _loadMetadata(app);

    _isDirty = false;
+    interrupts();
 }

 void StateManager::markDirty() {
@ -134,7 +147,6 @@ void StateManager::_saveState(const AppState& app, byte slot_index) {
    // Check if slot_index is within max range + 1 for transient.
    if (app.selected_save_slot >= MAX_SAVE_SLOTS + 1) return;

-    noInterrupts();
    static EepromData save_data;

    save_data.tempo = app.tempo;
@ -165,14 +177,12 @@ void StateManager::_saveState(const AppState& app, byte slot_index) {

    int address = EEPROM_DATA_START_ADDR + (slot_index * sizeof(EepromData));
    EEPROM.put(address, save_data);
-    interrupts();
 }

 void StateManager::_loadState(AppState& app, byte slot_index) {
    // Check if slot_index is within max range + 1 for transient.
    if (slot_index >= MAX_SAVE_SLOTS + 1) return;

-    noInterrupts();
    static EepromData load_data;
    int address = EEPROM_DATA_START_ADDR + (slot_index * sizeof(EepromData));
    EEPROM.get(address, load_data);
@ -200,11 +210,9 @@ void StateManager::_loadState(AppState& app, byte slot_index) {
        ch.setCv1Dest(static_cast<CvDestination>(saved_ch_state.cv1_dest));
        ch.setCv2Dest(static_cast<CvDestination>(saved_ch_state.cv2_dest));
    }
-    interrupts();
 }

 void StateManager::_saveMetadata(const AppState& app) {
-    noInterrupts();
    Metadata current_meta;
    strcpy(current_meta.sketch_name, SKETCH_NAME);
    strcpy(current_meta.version, SEMANTIC_VERSION);
@ -215,14 +223,12 @@ void StateManager::_saveMetadata(const AppState& app) {
    current_meta.rotate_display = app.rotate_display;

    EEPROM.put(METADATA_START_ADDR, current_meta);
-    interrupts();
 }

 void StateManager::_loadMetadata(AppState& app) {
-    noInterrupts();
    Metadata metadata;
    EEPROM.get(METADATA_START_ADDR, metadata);
    app.selected_save_slot = metadata.selected_save_slot;
    app.encoder_reversed = metadata.encoder_reversed;
-    interrupts();
+    app.rotate_display = metadata.rotate_display;
 }
--- a/firmware/Gravity/save_state.h
+++ b/firmware/Gravity/save_state.h
@ -2,8 +2,8 @@
 * @file save_state.h
 * @author Adam Wonak (https://github.com/awonak/)
 * @brief Alt firmware version of Gravity by Sitka Instruments.
- * @version 2.0.1
- * @date 2025-07-04
+ * @version 2.0.0
+ * @date 2025-08-17
 *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
@ -52,8 +52,8 @@ class StateManager {

    // This struct holds the data that identifies the firmware version.
    struct Metadata {
-        char sketch_name[12];
-        char version[5];
+        char sketch_name[16];
+        char version[16];
        // Additional global/hardware settings
        byte selected_save_slot;
        bool encoder_reversed;
--- a/library.properties
+++ b/library.properties
@ -1,5 +1,5 @@
 name=libGravity
-version=2.0.0
+version=2.0.1
 author=Adam Wonak
 maintainer=awonak <github.com/awonak>
 sentence=Hardware abstraction library for Sitka Instruments Gravity eurorack module
@ -7,4 +7,4 @@ category=Other
 license=MIT
 url=https://github.com/awonak/libGravity
 architectures=avr
-depends=uClock,RotaryEncoder,U8g2
+depends=uClock,RotaryEncoder,U8g2,NeoHWSerial
--- a/src/analog_input.h
+++ b/src/analog_input.h
@ -2,8 +2,8 @@
 * @file analog_input.h
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Class for interacting with analog inputs.
- * @version 0.1
- * @date 2025-05-23
+ * @version 2.0.0
+ * @date 2025-08-17
 *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/src/button.h
+++ b/src/button.h
@ -2,8 +2,8 @@
 * @file button.h
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Wrapper class for interacting with trigger / gate inputs.
- * @version 0.1
- * @date 2025-04-20
+ * @version 2.0.0
+ * @date 2025-08-17
  *
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/src/clock.h
+++ b/src/clock.h
@ -2,8 +2,8 @@
 * @file clock.h
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Wrapper Class for clock timing functions.
- * @version 0.1
- * @date 2025-05-04
+ * @version 2.0.0
+ * @date 2025-08-17
 * 
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/src/digital_output.h
+++ b/src/digital_output.h
@ -2,8 +2,8 @@
 * @file digital_output.h
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Class for interacting with trigger / gate outputs.
- * @version 0.1
- * @date 2025-04-17
+ * @version 2.0.0
+ * @date 2025-08-17
 * 
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/src/encoder.h
+++ b/src/encoder.h
@ -2,8 +2,8 @@
 * @file encoder_dir.h
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Class for interacting with encoders.
- * @version 0.1
- * @date 2025-04-19
+ * @version 2.0.0
+ * @date 2025-08-17
 * 
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/src/libGravity.cpp
+++ b/src/libGravity.cpp
@ -2,8 +2,8 @@
 * @file libGravity.cpp
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Library for building custom scripts for the Sitka Instruments Gravity module.
- * @version 0.1
- * @date 2025-04-19
+ * @version 2.0.0
+ * @date 2025-08-17
 * 
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/src/libGravity.h
+++ b/src/libGravity.h
@ -2,8 +2,8 @@
 * @file libGravity.h
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Library for building custom scripts for the Sitka Instruments Gravity module.
- * @version 0.1
- * @date 2025-04-19
+ * @version 2.0.0
+ * @date 2025-08-17
 * 
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
--- a/src/peripherials.h
+++ b/src/peripherials.h
@ -2,8 +2,8 @@
 * @file peripherials.h
 * @author Adam Wonak (https://github.com/awonak)
 * @brief Arduino pin definitions for the Sitka Instruments Gravity module.
- * @version 0.1
- * @date 2025-04-19
+ * @version 2.0.0
+ * @date 2025-08-17
 * 
 * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com
 *
Author	SHA1	Message	Date
Adam Wonak	acd028846c	Full repo version bump to v2.0.0	2025-08-17 11:04:25 -07:00
awonak	ed625e75fc	Merge pull request 'Fix Save/Load State' (#28 ) from fix-save-state into main Reviewed-on: #28	2025-08-17 17:18:56 +00:00
Adam Wonak	b60dcc0e68	one more	2025-08-16 11:00:31 -07:00
Adam Wonak	909d589609	make version consistent	2025-08-16 10:58:42 -07:00
Adam Wonak	330f5e6ceb	improve docstring comments	2025-08-16 10:47:06 -07:00
Adam Wonak	87dacd869b	improve the usage of disabling interrupts to avoid a potential race condition with isr being called between private method execution.	2025-08-16 10:06:11 -07:00
Adam Wonak	64f467d6ac	Add missing metadata field in _loadMetadata	2025-08-16 09:55:43 -07:00
Adam Wonak	84cafe2387	Fix bug in metadata save/load state. The sketch_name char array was to short, causing a buffer overflow.	2025-08-16 09:51:05 -07:00