T-Lora Pager (#7613)

* initial commit

* preset rotary1 encoder

* define TAB+ESC

* haptic feedback

* allow switch off haptic feedback

* enable audio amplifier

* include PR4684

* fix for tft target

* add ES8311 audio codec

* fix KB scan duplicate

* display workaround to avoid debris

* fix debris on display

* keyboard backlight

* enable screen options

* fsm based bounce-free rotary encoder implementation

* use fsm RotaryEncoder only for T-Lora Pager

* change inputbroker default config to allow using rotary wheel for screens AND menues

---------

Co-authored-by: Thomas Göttgens <tgoettgens@gmail.com>
Co-authored-by: Ben Meadors <benmmeadors@gmail.com>

src/input/RotaryEncoderImpl.cpp

@@ -0,0 +1,73 @@
+#ifdef T_LORA_PAGER
+
+#include "RotaryEncoderImpl.h"
+#include "InputBroker.h"
+#include "RotaryEncoder.h"
+
+#define ORIGIN_NAME "RotaryEncoder"
+
+RotaryEncoderImpl *rotaryEncoderImpl;
+
+RotaryEncoderImpl::RotaryEncoderImpl() : concurrency::OSThread(ORIGIN_NAME), originName(ORIGIN_NAME) {}
+
+bool RotaryEncoderImpl::init()
+{
+    if (!moduleConfig.canned_message.updown1_enabled || moduleConfig.canned_message.inputbroker_pin_a == 0 ||
+        moduleConfig.canned_message.inputbroker_pin_b == 0) {
+        // Input device is disabled.
+        disable();
+        return false;
+    }
+
+    eventCw = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_cw);
+    eventCcw = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_ccw);
+    eventPressed = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_press);
+
+    rotary = new RotaryEncoder(moduleConfig.canned_message.inputbroker_pin_a, moduleConfig.canned_message.inputbroker_pin_b,
+                               moduleConfig.canned_message.inputbroker_pin_press);
+    rotary->resetButton();
+
+    inputBroker->registerSource(this);
+
+    LOG_INFO("RotaryEncoder initialized pins(%d, %d, %d), events(%d, %d, %d)", moduleConfig.canned_message.inputbroker_pin_a,
+             moduleConfig.canned_message.inputbroker_pin_b, moduleConfig.canned_message.inputbroker_pin_press, eventCw, eventCcw,
+             eventPressed);
+    return true;
+}
+
+int32_t RotaryEncoderImpl::runOnce()
+{
+    InputEvent e;
+    e.inputEvent = INPUT_BROKER_NONE;
+    e.source = this->originName;
+
+    static uint32_t lastPressed = millis();
+    if (rotary->readButton() == RotaryEncoder::ButtonState::BUTTON_PRESSED) {
+        if (lastPressed + 200 < millis()) {
+            LOG_DEBUG("Rotary event Press");
+            lastPressed = millis();
+            e.inputEvent = this->eventPressed;
+        }
+    } else {
+        switch (rotary->process()) {
+        case RotaryEncoder::DIRECTION_CW:
+            LOG_DEBUG("Rotary event CW");
+            e.inputEvent = this->eventCw;
+            break;
+        case RotaryEncoder::DIRECTION_CCW:
+            LOG_DEBUG("Rotary event CCW");
+            e.inputEvent = this->eventCcw;
+            break;
+        default:
+            break;
+        }
+    }
+
+    if (e.inputEvent != INPUT_BROKER_NONE) {
+        this->notifyObservers(&e);
+    }
+
+    return 20;
+}
+
+#endif

src/input/RotaryEncoderImpl.h

@@ -0,0 +1,28 @@
+#pragma once
+
+// This is a non-interrupt version of RotaryEncoder which is based on a debounce inherent FSM table (see RotaryEncoder library)
+
+#include "InputBroker.h"
+#include "concurrency/OSThread.h"
+#include "mesh/NodeDB.h"
+
+class RotaryEncoder;
+
+class RotaryEncoderImpl : public Observable<const InputEvent *>, public concurrency::OSThread
+{
+  public:
+    RotaryEncoderImpl();
+    bool init(void);
+
+  protected:
+    virtual int32_t runOnce() override;
+
+    input_broker_event eventCw = INPUT_BROKER_NONE;
+    input_broker_event eventCcw = INPUT_BROKER_NONE;
+    input_broker_event eventPressed = INPUT_BROKER_NONE;
+
+    RotaryEncoder *rotary;
+    const char *originName;
+};
+
+extern RotaryEncoderImpl *rotaryEncoderImpl;

src/input/TLoraPagerKeyboard.cpp

@@ -0,0 +1,230 @@
+#if defined(T_LORA_PAGER)
+
+#include "TLoraPagerKeyboard.h"
+#include "main.h"
+
+#ifndef LEDC_BACKLIGHT_CHANNEL
+#define LEDC_BACKLIGHT_CHANNEL 4
+#endif
+
+#ifndef LEDC_BACKLIGHT_BIT_WIDTH
+#define LEDC_BACKLIGHT_BIT_WIDTH 8
+#endif
+
+#ifndef LEDC_BACKLIGHT_FREQ
+#define LEDC_BACKLIGHT_FREQ 1000 // Hz
+#endif
+
+#define _TCA8418_COLS 10
+#define _TCA8418_ROWS 4
+#define _TCA8418_NUM_KEYS 31
+
+#define _TCA8418_MULTI_TAP_THRESHOLD 1500
+
+using Key = TCA8418KeyboardBase::TCA8418Key;
+
+constexpr uint8_t modifierRightShiftKey = 29 - 1; // keynum -1
+constexpr uint8_t modifierRightShift = 0b0001;
+constexpr uint8_t modifierSymKey = 21 - 1;
+constexpr uint8_t modifierSym = 0b0010;
+
+// Num chars per key, Modulus for rotating through characters
+static uint8_t TLoraPagerTapMod[_TCA8418_NUM_KEYS] = {3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,
+                                                      3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3};
+
+static unsigned char TLoraPagerTapMap[_TCA8418_NUM_KEYS][3] = {{'q', 'Q', '1'},
+                                                               {'w', 'W', '2'},
+                                                               {'e', 'E', '3'},
+                                                               {'r', 'R', '4'},
+                                                               {'t', 'T', '5'},
+                                                               {'y', 'Y', '6'},
+                                                               {'u', 'U', '7'},
+                                                               {'i', 'I', '8'},
+                                                               {'o', 'O', '9'},
+                                                               {'p', 'P', '0'},
+                                                               {'a', 'A', '*'},
+                                                               {'s', 'S', '/'},
+                                                               {'d', 'D', '+'},
+                                                               {'f', 'F', '-'},
+                                                               {'g', 'G', '='},
+                                                               {'h', 'H', ':'},
+                                                               {'j', 'J', '\''},
+                                                               {'k', 'K', '"'},
+                                                               {'l', 'L', '@'},
+                                                               {Key::SELECT, 0x00, Key::TAB},
+                                                               {0x00, 0x00, 0x00},
+                                                               {'z', 'Z', '_'},
+                                                               {'x', 'X', '$'},
+                                                               {'c', 'C', ';'},
+                                                               {'v', 'V', '?'},
+                                                               {'b', 'B', '!'},
+                                                               {'n', 'N', ','},
+                                                               {'m', 'M', '.'},
+                                                               {0x00, 0x00, 0x00},
+                                                               {Key::BSP, 0x00, Key::ESC},
+                                                               {' ', 0x00, Key::BL_TOGGLE}};
+
+TLoraPagerKeyboard::TLoraPagerKeyboard()
+    : TCA8418KeyboardBase(_TCA8418_ROWS, _TCA8418_COLS), modifierFlag(0), last_modifier_time(0), last_key(-1), next_key(-1),
+      last_tap(0L), char_idx(0), tap_interval(0)
+{
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
+    ledcAttach(KB_BL_PIN, LEDC_BACKLIGHT_FREQ, LEDC_BACKLIGHT_BIT_WIDTH);
+#else
+    ledcSetup(LEDC_BACKLIGHT_CHANNEL, LEDC_BACKLIGHT_FREQ, LEDC_BACKLIGHT_BIT_WIDTH);
+    ledcAttachPin(KB_BL_PIN, LEDC_BACKLIGHT_CHANNEL);
+#endif
+    reset();
+}
+
+void TLoraPagerKeyboard::reset(void)
+{
+    TCA8418KeyboardBase::reset();
+    pinMode(KB_BL_PIN, OUTPUT);
+    digitalWrite(KB_BL_PIN, LOW);
+    setBacklight(false);
+}
+
+// handle multi-key presses (shift and alt)
+void TLoraPagerKeyboard::trigger()
+{
+    uint8_t count = keyCount();
+    if (count == 0)
+        return;
+    for (uint8_t i = 0; i < count; ++i) {
+        uint8_t k = readRegister(TCA8418_REG_KEY_EVENT_A + i);
+        uint8_t key = k & 0x7F;
+        if (k & 0x80) {
+            pressed(key);
+        } else {
+            released();
+            state = Idle;
+        }
+    }
+}
+
+void TLoraPagerKeyboard::setBacklight(bool on)
+{
+    toggleBacklight(!on);
+}
+
+void TLoraPagerKeyboard::pressed(uint8_t key)
+{
+    if (state == Init || state == Busy) {
+        return;
+    }
+    if (config.device.buzzer_mode == meshtastic_Config_DeviceConfig_BuzzerMode_ALL_ENABLED ||
+        config.device.buzzer_mode == meshtastic_Config_DeviceConfig_BuzzerMode_SYSTEM_ONLY) {
+        hapticFeedback();
+    }
+
+    if (modifierFlag && (millis() - last_modifier_time > _TCA8418_MULTI_TAP_THRESHOLD)) {
+        modifierFlag = 0;
+    }
+
+    uint8_t next_key = 0;
+    int row = (key - 1) / 10;
+    int col = (key - 1) % 10;
+
+    if (row >= _TCA8418_ROWS || col >= _TCA8418_COLS) {
+        return; // Invalid key
+    }
+
+    next_key = row * _TCA8418_COLS + col;
+    state = Held;
+
+    uint32_t now = millis();
+    tap_interval = now - last_tap;
+
+    updateModifierFlag(next_key);
+    if (isModifierKey(next_key)) {
+        last_modifier_time = now;
+    }
+
+    if (tap_interval < 0) {
+        last_tap = 0;
+        state = Busy;
+        return;
+    }
+
+    if (next_key != last_key || tap_interval > _TCA8418_MULTI_TAP_THRESHOLD) {
+        char_idx = 0;
+    } else {
+        char_idx += 1;
+    }
+
+    last_key = next_key;
+    last_tap = now;
+}
+
+void TLoraPagerKeyboard::released()
+{
+    if (state != Held) {
+        return;
+    }
+
+    if (last_key < 0 || last_key >= _TCA8418_NUM_KEYS) {
+        last_key = -1;
+        state = Idle;
+        return;
+    }
+
+    uint32_t now = millis();
+    last_tap = now;
+
+    if (TLoraPagerTapMap[last_key][modifierFlag % TLoraPagerTapMod[last_key]] == Key::BL_TOGGLE) {
+        toggleBacklight();
+        return;
+    }
+
+    queueEvent(TLoraPagerTapMap[last_key][modifierFlag % TLoraPagerTapMod[last_key]]);
+    if (isModifierKey(last_key) == false)
+        modifierFlag = 0;
+}
+
+void TLoraPagerKeyboard::hapticFeedback()
+{
+    drv.setWaveform(0, 14); // strong buzz 100%
+    drv.setWaveform(1, 0);  // end waveform
+    drv.go();
+}
+
+// toggle brightness of the backlight in three steps
+void TLoraPagerKeyboard::toggleBacklight(bool off)
+{
+    static uint32_t brightness = 0;
+    if (off) {
+        brightness = 0;
+    } else {
+        if (brightness == 0) {
+            brightness = 40;
+        } else if (brightness == 40) {
+            brightness = 127;
+        } else if (brightness >= 127) {
+            brightness = 0;
+        }
+    }
+    LOG_DEBUG("Toggle backlight: %d", brightness);
+
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
+    ledcWrite(KB_BL_PIN, brightness);
+#else
+    ledcWrite(LEDC_BACKLIGHT_CHANNEL, brightness);
+#endif
+}
+
+void TLoraPagerKeyboard::updateModifierFlag(uint8_t key)
+{
+    if (key == modifierRightShiftKey) {
+        modifierFlag ^= modifierRightShift;
+    } else if (key == modifierSymKey) {
+        modifierFlag ^= modifierSym;
+    }
+}
+
+bool TLoraPagerKeyboard::isModifierKey(uint8_t key)
+{
+    return (key == modifierRightShiftKey || key == modifierSymKey);
+}
+
+#endif

src/input/TLoraPagerKeyboard.h

@@ -4,9 +4,26 @@ class TLoraPagerKeyboard : public TCA8418KeyboardBase
 {
   public:
     TLoraPagerKeyboard();
-    void setBacklight(bool on) override{};
+    void reset(void);
+    void trigger(void) override;
+    void setBacklight(bool on) override;
+    virtual ~TLoraPagerKeyboard() {}
 
   protected:
-    void pressed(uint8_t key) override{};
-    void released(void) override{};
+    void pressed(uint8_t key) override;
+    void released(void) override;
+    void hapticFeedback(void);
+
+    void updateModifierFlag(uint8_t key);
+    bool isModifierKey(uint8_t key);
+    void toggleBacklight(bool off = false);
+
+  private:
+    uint8_t modifierFlag;        // Flag to indicate if a modifier key is pressed
+    uint32_t last_modifier_time; // Timestamp of the last modifier key press
+    int8_t last_key;
+    int8_t next_key;
+    uint32_t last_tap;
+    uint8_t char_idx;
+    int32_t tap_interval;
 };

src/input/cardKbI2cImpl.cpp

@@ -12,8 +12,8 @@ void CardKbI2cImpl::init()
 #if !MESHTASTIC_EXCLUDE_I2C && !defined(ARCH_PORTDUINO) && !defined(I2C_NO_RESCAN)
     if (cardkb_found.address == 0x00) {
         LOG_DEBUG("Rescan for I2C keyboard");
-        uint8_t i2caddr_scan[] = {CARDKB_ADDR, TDECK_KB_ADDR, BBQ10_KB_ADDR, MPR121_KB_ADDR, XPOWERS_AXP192_AXP2101_ADDRESS};
-        uint8_t i2caddr_asize = 5;
+        uint8_t i2caddr_scan[] = {CARDKB_ADDR, TDECK_KB_ADDR, BBQ10_KB_ADDR, MPR121_KB_ADDR, TCA8418_KB_ADDR};
+        uint8_t i2caddr_asize = sizeof(i2caddr_scan) / sizeof(i2caddr_scan[0]);
         auto i2cScanner = std::unique_ptr<ScanI2CTwoWire>(new ScanI2CTwoWire());
 
 #if WIRE_INTERFACES_COUNT == 2