Skip to content

Allow UIScreen first dibs on button events #1032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
+56 −43
Open

Allow UIScreen first dibs on button events #1032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cda046b
Clean up UI button handling
kallanreed Oct 30, 2025
4cc2e74
Simplify checkDispOn
kallanreed Oct 30, 2025
b9d1781
undo unnecessary WS change
kallanreed Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 50 additions & 39 deletions examples/companion_radio/ui-new/UITask.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,52 +663,51 @@ bool UITask::isButtonPressed() const {
}

void UITask::loop() {
char c = 0;
#if UI_HAS_JOYSTICK
int ev = user_btn.check();
if (ev == BUTTON_EVENT_CLICK) {
c = checkDisplayOn(KEY_ENTER);
handleSingleClick(KEY_ENTER);
} else if (ev == BUTTON_EVENT_LONG_PRESS) {
c = handleLongPress(KEY_ENTER); // REVISIT: could be mapped to different key code
handleLongPress(KEY_ENTER); // REVISIT: could be mapped to different key code
}
ev = joystick_left.check();
if (ev == BUTTON_EVENT_CLICK) {
c = checkDisplayOn(KEY_LEFT);
handleSingleClick(KEY_LEFT);
} else if (ev == BUTTON_EVENT_LONG_PRESS) {
c = handleLongPress(KEY_LEFT);
handleLongPress(KEY_LEFT);
}
ev = joystick_right.check();
if (ev == BUTTON_EVENT_CLICK) {
c = checkDisplayOn(KEY_RIGHT);
handleSingleClick(KEY_RIGHT);
} else if (ev == BUTTON_EVENT_LONG_PRESS) {
c = handleLongPress(KEY_RIGHT);
handleLongPress(KEY_RIGHT);
}
ev = back_btn.check();
if (ev == BUTTON_EVENT_TRIPLE_CLICK) {
c = handleTripleClick(KEY_SELECT);
handleTripleClick(KEY_SELECT);
}
#elif defined(PIN_USER_BTN)
int ev = user_btn.check();
if (ev == BUTTON_EVENT_CLICK) {
c = checkDisplayOn(KEY_NEXT);
handleSingleClick(KEY_NEXT);
} else if (ev == BUTTON_EVENT_LONG_PRESS) {
c = handleLongPress(KEY_ENTER);
handleLongPress(KEY_ENTER);
} else if (ev == BUTTON_EVENT_DOUBLE_CLICK) {
c = handleDoubleClick(KEY_PREV);
handleDoubleClick(KEY_PREV);
} else if (ev == BUTTON_EVENT_TRIPLE_CLICK) {
c = handleTripleClick(KEY_SELECT);
handleTripleClick(KEY_SELECT);
}
#endif
#if defined(PIN_USER_BTN_ANA)
ev = analog_btn.check();
if (ev == BUTTON_EVENT_CLICK) {
c = checkDisplayOn(KEY_NEXT);
handleSingleClick(KEY_NEXT);
} else if (ev == BUTTON_EVENT_LONG_PRESS) {
c = handleLongPress(KEY_ENTER);
handleLongPress(KEY_ENTER);
} else if (ev == BUTTON_EVENT_DOUBLE_CLICK) {
c = handleDoubleClick(KEY_PREV);
handleDoubleClick(KEY_PREV);
} else if (ev == BUTTON_EVENT_TRIPLE_CLICK) {
c = handleTripleClick(KEY_SELECT);
handleTripleClick(KEY_SELECT);
}
#endif
#if defined(DISP_BACKLIGHT) && defined(BACKLIGHT_BTN)
Expand All @@ -719,12 +718,6 @@ void UITask::loop() {
}
#endif

if (c != 0 && curr) {
curr->handleInput(c);
_auto_off = millis() + AUTO_OFF_MILLIS; // extend auto-off timer
_next_refresh = 100; // trigger refresh
}

userLedHandler();

#ifdef PIN_BUZZER
Expand Down Expand Up @@ -789,38 +782,56 @@ void UITask::loop() {
#endif
}

char UITask::checkDisplayOn(char c) {
bool UITask::checkDisplayOn() {
// ensures that the display is on and the timer is reset
// returns false if the display was previously off
bool display_on = false;
if (_display != NULL) {
if (!_display->isOn()) {
_display->turnOn(); // turn display on and consume event
c = 0;
_display->turnOn(); // turn display on
} else {
display_on = true;
}
_auto_off = millis() + AUTO_OFF_MILLIS; // extend auto-off timer
_auto_off = millis() + AUTO_OFF_MILLIS; // extend auto-off timer
_next_refresh = 0; // trigger refresh
}
return c;
return display_on;
}

char UITask::handleLongPress(char c) {
if (millis() - ui_started_at < 8000) { // long press in first 8 seconds since startup -> CLI/rescue
void UITask::handleLongPress(char c) {
if (millis() - ui_started_at < 8000) { // long press in first 8 seconds since startup -> CLI/rescue
the_mesh.enterCLIRescue();
c = 0; // consume event
} else {
MESH_DEBUG_PRINTLN("UITask: long press triggered");
uiHandleKey(c);
}
return c;
}

char UITask::handleDoubleClick(char c) {
void UITask::handleSingleClick(char c) {
MESH_DEBUG_PRINTLN("UITask: single click triggered");
uiHandleKey(c);
}

void UITask::handleDoubleClick(char c) {
MESH_DEBUG_PRINTLN("UITask: double click triggered");
checkDisplayOn(c);
return c;
uiHandleKey(c);
}

char UITask::handleTripleClick(char c) {
void UITask::handleTripleClick(char c) {
MESH_DEBUG_PRINTLN("UITask: triple click triggered");
checkDisplayOn(c);
toggleBuzzer();
c = 0;
return c;
if (!uiHandleKey(c)) toggleBuzzer();
}

bool UITask::uiHandleKey(char c) {
bool handled = false;
bool display_on = checkDisplayOn();

if (c != 0 && display_on && curr) {
handled = curr->handleInput(c);
_auto_off = millis() + AUTO_OFF_MILLIS; // extend auto-off timer
_next_refresh = 100; // trigger refresh
}
return handled;
}

bool UITask::getGPSState() {
Expand Down
10 changes: 6 additions & 4 deletions examples/companion_radio/ui-new/UITask.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,12 @@ class UITask : public AbstractUITask {
void userLedHandler();

// Button action handlers
char checkDisplayOn(char c);
char handleLongPress(char c);
char handleDoubleClick(char c);
char handleTripleClick(char c);
bool checkDisplayOn();
void handleLongPress(char c);
void handleSingleClick(char c);
void handleDoubleClick(char c);
void handleTripleClick(char c);
bool uiHandleKey(char c);

void setCurrScreen(UIScreen* c);

Expand Down