Add On-Screen Keyboard for UpDown Encoder and Rotary Encoder. (#7762)

* Add On-Screen Keyboard for UpDownInterrupt. Pls notice the new keyboard layout was inspired and adviced by https://github.com/csrutil * Add longPress event for RotaryEncoder Press. * Update UpdownInterrupt UP and DOWN on main UI. * Change the interrupt trigger mode from rising edge to falling edge to improve button response.
2025-12-29 22:20:37 +00:00 · 2025-08-29 23:26:27 +08:00
parent 5f8503c62d
commit fb34dac08d
10 changed files with 236 additions and 55 deletions
--- a/src/input/ButtonThread.h
+++ b/src/input/ButtonThread.h
@@ -76,6 +76,9 @@ class ButtonThread : public Observable<const InputEvent *>, public concurrency::
            return digitalRead(buttonPin); // Most buttons are active low by default
    }

+    // Returns true while this thread's button is physically held down
+    bool isHeld() { return isButtonPressed(_pinNum); }
+
    // Disconnect and reconnect interrupts for light sleep
 #ifdef ARCH_ESP32
    int beforeLightSleep(void *unused);
--- a/src/input/InputBroker.h
+++ b/src/input/InputBroker.h
@@ -4,7 +4,9 @@
 enum input_broker_event {
    INPUT_BROKER_NONE = 0,
    INPUT_BROKER_SELECT = 10,
-    INPUT_BROKER_SELECT_LONG,
+    INPUT_BROKER_SELECT_LONG = 11,
+    INPUT_BROKER_UP_LONG = 12,
+    INPUT_BROKER_DOWN_LONG = 13,
    INPUT_BROKER_UP = 17,
    INPUT_BROKER_DOWN = 18,
    INPUT_BROKER_LEFT = 19,
--- a/src/input/RotaryEncoderInterruptBase.cpp
+++ b/src/input/RotaryEncoderInterruptBase.cpp
@@ -8,15 +8,17 @@ RotaryEncoderInterruptBase::RotaryEncoderInterruptBase(const char *name) : concu

 void RotaryEncoderInterruptBase::init(
    uint8_t pinA, uint8_t pinB, uint8_t pinPress, input_broker_event eventCw, input_broker_event eventCcw,
-    input_broker_event eventPressed,
+    input_broker_event eventPressed, input_broker_event eventPressedLong,
    //    std::function<void(void)> onIntA, std::function<void(void)> onIntB, std::function<void(void)> onIntPress) :
    void (*onIntA)(), void (*onIntB)(), void (*onIntPress)())
 {
    this->_pinA = pinA;
    this->_pinB = pinB;
+    this->_pinPress = pinPress;
    this->_eventCw = eventCw;
    this->_eventCcw = eventCcw;
    this->_eventPressed = eventPressed;
+    this->_eventPressedLong = eventPressedLong;

    bool isRAK = false;
 #ifdef RAK_4631
@@ -46,10 +48,37 @@ int32_t RotaryEncoderInterruptBase::runOnce()
    InputEvent e;
    e.inputEvent = INPUT_BROKER_NONE;
    e.source = this->_originName;
+    unsigned long now = millis();

+    // Handle press long/short detection
    if (this->action == ROTARY_ACTION_PRESSED) {
-        LOG_DEBUG("Rotary event Press");
-        e.inputEvent = this->_eventPressed;
+        bool buttonPressed = !digitalRead(_pinPress);
+        if (!pressDetected && buttonPressed) {
+            pressDetected = true;
+            pressStartTime = now;
+        }
+
+        if (pressDetected) {
+            uint32_t duration = now - pressStartTime;
+            if (!buttonPressed) {
+                // released -> if short press, send short, else already sent long
+                if (duration < LONG_PRESS_DURATION && now - lastPressKeyTime >= pressDebounceMs) {
+                    lastPressKeyTime = now;
+                    LOG_DEBUG("Rotary event Press short");
+                    e.inputEvent = this->_eventPressed;
+                }
+                pressDetected = false;
+                pressStartTime = 0;
+                lastPressLongEventTime = 0;
+                this->action = ROTARY_ACTION_NONE;
+            } else if (duration >= LONG_PRESS_DURATION && this->_eventPressedLong != INPUT_BROKER_NONE &&
+                       lastPressLongEventTime == 0) {
+                // fire single-shot long press
+                lastPressLongEventTime = now;
+                LOG_DEBUG("Rotary event Press long");
+                e.inputEvent = this->_eventPressedLong;
+            }
+        }
    } else if (this->action == ROTARY_ACTION_CW) {
        LOG_DEBUG("Rotary event CW");
        e.inputEvent = this->_eventCw;
@@ -62,7 +91,9 @@ int32_t RotaryEncoderInterruptBase::runOnce()
        this->notifyObservers(&e);
    }

-    this->action = ROTARY_ACTION_NONE;
+    if (!pressDetected) {
+        this->action = ROTARY_ACTION_NONE;
+    }

    return INT32_MAX;
 }
@@ -70,7 +101,7 @@ int32_t RotaryEncoderInterruptBase::runOnce()
 void RotaryEncoderInterruptBase::intPressHandler()
 {
    this->action = ROTARY_ACTION_PRESSED;
-    setIntervalFromNow(20); // TODO: this modifies a non-volatile variable!
+    setIntervalFromNow(20); // start checking for long/short
 }

 void RotaryEncoderInterruptBase::intAHandler()
--- a/src/input/RotaryEncoderInterruptBase.h
+++ b/src/input/RotaryEncoderInterruptBase.h
@@ -13,7 +13,7 @@ class RotaryEncoderInterruptBase : public Observable<const InputEvent *>, public
  public:
    explicit RotaryEncoderInterruptBase(const char *name);
    void init(uint8_t pinA, uint8_t pinB, uint8_t pinPress, input_broker_event eventCw, input_broker_event eventCcw,
-              input_broker_event eventPressed,
+              input_broker_event eventPressed, input_broker_event eventPressedLong,
              //        std::function<void(void)> onIntA, std::function<void(void)> onIntB, std::function<void(void)> onIntPress);
              void (*onIntA)(), void (*onIntB)(), void (*onIntPress)());
    void intPressHandler();
@@ -33,10 +33,22 @@ class RotaryEncoderInterruptBase : public Observable<const InputEvent *>, public
    volatile RotaryEncoderInterruptBaseActionType action = ROTARY_ACTION_NONE;

  private:
+    // pins and events
    uint8_t _pinA = 0;
    uint8_t _pinB = 0;
+    uint8_t _pinPress = 0;
    input_broker_event _eventCw = INPUT_BROKER_NONE;
    input_broker_event _eventCcw = INPUT_BROKER_NONE;
    input_broker_event _eventPressed = INPUT_BROKER_NONE;
+    input_broker_event _eventPressedLong = INPUT_BROKER_NONE;
    const char *_originName;
+
+    // Long press detection variables
+    uint32_t pressStartTime = 0;
+    bool pressDetected = false;
+    uint32_t lastPressLongEventTime = 0;
+    unsigned long lastPressKeyTime = 0;
+    static const uint32_t LONG_PRESS_DURATION = 300;      // ms
+    static const uint32_t LONG_PRESS_REPEAT_INTERVAL = 0; // 0 = single-shot for rotary select
+    const unsigned long pressDebounceMs = 200;            // ms
 };
--- a/src/input/RotaryEncoderInterruptImpl1.cpp
+++ b/src/input/RotaryEncoderInterruptImpl1.cpp
@@ -1,5 +1,6 @@
 #include "RotaryEncoderInterruptImpl1.h"
 #include "InputBroker.h"
+extern bool osk_found;

 RotaryEncoderInterruptImpl1 *rotaryEncoderInterruptImpl1;

@@ -19,12 +20,14 @@ bool RotaryEncoderInterruptImpl1::init()
    input_broker_event eventCw = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_cw);
    input_broker_event eventCcw = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_ccw);
    input_broker_event eventPressed = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_press);
+    input_broker_event eventPressedLong = INPUT_BROKER_SELECT_LONG;

    // moduleConfig.canned_message.ext_notification_module_output
-    RotaryEncoderInterruptBase::init(pinA, pinB, pinPress, eventCw, eventCcw, eventPressed,
+    RotaryEncoderInterruptBase::init(pinA, pinB, pinPress, eventCw, eventCcw, eventPressed, eventPressedLong,
                                     RotaryEncoderInterruptImpl1::handleIntA, RotaryEncoderInterruptImpl1::handleIntB,
                                     RotaryEncoderInterruptImpl1::handleIntPressed);
    inputBroker->registerSource(this);
+    osk_found = true;
    return true;
 }

--- a/src/input/UpDownInterruptBase.cpp
+++ b/src/input/UpDownInterruptBase.cpp
@@ -7,14 +7,22 @@ UpDownInterruptBase::UpDownInterruptBase(const char *name) : concurrency::OSThre
 }

 void UpDownInterruptBase::init(uint8_t pinDown, uint8_t pinUp, uint8_t pinPress, input_broker_event eventDown,
-                               input_broker_event eventUp, input_broker_event eventPressed, void (*onIntDown)(),
+                               input_broker_event eventUp, input_broker_event eventPressed, input_broker_event eventPressedLong,
+                               input_broker_event eventUpLong, input_broker_event eventDownLong, void (*onIntDown)(),
                               void (*onIntUp)(), void (*onIntPress)(), unsigned long updownDebounceMs)
 {
    this->_pinDown = pinDown;
    this->_pinUp = pinUp;
+    this->_pinPress = pinPress;
    this->_eventDown = eventDown;
    this->_eventUp = eventUp;
    this->_eventPressed = eventPressed;
+    this->_eventPressedLong = eventPressedLong;
+    this->_eventUpLong = eventUpLong;
+    this->_eventDownLong = eventDownLong;
+
+    // Store debounce configuration passed by caller
+    this->updownDebounceMs = updownDebounceMs;
    bool isRAK = false;
 #ifdef RAK_4631
    isRAK = true;
@@ -22,20 +30,20 @@ void UpDownInterruptBase::init(uint8_t pinDown, uint8_t pinUp, uint8_t pinPress,

    if (!isRAK || pinPress != 0) {
        pinMode(pinPress, INPUT_PULLUP);
-        attachInterrupt(pinPress, onIntPress, RISING);
+        attachInterrupt(pinPress, onIntPress, FALLING);
    }
    if (!isRAK || this->_pinDown != 0) {
        pinMode(this->_pinDown, INPUT_PULLUP);
-        attachInterrupt(this->_pinDown, onIntDown, RISING);
+        attachInterrupt(this->_pinDown, onIntDown, FALLING);
    }
    if (!isRAK || this->_pinUp != 0) {
        pinMode(this->_pinUp, INPUT_PULLUP);
-        attachInterrupt(this->_pinUp, onIntUp, RISING);
+        attachInterrupt(this->_pinUp, onIntUp, FALLING);
    }

    LOG_DEBUG("Up/down/press GPIO initialized (%d, %d, %d)", this->_pinUp, this->_pinDown, pinPress);

-    this->setInterval(100);
+    this->setInterval(20);
 }

 int32_t UpDownInterruptBase::runOnce()
@@ -43,23 +51,88 @@ int32_t UpDownInterruptBase::runOnce()
    InputEvent e;
    e.inputEvent = INPUT_BROKER_NONE;
    unsigned long now = millis();
-    if (this->action == UPDOWN_ACTION_PRESSED) {
-        if (now - lastPressKeyTime >= pressDebounceMs) {
-            lastPressKeyTime = now;
-            LOG_DEBUG("GPIO event Press");
-            e.inputEvent = this->_eventPressed;
+
+    // Read all button states once at the beginning
+    bool pressButtonPressed = !digitalRead(_pinPress);
+    bool upButtonPressed = !digitalRead(_pinUp);
+    bool downButtonPressed = !digitalRead(_pinDown);
+
+    // Handle initial button press detection - only if not already detected
+    if (this->action == UPDOWN_ACTION_PRESSED && pressButtonPressed && !pressDetected) {
+        pressDetected = true;
+        pressStartTime = now;
+    } else if (this->action == UPDOWN_ACTION_UP && upButtonPressed && !upDetected) {
+        upDetected = true;
+        upStartTime = now;
+    } else if (this->action == UPDOWN_ACTION_DOWN && downButtonPressed && !downDetected) {
+        downDetected = true;
+        downStartTime = now;
+    }
+
+    // Handle long press detection for press button
+    if (pressDetected && pressStartTime > 0) {
+        uint32_t pressDuration = now - pressStartTime;
+
+        if (!pressButtonPressed) {
+            // Button released
+            if (pressDuration < LONG_PRESS_DURATION && now - lastPressKeyTime >= pressDebounceMs) {
+                lastPressKeyTime = now;
+                e.inputEvent = this->_eventPressed;
+            }
+            // Reset state
+            pressDetected = false;
+            pressStartTime = 0;
+            lastPressLongEventTime = 0;
+        } else if (pressDuration >= LONG_PRESS_DURATION && lastPressLongEventTime == 0) {
+            // First long press event only - avoid repeated events causing lag
+            e.inputEvent = this->_eventPressedLong;
+            lastPressLongEventTime = now;
        }
-    } else if (this->action == UPDOWN_ACTION_UP) {
-        if (now - lastUpKeyTime >= updownDebounceMs) {
-            lastUpKeyTime = now;
-            LOG_DEBUG("GPIO event Up");
-            e.inputEvent = this->_eventUp;
+    }
+
+    // Handle long press detection for up button
+    if (upDetected && upStartTime > 0) {
+        uint32_t upDuration = now - upStartTime;
+
+        if (!upButtonPressed) {
+            // Button released
+            if (upDuration < LONG_PRESS_DURATION && now - lastUpKeyTime >= updownDebounceMs) {
+                lastUpKeyTime = now;
+                e.inputEvent = this->_eventUp;
+            }
+            // Reset state
+            upDetected = false;
+            upStartTime = 0;
+            lastUpLongEventTime = 0;
+        } else if (upDuration >= LONG_PRESS_DURATION) {
+            // Auto-repeat long press events
+            if (lastUpLongEventTime == 0 || (now - lastUpLongEventTime) >= LONG_PRESS_REPEAT_INTERVAL) {
+                e.inputEvent = this->_eventUpLong;
+                lastUpLongEventTime = now;
+            }
        }
-    } else if (this->action == UPDOWN_ACTION_DOWN) {
-        if (now - lastDownKeyTime >= updownDebounceMs) {
-            lastDownKeyTime = now;
-            LOG_DEBUG("GPIO event Down");
-            e.inputEvent = this->_eventDown;
+    }
+
+    // Handle long press detection for down button
+    if (downDetected && downStartTime > 0) {
+        uint32_t downDuration = now - downStartTime;
+
+        if (!downButtonPressed) {
+            // Button released
+            if (downDuration < LONG_PRESS_DURATION && now - lastDownKeyTime >= updownDebounceMs) {
+                lastDownKeyTime = now;
+                e.inputEvent = this->_eventDown;
+            }
+            // Reset state
+            downDetected = false;
+            downStartTime = 0;
+            lastDownLongEventTime = 0;
+        } else if (downDuration >= LONG_PRESS_DURATION) {
+            // Auto-repeat long press events
+            if (lastDownLongEventTime == 0 || (now - lastDownLongEventTime) >= LONG_PRESS_REPEAT_INTERVAL) {
+                e.inputEvent = this->_eventDownLong;
+                lastDownLongEventTime = now;
+            }
        }
    }

@@ -69,8 +142,11 @@ int32_t UpDownInterruptBase::runOnce()
        this->notifyObservers(&e);
    }

-    this->action = UPDOWN_ACTION_NONE;
-    return 100;
+    if (!pressDetected && !upDetected && !downDetected) {
+        this->action = UPDOWN_ACTION_NONE;
+    }
+
+    return 20; // This will control how the input frequency
 }

 void UpDownInterruptBase::intPressHandler()
--- a/src/input/UpDownInterruptBase.h
+++ b/src/input/UpDownInterruptBase.h
@@ -8,7 +8,8 @@ class UpDownInterruptBase : public Observable<const InputEvent *>, public concur
  public:
    explicit UpDownInterruptBase(const char *name);
    void init(uint8_t pinDown, uint8_t pinUp, uint8_t pinPress, input_broker_event eventDown, input_broker_event eventUp,
-              input_broker_event eventPressed, void (*onIntDown)(), void (*onIntUp)(), void (*onIntPress)(),
+              input_broker_event eventPressed, input_broker_event eventPressedLong, input_broker_event eventUpLong,
+              input_broker_event eventDownLong, void (*onIntDown)(), void (*onIntUp)(), void (*onIntPress)(),
              unsigned long updownDebounceMs = 50);
    void intPressHandler();
    void intDownHandler();
@@ -17,16 +18,41 @@ class UpDownInterruptBase : public Observable<const InputEvent *>, public concur
    int32_t runOnce() override;

  protected:
-    enum UpDownInterruptBaseActionType { UPDOWN_ACTION_NONE, UPDOWN_ACTION_PRESSED, UPDOWN_ACTION_UP, UPDOWN_ACTION_DOWN };
+    enum UpDownInterruptBaseActionType {
+        UPDOWN_ACTION_NONE,
+        UPDOWN_ACTION_PRESSED,
+        UPDOWN_ACTION_PRESSED_LONG,
+        UPDOWN_ACTION_UP,
+        UPDOWN_ACTION_UP_LONG,
+        UPDOWN_ACTION_DOWN,
+        UPDOWN_ACTION_DOWN_LONG
+    };

    volatile UpDownInterruptBaseActionType action = UPDOWN_ACTION_NONE;

+    // Long press detection variables
+    uint32_t pressStartTime = 0;
+    uint32_t upStartTime = 0;
+    uint32_t downStartTime = 0;
+    bool pressDetected = false;
+    bool upDetected = false;
+    bool downDetected = false;
+    uint32_t lastPressLongEventTime = 0;
+    uint32_t lastUpLongEventTime = 0;
+    uint32_t lastDownLongEventTime = 0;
+    static const uint32_t LONG_PRESS_DURATION = 300;
+    static const uint32_t LONG_PRESS_REPEAT_INTERVAL = 300;
+
  private:
    uint8_t _pinDown = 0;
    uint8_t _pinUp = 0;
+    uint8_t _pinPress = 0;
    input_broker_event _eventDown = INPUT_BROKER_NONE;
    input_broker_event _eventUp = INPUT_BROKER_NONE;
    input_broker_event _eventPressed = INPUT_BROKER_NONE;
+    input_broker_event _eventPressedLong = INPUT_BROKER_NONE;
+    input_broker_event _eventUpLong = INPUT_BROKER_NONE;
+    input_broker_event _eventDownLong = INPUT_BROKER_NONE;
    const char *_originName;

    unsigned long lastUpKeyTime = 0;
--- a/src/input/UpDownInterruptImpl1.cpp
+++ b/src/input/UpDownInterruptImpl1.cpp
@@ -1,5 +1,6 @@
 #include "UpDownInterruptImpl1.h"
 #include "InputBroker.h"
+extern bool osk_found;

 UpDownInterruptImpl1 *upDownInterruptImpl1;

@@ -17,13 +18,18 @@ bool UpDownInterruptImpl1::init()
    uint8_t pinDown = moduleConfig.canned_message.inputbroker_pin_b;
    uint8_t pinPress = moduleConfig.canned_message.inputbroker_pin_press;

-    input_broker_event eventDown = INPUT_BROKER_DOWN;
-    input_broker_event eventUp = INPUT_BROKER_UP;
+    input_broker_event eventDown = INPUT_BROKER_USER_PRESS; // acts like RIGHT/DOWN
+    input_broker_event eventUp = INPUT_BROKER_ALT_PRESS;    // acts like LEFT/UP
    input_broker_event eventPressed = INPUT_BROKER_SELECT;
+    input_broker_event eventPressedLong = INPUT_BROKER_SELECT_LONG;
+    input_broker_event eventUpLong = INPUT_BROKER_UP_LONG;
+    input_broker_event eventDownLong = INPUT_BROKER_DOWN_LONG;

-    UpDownInterruptBase::init(pinDown, pinUp, pinPress, eventDown, eventUp, eventPressed, UpDownInterruptImpl1::handleIntDown,
-                              UpDownInterruptImpl1::handleIntUp, UpDownInterruptImpl1::handleIntPressed);
+    UpDownInterruptBase::init(pinDown, pinUp, pinPress, eventDown, eventUp, eventPressed, eventPressedLong, eventUpLong,
+                              eventDownLong, UpDownInterruptImpl1::handleIntDown, UpDownInterruptImpl1::handleIntUp,
+                              UpDownInterruptImpl1::handleIntPressed);
    inputBroker->registerSource(this);
+    osk_found = true;
    return true;
 }