Merge pull request #13 from eurofurence/feature/prideflag-state-and-s…

…tartup Feature: Prideflag state simplification and default state setup
eurofurence · Sep 2, 2024 · c1ec5d8 · c1ec5d8
2 parents 1ad5130 + 40b6b76
commit c1ec5d8
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 115 deletions.
diff --git a/include/FSMGlobals.h b/include/FSMGlobals.h
@@ -39,7 +39,7 @@
 typedef struct {
     const char* lastRememberedState = "DisplayPrideFlag";  //!< Name of the state that should be resumed upon reboot
     uint8_t menuMainPointerIdx = 0;  //!< MenuMain: Index of the menu cursor
-    uint8_t prideFlagModeIdx = 0;    //!< DisplayPrideFlag: Mode selector
+    uint8_t prideFlagModeIdx = 1;    //!< DisplayPrideFlag: Mode selector
     uint8_t animationModeIdx = 0;    //!< DisplayAnimation: Mode selector
 } FSMGlobals;
 

diff --git a/include/FSMState.h b/include/FSMState.h
@@ -135,7 +135,7 @@ class FSMState {
 };
 
 /**
- * @brief Main state: Displays a pride flag
+ * @brief Displays pride flags
  */
 struct DisplayPrideFlag : public FSMState {
     uint32_t tick = 0;
@@ -150,10 +150,11 @@ struct DisplayPrideFlag : public FSMState {
     virtual void run() override;
 
     virtual std::unique_ptr<FSMState> touchEventFingerprintShortpress() override;
+    virtual std::unique_ptr<FSMState> touchEventFingerprintRelease() override;
 };
 
 /**
- * @brief Main state: Displays an animation
+ * @brief Displays animations
  */
 struct DisplayAnimation : public FSMState {
     uint32_t tick = 0;
@@ -176,53 +177,32 @@ struct DisplayAnimation : public FSMState {
 };
 
 /**
- * @brief Menu entry point
+ * @brief Accept and handle OTA updates
  */
-struct MenuMain : public FSMState {
-    uint8_t menucursor_idx = 0;
-
+struct OTAUpdate : public FSMState {
     virtual const char* getName() override;
 
     virtual void entry() override;
+    virtual void run() override;
     virtual void exit() override;
 
-    virtual std::unique_ptr<FSMState> touchEventFingerprintTouch() override;
-    virtual std::unique_ptr<FSMState> touchEventFingerprintRelease() override;
     virtual std::unique_ptr<FSMState> touchEventFingerprintShortpress() override;
-    virtual std::unique_ptr<FSMState> touchEventFingerprintLongpress() override;
-
-    virtual std::unique_ptr<FSMState> touchEventNoseLongpress() override;
 };
 
 /**
- * @brief Sub-Menu: Pride flag selector
+ * @brief Menu entry point
  */
-struct MenuPrideFlagSelector : public FSMState {
-    std::unique_ptr<DisplayPrideFlag> prideFlagDisplayRunner;
+struct MenuMain : public FSMState {
+    uint8_t menucursor_idx = 0;
 
     virtual const char* getName() override;
-    virtual const unsigned int getTickRateMs() override;
 
     virtual void entry() override;
-    virtual void run() override;
     virtual void exit() override;
 
     virtual std::unique_ptr<FSMState> touchEventFingerprintRelease() override;
     virtual std::unique_ptr<FSMState> touchEventFingerprintShortpress() override;
     virtual std::unique_ptr<FSMState> touchEventFingerprintLongpress() override;
 };
 
-/**
- * @brief Sub-Menu: Accept OTA updates
- */
-struct MenuOTAUpdate : public FSMState {
-    virtual const char* getName() override;
-
-    virtual void entry() override;
-    virtual void run() override;
-    virtual void exit() override;
-
-    virtual std::unique_ptr<FSMState> touchEventFingerprintShortpress() override;
-};
-
 #endif /* FSM_STATE_H_ */
diff --git a/src/FSM.cpp b/src/FSM.cpp
@@ -215,7 +215,7 @@ void FSM::restoreGlobals() {
     LOGF_INFO("(FSM) Restored FSM state data from NVS area: %s\r\n", this->NVS_NAMESPACE);
     this->globals->lastRememberedState = pref.getString("resumeState", "DisplayPrideFlag").c_str();
     LOGF_DEBUG("(FSM)  -> resumeState = %s\r\n", this->globals->lastRememberedState);
-    this->globals->prideFlagModeIdx = pref.getUInt("prideFlagMode", 0);
+    this->globals->prideFlagModeIdx = pref.getUInt("prideFlagMode", 1);
     LOGF_DEBUG("(FSM)  -> prideFlagMode = %d\r\n", this->globals->prideFlagModeIdx);
     this->globals->animationModeIdx = pref.getUInt("animationMode", 0);
     LOGF_DEBUG("(FSM)  -> animationMode = %d\r\n", this->globals->animationModeIdx);

diff --git a/src/states/DisplayPrideFlag.cpp b/src/states/DisplayPrideFlag.cpp
@@ -125,3 +125,11 @@ void DisplayPrideFlag::run() {
 std::unique_ptr<FSMState> DisplayPrideFlag::touchEventFingerprintShortpress() {
     return std::make_unique<MenuMain>();
 }
+
+std::unique_ptr<FSMState> DisplayPrideFlag::touchEventFingerprintRelease() {
+    this->globals->prideFlagModeIdx = (this->globals->prideFlagModeIdx + 1) % 13;
+    this->is_globals_dirty = true;
+    this->tick = 0;
+
+    return nullptr;
+}
diff --git a/src/states/MenuMain.cpp b/src/states/MenuMain.cpp
@@ -29,6 +29,12 @@
 
 #include "FSMState.h"
 
+/**
+ * @brief Number of registered menu items
+ */
+#define MENUMAIN_NUM_MENU_ITEMS 3
+
+
 const char* MenuMain::getName() {
     return "MenuMain";
 }
@@ -43,29 +49,22 @@ void MenuMain::exit() {
     EFLed.clear();
 }
 
-std::unique_ptr<FSMState> MenuMain::touchEventFingerprintTouch() {
-    return nullptr;
-}
-
 std::unique_ptr<FSMState> MenuMain::touchEventFingerprintRelease() {
-    this->globals->menuMainPointerIdx = (this->globals->menuMainPointerIdx + 1) % 2;
+    this->globals->menuMainPointerIdx = (this->globals->menuMainPointerIdx + 1) % MENUMAIN_NUM_MENU_ITEMS;
     EFLed.setEFBarCursor(this->globals->menuMainPointerIdx, CRGB::Purple, CRGB::Black);
     return nullptr;
 }
 
 std::unique_ptr<FSMState> MenuMain::touchEventFingerprintShortpress() {
     LOGF_DEBUG("(MenuMain) menuMainPointerIdx = %d\r\n", this->globals->menuMainPointerIdx);
     switch (this->globals->menuMainPointerIdx) {
-        case 0: return std::make_unique<MenuPrideFlagSelector>();
+        case 0: return std::make_unique<DisplayPrideFlag>();
         case 1: return std::make_unique<DisplayAnimation>();
+        case 2: return std::make_unique<OTAUpdate>();
         default: return nullptr;
     }
 }
 
 std::unique_ptr<FSMState> MenuMain::touchEventFingerprintLongpress() {
-    return std::make_unique<DisplayPrideFlag>();
-}
-
-std::unique_ptr<FSMState> MenuMain::touchEventNoseLongpress() {
-    return std::make_unique<MenuOTAUpdate>();
+    return this->touchEventFingerprintShortpress();
 }
diff --git a/src/states/menu/MenuOTAUpdate.cpp → src/states/OTAUpdate.cpp b/src/states/menu/MenuOTAUpdate.cpp → src/states/OTAUpdate.cpp
@@ -33,11 +33,11 @@
 
 #include "FSMState.h"
 
-const char* MenuOTAUpdate::getName() {
-    return "MenuOTAUpdate";
+const char* OTAUpdate::getName() {
+    return "OTAUpdate";
 }
 
-void MenuOTAUpdate::entry() {
+void OTAUpdate::entry() {
     // Connecto to wifi
     EFLed.setDragonNose(CRGB::Red);
     if (EFBoard.connectToWifi(WIFI_SSID, WIFI_PASSWORD)) {
@@ -49,15 +49,15 @@ void MenuOTAUpdate::entry() {
     EFLed.setDragonMuzzle(CRGB::Green);
 }
 
-void MenuOTAUpdate::run() {
+void OTAUpdate::run() {
     ArduinoOTA.handle();
 }
 
-void MenuOTAUpdate::exit() {
+void OTAUpdate::exit() {
     EFBoard.disableOTA();
     EFBoard.disableWifi();
 }
 
-std::unique_ptr<FSMState> MenuOTAUpdate::touchEventFingerprintShortpress() {
+std::unique_ptr<FSMState> OTAUpdate::touchEventFingerprintShortpress() {
     return std::make_unique<MenuMain>();
 }
diff --git a/src/states/menu/MenuPrideFlagSelector.cpp b/src/states/menu/MenuPrideFlagSelector.cpp