Replace RotaryNavConfig with RotaryInputAdapter (#206)

Replaced the RotaryNavConfig struct with a new RotaryInputAdapter class to handle rotary input for LCD menus efficiently. The adapter manages user input through a rotary encoder, recognizing short, long, and double presses for menu navigation and selection.

examples/InputRotary/InputRotary.ino

@@ -4,8 +4,8 @@
 #include <ItemSubMenu.h>
 #include <LcdMenu.h>
 #include <SimpleRotary.h>
+#include <input/SimpleRotaryAdapter.h>
 #include <interface/LiquidCrystalI2CAdapter.h>
-#include <utils/RotaryNavConfig.h>
 
 #define LCD_ROWS 2
 #define LCD_COLS 16
@@ -31,26 +31,18 @@ SUB_MENU(
     ITEM_INPUT_CHARSET("User", charset, inputCallback),
     ITEM_COMMAND("Clear", clearInput));
 
-LiquidCrystalI2CAdapter lcdAdapter(0x27, LCD_COLS, LCD_ROWS);
-LcdMenu menu(lcdAdapter);
-
 SimpleRotary encoder(2, 3, 4);
 
-RotaryNavConfig menuConfig = {
-    .encoder = &encoder,
-    .menu = &menu,
-    .longPressDuration = 1000,
-};
+LiquidCrystalI2CAdapter lcdAdapter(0x27, LCD_COLS, LCD_ROWS);
+LcdMenu menu(lcdAdapter);
+SimpleRotaryAdapter rotaryInput(&menu, &encoder);
 
 void setup() {
     Serial.begin(9600);
     menu.initialize(mainMenu);
 }
 
-void loop() {
-    // Call the handleRotaryMenu function, passing the menuConfig instance
-    processWithRotaryEncoder(&menuConfig);
-}
+void loop() { rotaryInput.observe(); }
 
 // Define the callbacks
 void inputCallback(char* value) {

examples/SimpleRotary/SimpleRotary.ino

@@ -3,8 +3,8 @@
 #include <ItemToggle.h>
 #include <LcdMenu.h>
 #include <SimpleRotary.h>
+#include <input/SimpleRotaryAdapter.h>
 #include <interface/LiquidCrystalI2CAdapter.h>
-#include <utils/RotaryNavConfig.h>
 
 #define LCD_ROWS 2
 #define LCD_COLS 16
@@ -32,27 +32,18 @@ MAIN_MENU(
     ITEM_TOGGLE("Backlight", toggleBacklight),
     ITEM_BASIC("Blink random"));
 
-LiquidCrystalI2CAdapter lcdAdapter(0x27, LCD_COLS, LCD_ROWS);
-LcdMenu menu(lcdAdapter);
-
 SimpleRotary encoder(2, 3, 4);
 
-RotaryNavConfig menuConfig = {
-    .encoder = &encoder,
-    .menu = &menu,
-    .longPressDuration = 1000,
-    .doublePressThreshold = 500,
-};
+LiquidCrystalI2CAdapter lcdAdapter(0x27, LCD_COLS, LCD_ROWS);
+LcdMenu menu(lcdAdapter);
+SimpleRotaryAdapter rotaryInput(&menu, &encoder);
 
 void setup() {
     Serial.begin(9600);
     menu.initialize(mainMenu);
 }
 
-void loop() {
-    // Call the handleRotaryMenu function, passing the menuConfig instance
-    processWithRotaryEncoder(&menuConfig);
-}
+void loop() { rotaryInput.observe(); }
 
 // Define the callbacks
 void toggleBacklight(uint16_t isOn) {

src/input/SimpleRotaryAdapter.h

@@ -0,0 +1,71 @@
+#pragma once
+
+#include "InputInterface.h"
+#include <SimpleRotary.h>
+
+/**
+ * @class SimpleRotaryAdapter
+ * @brief Adapter for handling rotary input for an LCD menu.
+ *
+ * This class interfaces with a rotary encoder to manage user input
+ * for navigating and selecting options in an LCD menu.
+ *
+ * It processes rotary encoder rotations to navigate through menu options
+ * and handles button presses for various actions, including:
+ * - Short press for selecting an option
+ * - Long press for going back
+ * - Double press for backspacing
+ *
+ * The values for long press duration (defined as LONG_PRESS_DURATION) and
+ * double press threshold (defined as DOUBLE_PRESS_THRESHOLD) can be
+ * overwritten by defining new ones with #define.
+ *
+ * @param menu Pointer to the LcdMenu instance that this adapter will control.
+ * @param encoder Pointer to the SimpleRotary instance representing the rotary encoder.
+ */
+class SimpleRotaryAdapter : public InputInterface {
+  private:
+    unsigned long lastPressTime = 0;  // Last time the button was pressed
+    bool pendingEnter = false;        // Flag to indicate if an enter action is pending
+    SimpleRotary* encoder;            // Pointer to the SimpleRotary instance
+
+  public:
+    SimpleRotaryAdapter(LcdMenu* menu, SimpleRotary* encoder)
+        : InputInterface(menu), encoder(encoder) {
+    }
+
+    void observe() override {
+        // Handle rotary encoder rotation
+        uint8_t rotation = encoder->rotate();
+        if (rotation == 1) {
+            menu->process(DOWN);  // Call DOWN action
+        } else if (rotation == 2) {
+            menu->process(UP);  // Call UP action
+        }
+
+        // Handle button press (short, long, and double press)
+        uint8_t pressType = encoder->pushType(LONG_PRESS_DURATION);
+        unsigned long currentTime = millis();
+
+        if (pressType == 1) {
+            if (pendingEnter) {
+                if (DOUBLE_PRESS_THRESHOLD > 0 && currentTime - lastPressTime < DOUBLE_PRESS_THRESHOLD) {
+                    menu->process(BACKSPACE);  // Call BACKSPACE action (double press)
+                    pendingEnter = false;
+                }
+            } else {
+                pendingEnter = true;
+                lastPressTime = currentTime;
+            }
+        } else if (pressType == 2) {
+            menu->process(BACK);  // Call BACK action (long press)
+            pendingEnter = false;
+        }
+
+        // Check if the doublePressThreshold has elapsed for pending enter action
+        if ((!menu->lcd.getEditModeEnabled() && pendingEnter) || (pendingEnter && (currentTime - lastPressTime >= DOUBLE_PRESS_THRESHOLD))) {
+            menu->process(ENTER);  // Call ENTER action (short press)
+            pendingEnter = false;
+        }
+    }
+};

src/utils/constants.h

@@ -30,6 +30,15 @@ const byte MENU_ITEM_PROGRESS = 10;
 #define LEFT 131     // >127
 #define CLEAR 132    // >127
 //
+// Rotary encoder configuration
+//
+#ifndef LONG_PRESS_DURATION
+#define LONG_PRESS_DURATION 1000
+#endif
+#ifndef DOUBLE_PRESS_THRESHOLD
+#define DOUBLE_PRESS_THRESHOLD 300
+#endif
+//
 const byte DOWN_ARROW[8] = {
     0b00100,  //   *
     0b00100,  //   *