mirror of
https://github.com/alexhopeoconnor/firmware.git
synced 2026-10-18 17:31:42 +10:00
7bbfe99fbe
* Added keyboard option to menu. Shows a keyboard layout but does not type. * Keyboard types into text box and wraps. * send FreeText messages from the send submenu - renamed `KEYBOARD` action to `FREE_TEXT` and moved its menu location to the send submenu - opening the FreeText applet from the menu keeps the menu open and disabled the timeout - the FreeText applet writes to inkhud->freetext - the sending a canned message checks inkhud->freetext and if it isn't empty, sends and clears the inkhud->freetext * Text scrolls along with input * handle free text message completion as an event implements `handleFreeText` and `OnFreeText()` for system applets to interface with the FreeText Applet The FreeText Applet generates an `OnFreeText` event when completing a message which is handled by the first system applet with the `handleFreeText` flag set to true. The Menu Applet now handles this event. * call `onFreeText` whenever the FreeText Applet exits allows the menu to consistently restart its auto-close timeout * Add text cursor * Change UI to remove the header and make text box longer Keyboard displays captial letters for legibility Keyboard types captial letters with long press * center FreeText keys and draw symbolic buttons Move input field and keyboard drawing to their own functions: - `drawInputField()` - `drawKeyboard()` Store the keys in a 1-dimensional array Implement a matching array, `keyWidths`, to set key widths relative to the font size * Add character limit and counter * Fix softlock when hitting character limit * Move text box as its own menu page * rework FreeTextApplet into KeyboardApplet - The Keyboard Applet renders an on-screen keyboard at the lower portion of the screen. - Calling `inkhud->openKeyboard()` sends all the user applets to the background and resizes the first system applet with `handleFreeText` set to True to fit above the on-screen keyboard - `inkhud->closeKeyboard()` reverses this layout change * Fix input box rendering and add character limit to menu free text * remove FREE_TEXT menu page and use the FREE_TEXT menu action solely * force update when changing the free text message * reorganize KeyboardApplet - add comments after each row of `key[]` and `keyWidths[]` to preserve formatting - The selected key is now set using the key index directly - rowWidths are pre-calculated in the KeyboardApplet constructor - removed `drawKeyboard()` and implemented `drawKeyLabel()` * implement `Renderer::clearTile()` to clear the region below a tile * add parameter to forceUpdate() for re-rendering the full screen setting the `all` parameter to true in `inkhud->forceUpdate()` now causes the full screen buffer to clear an re-render. This is helpful for when sending applets to the background and the UI needs a clean canvas. System Applets can now set the `alwaysRender` flag true which causes it to re-render on every screen update. This is set to true in the Battery Icon Applet. * clean up tile clearing loops * implement dirty rendering to let applets draw over their previous render - `Applet::requestUpdate()` now has an optional flag to keep the old canvas - If honored, the renderer calls `render(true)` which runs `onDirtyRender()` instead of `onRender()` for said applet - The renderer will not call a dirty render if the full screen is getting re-rendered * simplify arithmetic in clearTile for better understanding * combine Applet::onRender() and Applet::onDirtyRender() into Applet::onRender(bool full) - add new `full` parameter to onRender() in every applet. This parameter can be ignored by most applets. - `Applet::requestUpdate()` has an optional flag that requests a full render by default * implement tile and partial rendering in KeyboardApplet * add comment for drawKeyLabel() * improve clarity of byte operations in clearTile() * remove typo and commented code * fix inaccurate comments * add null check to openKeyboard() and closeKeyboard() --------- Co-authored-by: zeropt <ferr0fluidmann@gmail.com> Co-authored-by: HarukiToreda <116696711+HarukiToreda@users.noreply.github.com>
86 lines
2.9 KiB
C++
86 lines
2.9 KiB
C++
#ifdef MESHTASTIC_INCLUDE_INKHUD
|
|
|
|
#pragma once
|
|
|
|
/*
|
|
|
|
Handles non-specific events for InkHUD
|
|
|
|
Individual applets are responsible for listening for their own events via the module api etc,
|
|
however this class handles general events which concern InkHUD as a whole, e.g. shutdown
|
|
|
|
*/
|
|
|
|
#include "configuration.h"
|
|
|
|
#include "modules/AdminModule.h"
|
|
|
|
#include "./InkHUD.h"
|
|
#include "./Persistence.h"
|
|
|
|
namespace NicheGraphics::InkHUD
|
|
{
|
|
|
|
class Events
|
|
{
|
|
public:
|
|
Events();
|
|
void begin();
|
|
|
|
void onButtonShort(); // User button: short press
|
|
void onButtonLong(); // User button: long press
|
|
void applyingChanges();
|
|
void onExitShort(); // Exit button: short press
|
|
void onExitLong(); // Exit button: long press
|
|
void onNavUp(); // Navigate up
|
|
void onNavDown(); // Navigate down
|
|
void onNavLeft(); // Navigate left
|
|
void onNavRight(); // Navigate right
|
|
|
|
// Free text typing events
|
|
void onFreeText(char c); // New freetext character input
|
|
void onFreeTextDone();
|
|
void onFreeTextCancel();
|
|
|
|
int beforeDeepSleep(void *unused); // Prepare for shutdown
|
|
int beforeReboot(void *unused); // Prepare for reboot
|
|
int onReceiveTextMessage(const meshtastic_MeshPacket *packet); // Store most recent text message
|
|
int onAdminMessage(AdminModule_ObserverData *data); // Handle incoming admin messages
|
|
#ifdef ARCH_ESP32
|
|
int beforeLightSleep(void *unused); // Prepare for light sleep
|
|
#endif
|
|
|
|
private:
|
|
// For convenience
|
|
InkHUD *inkhud = nullptr;
|
|
Persistence::Settings *settings = nullptr;
|
|
|
|
// Get notified when the system is shutting down
|
|
CallbackObserver<Events, void *> deepSleepObserver = CallbackObserver<Events, void *>(this, &Events::beforeDeepSleep);
|
|
|
|
// Get notified when the system is rebooting
|
|
CallbackObserver<Events, void *> rebootObserver = CallbackObserver<Events, void *>(this, &Events::beforeReboot);
|
|
|
|
// Cache *incoming* text messages, for use by applets
|
|
CallbackObserver<Events, const meshtastic_MeshPacket *> textMessageObserver =
|
|
CallbackObserver<Events, const meshtastic_MeshPacket *>(this, &Events::onReceiveTextMessage);
|
|
|
|
// Get notified of incoming admin messages, and handle any which are relevant to InkHUD
|
|
CallbackObserver<Events, AdminModule_ObserverData *> adminMessageObserver =
|
|
CallbackObserver<Events, AdminModule_ObserverData *>(this, &Events::onAdminMessage);
|
|
|
|
#ifdef ARCH_ESP32
|
|
// Get notified when the system is entering light sleep
|
|
CallbackObserver<Events, void *> lightSleepObserver = CallbackObserver<Events, void *>(this, &Events::beforeLightSleep);
|
|
#endif
|
|
|
|
// End any externalNotification beeping, buzzing, blinking etc
|
|
bool dismissExternalNotification();
|
|
|
|
// If set, InkHUD's data will be erased during onReboot
|
|
bool eraseOnReboot = false;
|
|
};
|
|
|
|
} // namespace NicheGraphics::InkHUD
|
|
|
|
#endif |