adolforeyna/tactility
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixes and improvements (#642)

Browse Source
This commit is contained in:
Shadowtrance
2026-08-31 07:10:52 +10:00
committed by GitHub
parent 7a81b525ed
commit d3656bcd3d
14 changed files with 344 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Devices/m5stack-tab5/Source/devices/tab5_keyboard.cpp
+87 -18
View File
@@ -29,8 +29,8 @@ static constexpr uint8_t I2C_ADDRESS = 0x6D;
static constexpr uint32_t REPEAT_INITIAL_MS = 400;
static constexpr uint32_t REPEAT_RATE_MS = 80;
// I2C event-poll interval - mirrors the old deprecated-HAL's 20ms Timer period. Drives both
// REG_INT_STAT polling (when no IRQ pin) and software key-repeat ticking.
// I2C event-poll interval
// Drives both REG_INT_STAT polling (when no IRQ pin) and software key-repeat ticking.
static constexpr uint32_t POLL_INTERVAL_MS = 20;
// Upper bound on events consumed per drain_events() call. Since the loop re-reads REG_EVENT_NUM
@@ -193,6 +193,7 @@ static uint32_t now_ms() {
// the event - and software key-repeat replays this same struct, so a held chord keeps its modifiers.
struct Tab5KeyEvent {
uint32_t key;
bool pressed;
bool ctrl;
bool alt;
uint8_t hid_keycode;
@@ -216,11 +217,20 @@ struct Tab5KeyboardInternal {
gpio_num_t irq_pin;
// Poll throttling (real-time based, since read_key() is called at whatever rate LVGL's indev
// timer and its own drain-loop - via continue_reading - happen to run at, unlike the old
// deprecated-HAL's fixed 20ms Timer)
// timer and its own drain-loop, via continue_reading, happen to run at).
uint32_t last_poll_ms;
// Software key-repeat state (tracked by position to survive modifier changes)
// Original press event for every currently-held key, indexed by matrix position (row*14+col),
// so a release can recover the exact event its press queued (modifiers captured at press
// time) even when another key was pressed and released in between. held_event[i].key can
// legitimately be 0 (e.g. F1-F12, see drain_events()), so held[i] tracks validity separately
// rather than using a sentinel key value.
Tab5KeyEvent held_event[70];
bool held[70];
// Software key-repeat state: tracks only the most recently pressed key, independent of the
// per-position storage above (repeats stop as soon as a different key is pressed, matching
// typical keyboard behavior, and don't need to survive that key's release).
Tab5KeyEvent repeat_event;
uint8_t repeat_row;
uint8_t repeat_col;
@@ -258,15 +268,17 @@ bool tab5_keyboard_is_attached(Device* device) {
}
// ---------------------------------------------------------------------------
// LED helpers - LED0 = Sym indicator (green), LED1 = Aa indicator (red)
// LED helpers - LED0 = Sym indicator (blue), LED1 = Aa indicator (red)
// RGB register layout: [B, G, R] per LED, stride 4 (byte 3 reserved)
// ---------------------------------------------------------------------------
static void update_leds(Device* device, const Tab5KeyboardInternal* internal) {
static constexpr uint8_t LED_SYM_ON_BLUE = 0xC0;
static constexpr uint8_t LED_AA_ON_RED = 0x90;
static void update_leds(Device* device, Tab5KeyboardInternal* internal) {
auto* parent = device_get_parent(device);
// [LED0: B,G,R, reserved, LED1: B,G,R]
uint8_t buf[7] = {
0x00, internal->sym_active ? uint8_t(0xA0) : uint8_t(0x00), 0x00, 0x00,
0x00, 0x00, internal->aa_sticky ? uint8_t(0xA0) : uint8_t(0x00),
internal->sym_active ? LED_SYM_ON_BLUE : uint8_t(0x00), 0x00, 0x00, 0x00,
0x00, 0x00, internal->aa_sticky ? LED_AA_ON_RED : uint8_t(0x00),
};
i2c_controller_write_register(parent, I2C_ADDRESS, REG_RGB_BASE, buf, 7, pdMS_TO_TICKS(50));
}
@@ -389,9 +401,14 @@ static void drain_events(Device* device, Tab5KeyboardInternal* internal) {
// no business reaching into, so ESC is now just queued as a normal key
// like everything else (LVGL/app code already handles ESC via focus/group
// navigation the same way a dedicated ESC key on any other keyboard would).
const Tab5KeyEvent event = { lv_key, internal->ctrl_held, internal->alt_held,
const Tab5KeyEvent event = { lv_key, true, internal->ctrl_held, internal->alt_held,
m.keycode, modifier };
xQueueSend(internal->queue, &event, 0);
// Remember this key's press event by position so its release (whenever it
// comes, regardless of what else is pressed in between) reports the same value.
const uint8_t idx = row * 14U + col;
internal->held_event[idx] = event;
internal->held[idx] = true;
// Arm software repeat tracking by row/col to survive modifier changes
const uint32_t now = now_ms();
internal->repeat_event = event;
@@ -405,9 +422,31 @@ static void drain_events(Device* device, Tab5KeyboardInternal* internal) {
internal->aa_held = false;
update_leds(device, internal);
}
} else if (row == internal->repeat_row && col == internal->repeat_col) {
// Match release by position, not translated value — survives sticky Aa clear
internal->repeat_event.key = 0;
} else {
// Always queue the release: callers key their own "is this held" state off
// (key, pressed) pairs, and a dropped release leaves that key stuck down forever.
//
// Reuse the matching press's key/modifier (via held_event, tracked by matrix
// position) rather than recomputing from current modifier state: aa_active
// above is read fresh, but sticky Aa is consumed right after the press fires
// (above), so recomputing here would give the release a different key value
// than its press whenever Aa was sticky (e.g. shifted vs unshifted). Only
// recompute as a fallback for the case where no press was ever recorded for
// this position (e.g. driver just started while the key was already held).
const uint8_t idx = row * 14U + col;
Tab5KeyEvent event;
if (internal->held[idx]) {
event = internal->held_event[idx];
internal->held[idx] = false;
} else {
event = { lv_key, false, internal->ctrl_held, internal->alt_held, m.keycode, modifier };
}
event.pressed = false;
xQueueSend(internal->queue, &event, 0);
if (row == internal->repeat_row && col == internal->repeat_col) {
internal->repeat_event.key = 0;
}
}
}
}
@@ -429,7 +468,7 @@ void tab5_keyboard_reinit(Device* device) {
write_reg_fast(device, REG_EVENT_NUM, 0x00); // flush event queue
write_reg_fast(device, REG_INT_STAT, 0x00); // clear pending INT
write_reg_fast(device, REG_RGB_MODE, 0x01); // Custom RGB mode (manual LED control)
write_reg_fast(device, REG_BRIGHTNESS, 50); // 50% brightness
write_reg_fast(device, REG_BRIGHTNESS, 30); // 30% brightness
update_leds(device, internal); // restore current LED state
if (internal->irq_configured) {
@@ -437,9 +476,39 @@ void tab5_keyboard_reinit(Device* device) {
}
}
void tab5_keyboard_reset_state(Device* device) {
auto* internal = static_cast<Tab5KeyboardInternal*>(device_get_driver_data(device));
for (uint8_t idx = 0; idx < 70U; idx++) {
if (internal->held[idx]) {
Tab5KeyEvent event = internal->held_event[idx];
event.pressed = false;
// This runs under lvgl_lock() (apply_state()'s caller), and the consumer that drains
// this queue is LVGL's own indev read callback - blocking here for queue space could
// deadlock against that consumer needing the same lock. Best-effort send only, same as
// drain_events()'s hot path; internal->held[idx] is still cleared on a dropped send so
// this reset doesn't get stuck retrying a release that already lost its only chance to
// be delivered before the state it referred to (an unplugged keyboard) is gone anyway.
xQueueSend(internal->queue, &event, 0);
internal->held[idx] = false;
}
}
internal->repeat_event.key = 0;
internal->repeat_row = 0xFF;
internal->repeat_col = 0xFF;
internal->sym_active = false;
internal->aa_sticky = false;
internal->aa_held = false;
internal->aa_tapped = false;
internal->ctrl_held = false;
internal->alt_held = false;
update_leds(device, internal);
}
// ---------------------------------------------------------------------------
// poll_if_due - the closest equivalent to the old deprecated-HAL's 20ms-Timer-driven
// processKeyboard(): drains new key events (IRQ-gated or polled) and ticks software key-repeat.
// poll_if_due - drains new key events (IRQ-gated or polled) and ticks software key-repeat.
// Called from read_key(), throttled to real elapsed time rather than call count, since read_key()
// can be called back-to-back multiple times per LVGL indev timer tick while draining an
// already-queued burst (continue_reading). Hot-plug attach detection lives outside the driver -
@@ -566,7 +635,7 @@ static error_t tab5_keyboard_read_key(Device* device, KeyboardKeyData* data) {
Tab5KeyEvent event = {};
if (xQueueReceive(internal->queue, &event, 0) == pdTRUE) {
data->key = event.key;
data->pressed = true;
data->pressed = event.pressed;
data->continue_reading = uxQueueMessagesWaiting(internal->queue) > 0;
data->ctrl = event.ctrl;
data->alt = event.alt;
Devices/m5stack-tab5/Source/devices/tab5_keyboard.h
+6
View File
@@ -37,6 +37,12 @@ bool tab5_keyboard_is_attached(struct Device* device);
// tab5_keyboard_attach_detect.cpp).
void tab5_keyboard_reinit(struct Device* device);
// Emits a release for every currently-held key (a hardware release can't arrive once the keyboard
// is unplugged), then clears held-key/software-repeat/modifier state. Callers must call this on
// confirmed detach (see tab5_keyboard_attach_detect.cpp) so a key held across an unplug doesn't
// leave consumers with a stuck key or spurious repeats/modifiers after reattach.
void tab5_keyboard_reset_state(struct Device* device);
#ifdef __cplusplus
}
#endif
Devices/m5stack-tab5/Source/devices/tab5_keyboard_attach_detect.cpp
+19 -3
View File
@@ -63,6 +63,11 @@ static bool apply_state(Device* keyboard_device, bool attached) {
lv_display_set_rotation(display, LV_DISPLAY_ROTATION_90);
}
} else {
// A key held at the moment of unplug can never get its hardware release - reset tracked
// state so it doesn't read as stuck or feed stale modifiers into whatever's pressed next
// after reattach.
tab5_keyboard_reset_state(keyboard_device);
// Only restore if rotation is still what we set it to - if the user manually changed it
// since attaching, respect their choice instead.
if (rotation_override_active && lv_display_get_rotation(display) == LV_DISPLAY_ROTATION_90) {
@@ -84,13 +89,24 @@ static void attach_detect_callback(TimerHandle_t /*timer*/) {
// LVGL restarting is a distinct event from the keyboard physically attaching/detaching: the
// accessory may never have moved, but whatever apply_state() last set (rotation) may have
// been reset in the meantime by the restart. Forcing was_attached false makes the block below
// see a fresh "attached" transition (still going through the normal 2-check debounce) so
// see a fresh "attached" transition, still going through the normal two-check debounce, so
// apply_state() re-announces the current state instead of staying silent forever, waiting for
// an edge that will never come because the keyboard was never actually unplugged.
// lvgl_is_running() is safe to call unlocked (unlike lv_display_get_default(), resolved inside
// the lock in apply_state() instead).
const bool lvgl_ready = lvgl_is_running();
if (lvgl_ready && !was_lvgl_ready) {
// If the keyboard is (and, per was_attached, already was) physically detached, forcing
// was_attached false below means the detach transition below will never fire again for
// this unplug - it already happened before this restart. Reset software state here
// instead, since apply_state()'s own detach path may never have run: it could have bailed
// out early (LVGL lock busy, or display not ready yet) before reaching its
// tab5_keyboard_reset_state() call, and now never will, because that transition is about
// to be erased. This reset doesn't touch LVGL/display state, so it doesn't need
// apply_state()'s lock/display gating.
if (was_attached && !tab5_keyboard_is_attached(keyboard_device)) {
tab5_keyboard_reset_state(keyboard_device);
}
was_attached = false;
pending_attach_confirm_count = 0;
}
@@ -98,7 +114,7 @@ static void attach_detect_callback(TimerHandle_t /*timer*/) {
const bool attached = tab5_keyboard_is_attached(keyboard_device);
if (attached != was_attached) {
// Require the new state to be confirmed on a second consecutive check before acting - a
// Require the new state to be confirmed on a second consecutive check before acting: a
// single probe on a floating/half-connected bus (e.g. mid-unplug) can false-positive.
if (attached != pending_attach_state || pending_attach_confirm_count == 0) {
pending_attach_state = attached;
@@ -108,7 +124,7 @@ static void attach_detect_callback(TimerHandle_t /*timer*/) {
if (apply_state(keyboard_device, attached)) {
was_attached = attached;
}
// else: not handled yet (e.g. LVGL lock busy) - retry on the next confirmed check
// else: not handled yet (e.g. LVGL lock busy); retry on the next confirmed check
}
} else {
pending_attach_confirm_count = 0;
Devices/m5stack-tab5/m5stack,tab5.dts
+1 -1
View File
@@ -174,7 +174,7 @@
i2c_keyboard: i2c2 {
compatible = "espressif,esp32-i2c-master";
port = <LP_I2C_NUM_0>;
clock-frequency = <100000>;
clock-frequency = <400000>;
clock-source = <LP_I2C_SCLK_DEFAULT>;
pin-sda = <&gpio0 0 GPIO_FLAG_PULL_UP>;
pin-scl = <&gpio0 1 GPIO_FLAG_PULL_UP>;