Add initial support for M5Stack Cardputer ADV with Cap LoRa-1262

.github/workflows/build-cardputer-adv.yml

@@ -0,0 +1,42 @@
+name: Build Cardputer ADV
+
+on:
+  push:
+    branches:
+      - cardputer-ui-new-port
+    paths:
+      - 'boards/**'
+      - 'src/**'
+      - 'examples/**'
+      - 'variants/**'
+      - '.github/workflows/build-cardputer-adv.yml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'boards/**'
+      - 'src/**'
+      - 'examples/**'
+      - 'variants/**'
+      - '.github/workflows/build-cardputer-adv.yml'
+  workflow_dispatch:
+
+jobs:
+  build-cardputer:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        environment:
+          - M5stack_cardputer_cap_lora1262_companion_radio_ble
+          - M5stack_cardputer_cap_lora1262_companion_radio_usb
+
+    steps:
+      - name: Clone Repo
+        uses: actions/checkout@v4
+
+      - name: Setup Build Environment
+        uses: ./.github/actions/setup-build-environment
+
+      - name: Build ${{ matrix.environment }}
+        run: pio run -e ${{ matrix.environment }}

boards/m5stack_cardputer.json

@@ -0,0 +1,41 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "esp32s3_out.ld",
+      "partitions": "default_8MB.csv",
+      "memory_type": "qio_opi"
+    },
+    "core": "esp32",
+    "extra_flags": [
+      "-DARDUINO_M5STACK_CARDPUTER",
+      "-DBOARD_HAS_PSRAM",
+      "-DARDUINO_USB_CDC_ON_BOOT=1",
+      "-DARDUINO_USB_MODE=1",
+      "-DARDUINO_RUNNING_CORE=1",
+      "-DARDUINO_EVENT_RUNNING_CORE=1"
+    ],
+    "f_cpu": "240000000L",
+    "f_flash": "80000000L",
+    "flash_mode": "qio",
+    "hwids": [["0x303A", "0x1001"]],
+    "mcu": "esp32s3",
+    "variant": "esp32s3"
+  },
+  "connectivity": ["wifi", "bluetooth"],
+  "debug": {
+    "default_tool": "esp-builtin",
+    "onboard_tools": ["esp-builtin"],
+    "openocd_target": "esp32s3.cfg"
+  },
+  "frameworks": ["arduino", "espidf"],
+  "name": "M5Stack Cardputer-Adv (8M Flash 8M PSRAM)",
+  "upload": {
+    "flash_size": "8MB",
+    "maximum_ram_size": 327680,
+    "maximum_size": 8388608,
+    "require_upload_port": true,
+    "speed": 1500000
+  },
+  "url": "https://shop.m5stack.com/products/m5stack-cardputer-adv",
+  "vendor": "M5Stack"
+}

src/helpers/ui/M5CardputerDisplay.cpp

@@ -0,0 +1,3 @@
+#include "M5CardputerDisplay.h"
+
+// Most functionality is inline in the header.

src/helpers/ui/M5CardputerDisplay.h

@@ -0,0 +1,158 @@
+#pragma once
+
+#include <M5Cardputer.h>
+#include "DisplayDriver.h"
+
+#ifndef TFT_BLACK
+#define TFT_BLACK 0x0000
+#define TFT_WHITE 0xFFFF
+#define TFT_RED 0xF800
+#define TFT_GREEN 0x07E0
+#define TFT_BLUE 0x001F
+#define TFT_YELLOW 0xFFE0
+#define TFT_ORANGE 0xFD20
+#endif
+
+#ifdef CARDPUTER_RF_DIAG_OVERLAY
+class M5CardputerDisplay;
+void cardputerDrawRfOverlay(M5CardputerDisplay& disp);
+#endif
+
+class M5CardputerDisplay : public DisplayDriver {
+private:
+  bool _isOn = false;
+  uint16_t cursor_x = 0;
+  uint16_t cursor_y = 0;
+  uint16_t text_size = 1;
+  uint16_t _color = TFT_WHITE;
+  uint16_t _light_color = TFT_WHITE;
+  uint16_t _dark_color = TFT_BLACK;
+  uint16_t _bg_color = TFT_BLACK;
+  static const uint16_t SCREEN_WIDTH = 240;
+  static const uint16_t SCREEN_HEIGHT = 135;
+  static const uint8_t CHAR_WIDTH = 6;
+  static const uint8_t CHAR_HEIGHT = 8;
+
+public:
+  M5CardputerDisplay() : DisplayDriver(SCREEN_WIDTH, SCREEN_HEIGHT) {}
+
+  bool begin() {
+    _isOn = true;
+    _bg_color = TFT_BLACK;
+    M5.Display.setRotation(1);
+    M5.Display.fillScreen(_bg_color);
+    M5.Display.setTextColor(TFT_WHITE, _bg_color);
+    M5.Display.setTextSize(1);
+    return true;
+  }
+
+  bool isOn() override { return _isOn; }
+
+  void turnOn() override {
+    if (!_isOn) {
+      M5.Display.wakeup();
+      M5.Display.setTextColor(_color, _bg_color);
+      _isOn = true;
+    }
+  }
+
+  void turnOff() override {
+    if (_isOn) {
+      M5.Display.sleep();
+      _isOn = false;
+    }
+  }
+
+  void clear() override {
+    if (!_isOn) return;
+    M5.Display.fillScreen(_bg_color);
+    cursor_x = 0;
+    cursor_y = 0;
+  }
+
+  void startFrame(Color bkg = DARK) override {
+    if (!_isOn) return;
+
+    switch (bkg) {
+      case DARK:   _bg_color = _dark_color; break;
+      case LIGHT:  _bg_color = _light_color; break;
+      case RED:    _bg_color = TFT_RED; break;
+      case GREEN:  _bg_color = TFT_GREEN; break;
+      case BLUE:   _bg_color = TFT_BLUE; break;
+      case YELLOW: _bg_color = TFT_YELLOW; break;
+      case ORANGE: _bg_color = TFT_ORANGE; break;
+      default:     _bg_color = _dark_color; break;
+    }
+
+    M5.Display.fillScreen(_bg_color);
+    M5.Display.setTextColor(_color, _bg_color);
+    cursor_x = 0;
+    cursor_y = 0;
+  }
+
+  void setTextSize(int sz) override {
+    text_size = sz;
+    M5.Display.setTextSize(sz);
+  }
+
+  void setColor(Color c) override {
+    switch (c) {
+      case DARK:   _color = _dark_color; break;
+      case LIGHT:  _color = _light_color; break;
+      case RED:    _color = TFT_RED; break;
+      case GREEN:  _color = TFT_GREEN; break;
+      case BLUE:   _color = TFT_BLUE; break;
+      case YELLOW: _color = TFT_YELLOW; break;
+      case ORANGE: _color = TFT_ORANGE; break;
+      default:     _color = _light_color; break;
+    }
+    M5.Display.setTextColor(_color, _bg_color);
+  }
+
+  void setCursor(int x, int y) override {
+    cursor_x = x;
+    cursor_y = y;
+    M5.Display.setCursor(x, y);
+  }
+
+  void print(const char* str) override {
+    if (!_isOn) return;
+    M5.Display.print(str);
+  }
+
+  void fillRect(int x, int y, int w, int h) override {
+    if (!_isOn) return;
+    M5.Display.fillRect(x, y, w, h, _color);
+  }
+
+  void drawRect(int x, int y, int w, int h) override {
+    if (!_isOn) return;
+    M5.Display.drawRect(x, y, w, h, _color);
+  }
+
+  void drawXbm(int x, int y, const uint8_t* bits, int w, int h) override {
+    if (!_isOn) return;
+    for (int yy = 0; yy < h; yy++) {
+      for (int xx = 0; xx < w; xx++) {
+        int byte_idx = (yy * ((w + 7) / 8)) + (xx / 8);
+        int bit_idx = xx % 8;
+        if (bits[byte_idx] & (1 << bit_idx)) {
+          M5.Display.drawPixel(x + xx, y + yy, _color);
+        }
+      }
+    }
+  }
+
+  uint16_t getTextWidth(const char* str) override {
+    return strlen(str) * CHAR_WIDTH * text_size;
+  }
+
+  void endFrame() override {
+    if (!_isOn) return;
+  }
+};
+
+inline void drawTextLine(M5CardputerDisplay& disp, int y, const char* str) {
+  disp.setCursor(0, y);
+  disp.print(str);
+}

src/helpers/ui/MomentaryButton.cpp

@@ -1,7 +1,64 @@
 #include "MomentaryButton.h"
 
+#if defined(M5STACK_CARDPUTER) && defined(CARDPUTER_KEYBOARD_UI_NAV)
+  #include <M5Cardputer.h>
+#endif
+
 #define MULTI_CLICK_WINDOW_MS  280
 
+#if defined(M5STACK_CARDPUTER) && defined(CARDPUTER_KEYBOARD_UI_NAV)
+static bool cardputerWordHas(const Keyboard_Class::KeysState& keys, char a, char b = 0, char c = 0, char d = 0) {
+  for (char ch : keys.word) {
+    if (ch == a || (b != 0 && ch == b) || (c != 0 && ch == c) || (d != 0 && ch == d)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+static int cardputerKeyboardNavEvent() {
+  static bool was_pressed = false;
+  static uint32_t last_event_ms = 0;
+
+  M5Cardputer.update();
+  M5Cardputer.Keyboard.updateKeyList();
+  M5Cardputer.Keyboard.updateKeysState();
+
+  auto& keys = M5Cardputer.Keyboard.keysState();
+
+  // Cardputer uses the punctuation keys with arrow legends for navigation:
+  //   left:  ',' / '<'
+  //   right: '/' / '?'  ('.' / '>' is also accepted on layouts that mark it as right)
+  //   enter: physical Enter
+  bool left = cardputerWordHas(keys, ',', '<');
+  bool right = cardputerWordHas(keys, '/', '?', '.', '>');
+  bool enter = keys.enter;
+  bool any = left || right || enter;
+
+  if (!any) {
+    was_pressed = false;
+    return BUTTON_EVENT_NONE;
+  }
+
+  if (was_pressed) {
+    return BUTTON_EVENT_NONE;
+  }
+
+  uint32_t now = millis();
+  if ((uint32_t)(now - last_event_ms) < 120UL) {
+    return BUTTON_EVENT_NONE;
+  }
+
+  was_pressed = true;
+  last_event_ms = now;
+
+  if (enter) return BUTTON_EVENT_LONG_PRESS;   // existing UI maps long press to KEY_ENTER
+  if (left) return BUTTON_EVENT_DOUBLE_CLICK;  // existing UI maps double click to KEY_PREV
+  if (right) return BUTTON_EVENT_CLICK;        // existing UI maps click to KEY_NEXT
+  return BUTTON_EVENT_NONE;
+}
+#endif
+
 MomentaryButton::MomentaryButton(int8_t pin, int long_press_millis, bool reverse, bool pulldownup, bool multiclick) { 
   _pin = pin;
   _reverse = reverse;
@@ -65,6 +122,13 @@ bool MomentaryButton::isPressed(int level) const {
 int MomentaryButton::check(bool repeat_click) {
   if (_pin < 0) return BUTTON_EVENT_NONE;
 
+#if defined(M5STACK_CARDPUTER) && defined(CARDPUTER_KEYBOARD_UI_NAV) && defined(PIN_USER_BTN)
+  if (_pin == PIN_USER_BTN && _threshold == 0) {
+    int keyboard_event = cardputerKeyboardNavEvent();
+    if (keyboard_event != BUTTON_EVENT_NONE) return keyboard_event;
+  }
+#endif
+
   int event = BUTTON_EVENT_NONE;
   int btn = _threshold > 0 ? (analogRead(_pin) < _threshold) : digitalRead(_pin);
   if (btn != prev) {