Adding support for InkHUD joystick navigation for the Seeed Wio Tracker L1 E-ink (#8678)

* TwoButtonExtened mirrors TwoButton but added joystick functionality

* basic ui navigation with a joystick

settings->joystick.enabled setting added and SETTINGS_VERSION
incremented by one in InkHUD/Persistence.h

in seeed_wio_tracker_L1_eink/nicheGraphics.h enable joystick and
disable "Next Tile" menu item in

implement prevTile and prevApplet functions in
InkHUD/WindowManager.h,cpp and InkHUD/InkHUD.h,cpp

onStickCenterShort, onStickCenterLong, onStickUp, onStickDown,
onStickLeft, and onStickRight functions added to:
- InkHUD/InkHUD.h,cpp
- InkHUD/Events.h,cpp
- InkHUD/Applet.h

change navigation actions in InkHUD/Events.cpp events based on
whether the joystick is enabled or not

in seeed_wio_tracker_L1_eink/nicheGraphics.h connect joystick events to
the new joystick handler functions

* handle joystick input in NotificationApplet and TipsApplet

Both the joystick center short press and the user button short press can
be used to advance through the Tips applet.

dismiss notifications with any joystick input

* MenuApplet controls
allows menu navigation including a back button

* add AlignStickApplet for aligning the joystick with the screen

add joystick.aligned and joystick.alignment to InkHUD/Persistence.h for
storing alignment status and relative angle

create AlignStick applet that prompts the user for a joystick input and
rotates the controls to align with the screen

AlignStick applet is run after the tips applet if the joystick is
enabled and not aligned

add menu item for opening the AlignStick applet

* update tips applet with joystick controls

* format InkHUD additions

* fix stroke consistency when resizing joystick graphic

* tweak button tips for order consistency

* increase joystick debounce

* fix comments

* remove unnecessary '+'

* remap joystick controls to match standard inkHUD behavior

Input with a joystick now behaves as follows

User Button (joystick center):
- short press in applet -> opens menu
- long press in applet -> opens menu
- short press in menu -> selects
- long press in menu -> selects

Exit Button:
- short press in applet -> switches tile
- long press in applet -> nothing for now
- short press in menu -> closes menu
- long press in menu -> nothing for now

---------

Co-authored-by: scobert <scobert57@gmail.com>
Co-authored-by: HarukiToreda <116696711+HarukiToreda@users.noreply.github.com>

src/graphics/niche/InkHUD/WindowManager.cpp

@@ -2,6 +2,7 @@
 
 #include "./WindowManager.h"
 
+#include "./Applets/System/AlignStick/AlignStickApplet.h"
 #include "./Applets/System/BatteryIcon/BatteryIconApplet.h"
 #include "./Applets/System/Logo/LogoApplet.h"
 #include "./Applets/System/Menu/MenuApplet.h"
@@ -98,6 +99,38 @@ void InkHUD::WindowManager::nextTile()
         userTiles.at(settings->userTiles.focused)->requestHighlight();
 }
 
+// Focus on a different tile but decrement index
+void InkHUD::WindowManager::prevTile()
+{
+    // Close the menu applet if open
+    // We don't *really* want to do this, but it simplifies handling *a lot*
+    MenuApplet *menu = (MenuApplet *)inkhud->getSystemApplet("Menu");
+    bool menuWasOpen = false;
+    if (menu->isForeground()) {
+        menu->sendToBackground();
+        menuWasOpen = true;
+    }
+
+    // Swap to next tile
+    if (settings->userTiles.focused == 0)
+        settings->userTiles.focused = settings->userTiles.count - 1;
+    else
+        settings->userTiles.focused--;
+
+    // Make sure that we don't get stuck on the placeholder tile
+    refocusTile();
+
+    if (menuWasOpen)
+        menu->show(userTiles.at(settings->userTiles.focused));
+
+    // Ask the tile to draw an indicator showing which tile is now focused
+    // Requests a render
+    // We only draw this indicator if the device uses an aux button to switch tiles.
+    // Assume aux button is used to switch tiles if the "next tile" menu item is hidden
+    if (!settings->optionalMenuItems.nextTile)
+        userTiles.at(settings->userTiles.focused)->requestHighlight();
+}
+
 // Show the menu (on the the focused tile)
 // The applet previously displayed there will be restored once the menu closes
 void InkHUD::WindowManager::openMenu()
@@ -106,6 +139,15 @@ void InkHUD::WindowManager::openMenu()
     menu->show(userTiles.at(settings->userTiles.focused));
 }
 
+// Bring the AlignStick applet to the foreground
+void InkHUD::WindowManager::openAlignStick()
+{
+    if (settings->joystick.enabled) {
+        AlignStickApplet *alignStick = (AlignStickApplet *)inkhud->getSystemApplet("AlignStick");
+        alignStick->bringToForeground();
+    }
+}
+
 // On the currently focussed tile: cycle to the next available user applet
 // Applets available for this must be activated, and not already displayed on another tile
 void InkHUD::WindowManager::nextApplet()
@@ -155,6 +197,59 @@ void InkHUD::WindowManager::nextApplet()
     inkhud->forceUpdate(EInk::UpdateTypes::FAST); // bringToForeground already requested, but we're manually forcing FAST
 }
 
+// On the currently focussed tile: cycle to the previous available user applet
+// Applets available for this must be activated, and not already displayed on another tile
+void InkHUD::WindowManager::prevApplet()
+{
+    Tile *t = userTiles.at(settings->userTiles.focused);
+
+    // Abort if zero applets available
+    // nullptr means WindowManager::refocusTile determined that there were no available applets
+    if (!t->getAssignedApplet())
+        return;
+
+    // Find the index of the applet currently shown on the tile
+    uint8_t appletIndex = -1;
+    for (uint8_t i = 0; i < inkhud->userApplets.size(); i++) {
+        if (inkhud->userApplets.at(i) == t->getAssignedApplet()) {
+            appletIndex = i;
+            break;
+        }
+    }
+
+    // Confirm that we did find the applet
+    assert(appletIndex != (uint8_t)-1);
+
+    // Iterate forward through the WindowManager::applets, looking for the previous valid applet
+    Applet *prevValidApplet = nullptr;
+    for (uint8_t i = 1; i < inkhud->userApplets.size(); i++) {
+        uint8_t newAppletIndex = 0;
+        if (i > appletIndex)
+            newAppletIndex = inkhud->userApplets.size() + appletIndex - i;
+        else
+            newAppletIndex = (appletIndex - i);
+        Applet *a = inkhud->userApplets.at(newAppletIndex);
+
+        // Looking for an applet which is active (enabled by user), but currently in background
+        if (a->isActive() && !a->isForeground()) {
+            prevValidApplet = a;
+            settings->userTiles.displayedUserApplet[settings->userTiles.focused] =
+                newAppletIndex; // Remember this setting between boots!
+            break;
+        }
+    }
+
+    // Confirm that we found another applet
+    if (!prevValidApplet)
+        return;
+
+    // Hide old applet, show new applet
+    t->getAssignedApplet()->sendToBackground();
+    t->assignApplet(prevValidApplet);
+    prevValidApplet->bringToForeground();
+    inkhud->forceUpdate(EInk::UpdateTypes::FAST); // bringToForeground already requested, but we're manually forcing FAST
+}
+
 // Rotate the display image by 90 degrees
 void InkHUD::WindowManager::rotate()
 {
@@ -338,6 +433,8 @@ void InkHUD::WindowManager::createSystemApplets()
     addSystemApplet("Logo", new LogoApplet, new Tile);
     addSystemApplet("Pairing", new PairingApplet, new Tile);
     addSystemApplet("Tips", new TipsApplet, new Tile);
+    if (settings->joystick.enabled)
+        addSystemApplet("AlignStick", new AlignStickApplet, new Tile);
 
     addSystemApplet("Menu", new MenuApplet, nullptr);
 
@@ -360,6 +457,8 @@ void InkHUD::WindowManager::placeSystemTiles()
     inkhud->getSystemApplet("Logo")->getTile()->setRegion(0, 0, inkhud->width(), inkhud->height());
     inkhud->getSystemApplet("Pairing")->getTile()->setRegion(0, 0, inkhud->width(), inkhud->height());
     inkhud->getSystemApplet("Tips")->getTile()->setRegion(0, 0, inkhud->width(), inkhud->height());
+    if (settings->joystick.enabled)
+        inkhud->getSystemApplet("AlignStick")->getTile()->setRegion(0, 0, inkhud->width(), inkhud->height());
 
     inkhud->getSystemApplet("Notification")->getTile()->setRegion(0, 0, inkhud->width(), 20);