reduce flash mem usage by moving common text to a const.

2025-08-09 18:35:37 -07:00
8 changed files with 100 additions and 74 deletions
--- a/firmware/Gravity/Gravity.ino
+++ b/firmware/Gravity/Gravity.ino
@ -66,6 +66,10 @@ void setup() {
    // Start Gravity.
    gravity.Init();

+    // Show bootsplash when initializing firmware.
+    Bootsplash();
+    delay(2000);
+
    // Initialize the state manager. This will load settings from EEPROM
    stateManager.initialize(app);
    InitGravity(app);
@ -209,34 +213,31 @@ void HandleEncoderPressed() {
    // Check if leaving editing mode should apply a selection.
    if (app.editing_param) {
        if (app.selected_channel == 0) {  // main page
-            switch (app.selected_param) {
-                case PARAM_MAIN_ENCODER_DIR:
-                    app.encoder_reversed = app.selected_sub_param == 1;
-                    gravity.encoder.SetReverseDirection(app.encoder_reversed);
-                    break;
-                case PARAM_MAIN_ROTATE_DISP:
-                    app.rotate_display = app.selected_sub_param == 1;
-                    gravity.display.setFlipMode(app.rotate_display ? 1 : 0);
-                    break;
-                case PARAM_MAIN_SAVE_DATA:
-                    if (app.selected_sub_param < StateManager::MAX_SAVE_SLOTS) {
-                        app.selected_save_slot = app.selected_sub_param;
-                        stateManager.saveData(app);
-                    }
-                    break;
-                case PARAM_MAIN_LOAD_DATA:
-                    if (app.selected_sub_param < StateManager::MAX_SAVE_SLOTS) {
-                        app.selected_save_slot = app.selected_sub_param;
-                        stateManager.loadData(app, app.selected_save_slot);
-                        InitGravity(app);
-                    }
-                    break;
-                case PARAM_MAIN_FACTORY_RESET:
-                    if (app.selected_sub_param == 0) {  // Erase
-                        stateManager.factoryReset(app);
-                        InitGravity(app);
-                    }
-                    break;
+            // TODO: rewrite as switch
+            if (app.selected_param == PARAM_MAIN_ENCODER_DIR) {
+                app.encoder_reversed = app.selected_sub_param == 1;
+                gravity.encoder.SetReverseDirection(app.encoder_reversed);
+            }
+            if (app.selected_param == PARAM_MAIN_SAVE_DATA) {
+                if (app.selected_sub_param < StateManager::MAX_SAVE_SLOTS) {
+                    app.selected_save_slot = app.selected_sub_param;
+                    stateManager.saveData(app);
+                }
+            }
+            if (app.selected_param == PARAM_MAIN_LOAD_DATA) {
+                if (app.selected_sub_param < StateManager::MAX_SAVE_SLOTS) {
+                    app.selected_save_slot = app.selected_sub_param;
+                    stateManager.loadData(app, app.selected_save_slot);
+                    InitGravity(app);
+                }
+            }
+            if (app.selected_param == PARAM_MAIN_FACTORY_RESET) {
+                if (app.selected_sub_param == 0) {  // Erase
+                    // Show bootsplash during slow erase operation.
+                    Bootsplash();
+                    stateManager.factoryReset(app);
+                    InitGravity(app);
+                }
            }
        }
        // Only mark dirty and reset selected_sub_param when leaving editing mode.
@ -312,7 +313,6 @@ void editMainParameter(int val) {
        }
        // These changes are applied upon encoder button press.
        case PARAM_MAIN_ENCODER_DIR:
-        case PARAM_MAIN_ROTATE_DISP:
            updateSelection(app.selected_sub_param, val, 2);
            break;
        case PARAM_MAIN_SAVE_DATA:
@ -381,7 +381,6 @@ void InitGravity(AppState& app) {
    gravity.clock.SetTempo(app.tempo);
    gravity.clock.SetSource(app.selected_source);
    gravity.encoder.SetReverseDirection(app.encoder_reversed);
-    gravity.display.setFlipMode(app.rotate_display ? 1 : 0);
 }

 void ResetOutputs() {
--- a/firmware/Gravity/app_state.h
+++ b/firmware/Gravity/app_state.h
@ -31,7 +31,6 @@ struct AppState {
    Clock::Pulse selected_pulse = Clock::PULSE_PPQN_24;
    bool editing_param = false;
    bool encoder_reversed = false;
-    bool rotate_display = false;
    bool refresh_screen = true;
 };

--- a/firmware/Gravity/channel.h
+++ b/firmware/Gravity/channel.h
@ -86,7 +86,6 @@ class Channel {

    void setClockMod(int index) {
        base_clock_mod_index = constrain(index, 0, MOD_CHOICE_SIZE - 1);
-        _recalculatePulses();
    }

    void setProbability(int prob) {
@ -95,16 +94,13 @@ class Channel {

    void setDutyCycle(int duty) {
        base_duty_cycle = constrain(duty, 1, 99);
-        _recalculatePulses();
    }

    void setOffset(int off) {
        base_offset = constrain(off, 0, 99);
-        _recalculatePulses();
    }
    void setSwing(int val) {
        base_swing = constrain(val, 50, 95);
-        _recalculatePulses();
    }

    // Euclidean
--- a/firmware/Gravity/display.h
+++ b/firmware/Gravity/display.h
@ -104,7 +104,6 @@ enum ParamsMainPage : uint8_t {
    PARAM_MAIN_RESET,
    PARAM_MAIN_PULSE,
    PARAM_MAIN_ENCODER_DIR,
-    PARAM_MAIN_ROTATE_DISP,
    PARAM_MAIN_SAVE_DATA,
    PARAM_MAIN_LOAD_DATA,
    PARAM_MAIN_FACTORY_RESET,
@ -125,6 +124,22 @@ enum ParamsChannelPage : uint8_t {
    PARAM_CH_LAST,
 };

+// Common/resused strings stored as const to save on flash memory.
+const char* const STR_24_PPQN = "24 PPQN";
+const char* const STR_4_PPQN = "4 PPQN";
+const char* const STR_1_PPQN = "1 PPQN";
+const char* const STR_CV_1 = "CV 1";
+const char* const STR_CV_2 = "CV 2";
+const char* const STR_NONE = "NONE";
+const char* const STR_EXT = "EXT";
+const char* const STR_X = "X";
+const char* const STR_DEFAULT = "DEFAULT";
+const char* const STR_REVERSED = "REVERSED";
+const char* const STR_FLIPPED = "FLIPPED";
+const char* const STR_BACK = "BACK TO MAIN";
+const char* const STR_EUC_STEPS = "EUCLID STEPS";
+const char* const STR_EUC_HITS = "EUCLID HITS";
+
 // Helper function to draw centered text
 void drawCenteredText(const char* text, int y, const uint8_t* font) {
    gravity.display.setFont(font);
@ -238,27 +253,27 @@ void DisplayMainPage() {
        case PARAM_MAIN_TEMPO:
            // Serial MIDI is too unstable to display bpm in real time.
            if (app.selected_source == Clock::SOURCE_EXTERNAL_MIDI) {
-                mainText = F("EXT");
+                mainText = STR_EXT;
            } else {
                mainText = String(gravity.clock.Tempo());
            }
            subText = F("BPM");
            break;
        case PARAM_MAIN_SOURCE:
-            mainText = F("EXT");
+            mainText = STR_EXT;
            switch (app.selected_source) {
                case Clock::SOURCE_INTERNAL:
                    mainText = F("INT");
                    subText = F("CLOCK");
                    break;
                case Clock::SOURCE_EXTERNAL_PPQN_24:
-                    subText = F("24 PPQN");
+                    subText = STR_24_PPQN;
                    break;
                case Clock::SOURCE_EXTERNAL_PPQN_4:
-                    subText = F("4 PPQN");
+                    subText = STR_4_PPQN;
                    break;
                case Clock::SOURCE_EXTERNAL_PPQN_1:
-                    subText = F("1 PPQN");
+                    subText = STR_1_PPQN;
                    break;
                case Clock::SOURCE_EXTERNAL_MIDI:
                    subText = F("MIDI");
@ -269,13 +284,13 @@ void DisplayMainPage() {
            mainText = F("RUN");
            switch (app.cv_run) {
                case 0:
-                    subText = F("NONE");
+                    subText = STR_NONE;
                    break;
                case 1:
-                    subText = F("CV 1");
+                    subText = STR_CV_1;
                    break;
                case 2:
-                    subText = F("CV 2");
+                    subText = STR_CV_2;
                    break;
            }
            break;
@ -283,13 +298,13 @@ void DisplayMainPage() {
            mainText = F("RST");
            switch (app.cv_reset) {
                case 0:
-                    subText = F("NONE");
+                    subText = STR_NONE;
                    break;
                case 1:
-                    subText = F("CV 1");
+                    subText = STR_CV_1;
                    break;
                case 2:
-                    subText = F("CV 2");
+                    subText = STR_CV_2;
                    break;
            }
            break;
@ -300,29 +315,25 @@ void DisplayMainPage() {
                    subText = F("PULSE OFF");
                    break;
                case Clock::PULSE_PPQN_24:
-                    subText = F("24 PPQN PULSE");
+                    subText = STR_24_PPQN;
                    break;
                case Clock::PULSE_PPQN_4:
-                    subText = F("4 PPQN PULSE");
+                    subText = STR_4_PPQN;
                    break;
                case Clock::PULSE_PPQN_1:
-                    subText = F("1 PPQN PULSE");
+                    subText = STR_1_PPQN;
                    break;
            }
            break;
        case PARAM_MAIN_ENCODER_DIR:
            mainText = F("DIR");
-            subText = app.selected_sub_param == 0 ? F("DEFAULT") : F("REVERSED");
-            break;
-        case PARAM_MAIN_ROTATE_DISP:
-            mainText = F("ROT");
-            subText = app.selected_sub_param == 0 ? F("DEFAULT") : F("FLIPPED");
+            subText = app.selected_sub_param == 0 ? STR_DEFAULT : STR_REVERSED;
            break;
        case PARAM_MAIN_SAVE_DATA:
        case PARAM_MAIN_LOAD_DATA:
            if (app.selected_sub_param == StateManager::MAX_SAVE_SLOTS) {
-                mainText = F("x");
-                subText = F("BACK TO MAIN");
+                mainText = STR_X;
+                subText = STR_BACK;
            } else {
                // Indicate currently active slot.
                if (app.selected_sub_param == app.selected_save_slot) {
@ -339,8 +350,8 @@ void DisplayMainPage() {
                mainText = F("DEL");
                subText = F("FACTORY RESET");
            } else {
-                mainText = F("x");
-                subText = F("BACK TO MAIN");
+                mainText = STR_X;
+                subText = STR_BACK;
            }
            break;
    }
@ -349,7 +360,7 @@ void DisplayMainPage() {
    drawCenteredText(subText.c_str(), SUB_TEXT_Y, TEXT_FONT);

    // Draw Main Page menu items
-    String menu_items[PARAM_MAIN_LAST] = {F("TEMPO"), F("SOURCE"), F("CLK RUN"), F("CLK RESET"), F("PULSE OUT"), F("ENCODER DIR"), F("ROTATE DISP"), F("SAVE"), F("LOAD"), F("ERASE")};
+    String menu_items[PARAM_MAIN_LAST] = {F("TEMPO"), F("SOURCE"), F("CLK RUN"), F("CLK RESET"), F("PULSE OUT"), F("ENCODER DIR"), F("SAVE"), F("LOAD"), F("ERASE")};
    drawMenuItems(menu_items, PARAM_MAIN_LAST);
 }

@ -371,7 +382,7 @@ void DisplayChannelPage() {

    switch (app.selected_param) {
        case PARAM_CH_MOD: {
-            int mod_value = withCvMod ? ch.getClockModWithMod(cv1, cv2) : ch.getClockMod();
+            int mod_value = withCvMod ? ch.getClockModWithMod(cv1, cv2): ch.getClockMod();
            if (mod_value > 1) {
                mainText = F("/");
                mainText += String(mod_value);
@ -399,16 +410,16 @@ void DisplayChannelPage() {
            ch.getSwing() == 50
                ? mainText = F("OFF")
                : mainText = String(withCvMod ? ch.getSwingWithMod(cv1, cv2) : ch.getSwing()) + F("%");
-            subText = "DOWN BEAT";
+            subText = F("DOWN BEAT");
            swingDivisionMark();
            break;
        case PARAM_CH_EUC_STEPS:
            mainText = String(withCvMod ? ch.getStepsWithMod(cv1, cv2) : ch.getSteps());
-            subText = "EUCLID STEPS";
+            subText = STR_EUC_STEPS;
            break;
        case PARAM_CH_EUC_HITS:
            mainText = String(withCvMod ? ch.getHitsWithMod(cv1, cv2) : ch.getHits());
-            subText = "EUCLID HITS";
+            subText = STR_EUC_HITS;
            break;
        case PARAM_CH_CV1_DEST:
        case PARAM_CH_CV2_DEST: {
@ -433,10 +444,10 @@ void DisplayChannelPage() {
                    subText = F("SWING");
                    break;
                case CV_DEST_EUC_STEPS:
-                    subText = F("EUCLID STEPS");
+                    subText = STR_EUC_STEPS;
                    break;
                case CV_DEST_EUC_HITS:
-                    subText = F("EUCLID HITS");
+                    subText = STR_EUC_HITS;
                    break;
            }
            break;
@ -499,4 +510,22 @@ void UpdateDisplay() {
    } while (gravity.display.nextPage());
 }

+void Bootsplash() {
+    gravity.display.firstPage();
+    do {
+        int textWidth;
+        String loadingText = F("LOADING....");
+        gravity.display.setFont(TEXT_FONT);
+
+        textWidth = gravity.display.getStrWidth(StateManager::SKETCH_NAME);
+        gravity.display.drawStr(16 + (textWidth / 2), 20, StateManager::SKETCH_NAME);
+
+        textWidth = gravity.display.getStrWidth(StateManager::SEMANTIC_VERSION);
+        gravity.display.drawStr(16 + (textWidth / 2), 32, StateManager::SEMANTIC_VERSION);
+
+        textWidth = gravity.display.getStrWidth(loadingText.c_str());
+        gravity.display.drawStr(26 + (textWidth / 2), 44, loadingText.c_str());
+    } while (gravity.display.nextPage());
+}
+
 #endif  // DISPLAY_H
--- a/firmware/Gravity/save_state.cpp
+++ b/firmware/Gravity/save_state.cpp
@ -17,7 +17,7 @@

 // Define the constants for the current firmware.
 const char StateManager::SKETCH_NAME[] = "ALT GRAVITY";
-const char StateManager::SEMANTIC_VERSION[] = "2.0.0";  // NOTE: This should match the version in the library.properties file.
+const char StateManager::SEMANTIC_VERSION[] = "V2.0.0BETA4";  // NOTE: This should match the version in the library.properties file.

 // Number of available save slots.
 const byte StateManager::MAX_SAVE_SLOTS = 10;
@ -212,7 +212,6 @@ void StateManager::_saveMetadata(const AppState& app) {
    // Global user settings
    current_meta.selected_save_slot = app.selected_save_slot;
    current_meta.encoder_reversed = app.encoder_reversed;
-    current_meta.rotate_display = app.rotate_display;

    EEPROM.put(METADATA_START_ADDR, current_meta);
    interrupts();
--- a/firmware/Gravity/save_state.h
+++ b/firmware/Gravity/save_state.h
@ -52,12 +52,11 @@ 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;
-        bool rotate_display;
    };
    struct ChannelState {
        byte base_clock_mod_index;
--- a/library.properties
+++ b/library.properties
@ -1,5 +1,5 @@
 name=libGravity
-version=2.0.0
+version=2.0.0beta3
 author=Adam Wonak
 maintainer=awonak <github.com/awonak>
 sentence=Hardware abstraction library for Sitka Instruments Gravity eurorack module
--- a/src/clock.h
+++ b/src/clock.h
@ -35,6 +35,7 @@ class Clock {
        SOURCE_INTERNAL,
        SOURCE_EXTERNAL_PPQN_24,
        SOURCE_EXTERNAL_PPQN_4,
+        SOURCE_EXTERNAL_PPQN_2,
        SOURCE_EXTERNAL_PPQN_1,
        SOURCE_EXTERNAL_MIDI,
        SOURCE_LAST,
@ -42,9 +43,9 @@ class Clock {

    enum Pulse {
        PULSE_NONE,
-        PULSE_PPQN_24,
-        PULSE_PPQN_4,
        PULSE_PPQN_1,
+        PULSE_PPQN_4,
+        PULSE_PPQN_24,
        PULSE_LAST,
    };

@ -97,6 +98,10 @@ class Clock {
                uClock.setClockMode(uClock.EXTERNAL_CLOCK);
                uClock.setInputPPQN(uClock.PPQN_4);
                break;
+            case SOURCE_EXTERNAL_PPQN_2:
+                uClock.setClockMode(uClock.EXTERNAL_CLOCK);
+                uClock.setInputPPQN(uClock.PPQN_2);
+                break;
            case SOURCE_EXTERNAL_PPQN_1:
                uClock.setClockMode(uClock.EXTERNAL_CLOCK);
                uClock.setInputPPQN(uClock.PPQN_1);