Merge branch 'develop' into InkHUD-Improvements

src/graphics/niche/InkHUD/Applets/System/AlignStick/AlignStickApplet.cpp

@@ -0,0 +1,205 @@
+#ifdef MESHTASTIC_INCLUDE_INKHUD
+
+#include "./AlignStickApplet.h"
+
+using namespace NicheGraphics;
+
+InkHUD::AlignStickApplet::AlignStickApplet()
+{
+    if (!settings->joystick.aligned)
+        bringToForeground();
+}
+
+void InkHUD::AlignStickApplet::onRender()
+{
+    setFont(fontMedium);
+    printAt(0, 0, "Align Joystick:");
+    setFont(fontSmall);
+    std::string instructions = "Move joystick in the direction indicated";
+    printWrapped(0, fontMedium.lineHeight() * 1.5, width(), instructions);
+
+    // Size of the region in which the joystick graphic should fit
+    uint16_t joyXLimit = X(0.8);
+    uint16_t contentH = fontMedium.lineHeight() * 1.5 + fontSmall.lineHeight() * 1;
+    if (getTextWidth(instructions) > width())
+        contentH += fontSmall.lineHeight();
+    uint16_t freeY = height() - contentH - fontSmall.lineHeight() * 1.2;
+    uint16_t joyYLimit = freeY * 0.8;
+
+    // Use the shorter of the two
+    uint16_t joyWidth = joyXLimit < joyYLimit ? joyXLimit : joyYLimit;
+
+    // Center the joystick graphic
+    uint16_t centerX = X(0.5);
+    uint16_t centerY = contentH + freeY * 0.5;
+
+    // Draw joystick graphic
+    drawStick(centerX, centerY, joyWidth);
+
+    setFont(fontSmall);
+    printAt(X(0.5), Y(1.0) - fontSmall.lineHeight() * 0.2, "Long press to skip", CENTER, BOTTOM);
+}
+
+// Draw a scalable joystick graphic
+void InkHUD::AlignStickApplet::drawStick(uint16_t centerX, uint16_t centerY, uint16_t width)
+{
+    if (width < 9) // too small to draw
+        return;
+
+    else if (width < 40) { // only draw up arrow
+        uint16_t chamfer = width < 20 ? 1 : 2;
+
+        // Draw filled up arrow
+        drawDirection(centerX, centerY - width / 4, Direction::UP, width, chamfer, BLACK);
+
+    } else { // large enough to draw the full thing
+        uint16_t chamfer = width < 80 ? 1 : 2;
+        uint16_t stroke = 3; // pixels
+        uint16_t arrowW = width * 0.22;
+        uint16_t hollowW = arrowW - stroke * 2;
+
+        // Draw center circle
+        fillCircle((int16_t)centerX, (int16_t)centerY, (int16_t)(width * 0.2), BLACK);
+        fillCircle((int16_t)centerX, (int16_t)centerY, (int16_t)(width * 0.2) - stroke, WHITE);
+
+        // Draw filled up arrow
+        drawDirection(centerX, centerY - width / 2, Direction::UP, arrowW, chamfer, BLACK);
+
+        // Draw down arrow
+        drawDirection(centerX, centerY + width / 2, Direction::DOWN, arrowW, chamfer, BLACK);
+        drawDirection(centerX, centerY + width / 2 - stroke, Direction::DOWN, hollowW, 0, WHITE);
+
+        // Draw left arrow
+        drawDirection(centerX - width / 2, centerY, Direction::LEFT, arrowW, chamfer, BLACK);
+        drawDirection(centerX - width / 2 + stroke, centerY, Direction::LEFT, hollowW, 0, WHITE);
+
+        // Draw right arrow
+        drawDirection(centerX + width / 2, centerY, Direction::RIGHT, arrowW, chamfer, BLACK);
+        drawDirection(centerX + width / 2 - stroke, centerY, Direction::RIGHT, hollowW, 0, WHITE);
+    }
+}
+
+// Draw a scalable joystick direction arrow
+// a right-triangle with blunted tips
+/*
+            _ <--point
+    ^      / \
+    |     /   \
+   size  /     \
+    |   /       \
+    v  |_________|
+
+*/
+void InkHUD::AlignStickApplet::drawDirection(uint16_t pointX, uint16_t pointY, Direction direction, uint16_t size,
+                                             uint16_t chamfer, Color color)
+{
+    uint16_t chamferW = chamfer * 2 + 1;
+    uint16_t triangleW = size - chamferW;
+
+    // Draw arrow
+    switch (direction) {
+    case Direction::UP:
+        fillRect(pointX - chamfer, pointY, chamferW, triangleW, color);
+        fillRect(pointX - chamfer - triangleW, pointY + triangleW, chamferW + triangleW * 2, chamferW, color);
+        fillTriangle(pointX - chamfer, pointY, pointX - chamfer - triangleW, pointY + triangleW, pointX - chamfer,
+                     pointY + triangleW, color);
+        fillTriangle(pointX + chamfer, pointY, pointX + chamfer + triangleW, pointY + triangleW, pointX + chamfer,
+                     pointY + triangleW, color);
+        break;
+    case Direction::DOWN:
+        fillRect(pointX - chamfer, pointY - triangleW + 1, chamferW, triangleW, color);
+        fillRect(pointX - chamfer - triangleW, pointY - size + 1, chamferW + triangleW * 2, chamferW, color);
+        fillTriangle(pointX - chamfer, pointY, pointX - chamfer - triangleW, pointY - triangleW, pointX - chamfer,
+                     pointY - triangleW, color);
+        fillTriangle(pointX + chamfer, pointY, pointX + chamfer + triangleW, pointY - triangleW, pointX + chamfer,
+                     pointY - triangleW, color);
+        break;
+    case Direction::LEFT:
+        fillRect(pointX, pointY - chamfer, triangleW, chamferW, color);
+        fillRect(pointX + triangleW, pointY - chamfer - triangleW, chamferW, chamferW + triangleW * 2, color);
+        fillTriangle(pointX, pointY - chamfer, pointX + triangleW, pointY - chamfer - triangleW, pointX + triangleW,
+                     pointY - chamfer, color);
+        fillTriangle(pointX, pointY + chamfer, pointX + triangleW, pointY + chamfer + triangleW, pointX + triangleW,
+                     pointY + chamfer, color);
+        break;
+    case Direction::RIGHT:
+        fillRect(pointX - triangleW + 1, pointY - chamfer, triangleW, chamferW, color);
+        fillRect(pointX - size + 1, pointY - chamfer - triangleW, chamferW, chamferW + triangleW * 2, color);
+        fillTriangle(pointX, pointY - chamfer, pointX - triangleW, pointY - chamfer - triangleW, pointX - triangleW,
+                     pointY - chamfer, color);
+        fillTriangle(pointX, pointY + chamfer, pointX - triangleW, pointY + chamfer + triangleW, pointX - triangleW,
+                     pointY + chamfer, color);
+        break;
+    }
+}
+
+void InkHUD::AlignStickApplet::onForeground()
+{
+    // Prevent most other applets from requesting update, and skip their rendering entirely
+    // Another system applet with a higher precedence can potentially ignore this
+    SystemApplet::lockRendering = true;
+    SystemApplet::lockRequests = true;
+
+    handleInput = true; // Intercept the button input for our applet
+}
+
+void InkHUD::AlignStickApplet::onBackground()
+{
+    // Allow normal update behavior to resume
+    SystemApplet::lockRendering = false;
+    SystemApplet::lockRequests = false;
+    SystemApplet::handleInput = false;
+
+    // Need to force an update, as a polite request wouldn't be honored, seeing how we are now in the background
+    // Usually, onBackground is followed by another applet's onForeground (which requests update), but not in this case
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::AlignStickApplet::onButtonLongPress()
+{
+    sendToBackground();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::AlignStickApplet::onExitLong()
+{
+    sendToBackground();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::AlignStickApplet::onNavUp()
+{
+    settings->joystick.aligned = true;
+
+    sendToBackground();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::AlignStickApplet::onNavDown()
+{
+    inkhud->rotateJoystick(2); // 180 deg
+    settings->joystick.aligned = true;
+
+    sendToBackground();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::AlignStickApplet::onNavLeft()
+{
+    inkhud->rotateJoystick(3); // 270 deg
+    settings->joystick.aligned = true;
+
+    sendToBackground();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::AlignStickApplet::onNavRight()
+{
+    inkhud->rotateJoystick(1); // 90 deg
+    settings->joystick.aligned = true;
+
+    sendToBackground();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+#endif

src/graphics/niche/InkHUD/Applets/System/AlignStick/AlignStickApplet.h

@@ -0,0 +1,50 @@
+#ifdef MESHTASTIC_INCLUDE_INKHUD
+
+/*
+
+System Applet for manually aligning the joystick with the screen
+
+should be run at startup if the joystick is enabled
+and not aligned to the screen
+
+*/
+
+#pragma once
+
+#include "configuration.h"
+
+#include "graphics/niche/InkHUD/SystemApplet.h"
+
+namespace NicheGraphics::InkHUD
+{
+
+class AlignStickApplet : public SystemApplet
+{
+  public:
+    AlignStickApplet();
+
+    void onRender() override;
+    void onForeground() override;
+    void onBackground() override;
+    void onButtonLongPress() override;
+    void onExitLong() override;
+    void onNavUp() override;
+    void onNavDown() override;
+    void onNavLeft() override;
+    void onNavRight() override;
+
+  protected:
+    enum Direction {
+        UP,
+        DOWN,
+        LEFT,
+        RIGHT,
+    };
+
+    void drawStick(uint16_t centerX, uint16_t centerY, uint16_t width);
+    void drawDirection(uint16_t pointX, uint16_t pointY, Direction direction, uint16_t size, uint16_t chamfer, Color color);
+};
+
+} // namespace NicheGraphics::InkHUD
+
+#endif

src/graphics/niche/InkHUD/Applets/System/Menu/MenuAction.h

@@ -31,6 +31,7 @@ enum MenuAction {
     TOGGLE_AUTOSHOW_APPLET,
     SET_RECENTS,
     ROTATE,
+    ALIGN_JOYSTICK,
     LAYOUT,
     TOGGLE_BATTERY_ICON,
     TOGGLE_NOTIFICATIONS,

src/graphics/niche/InkHUD/Applets/System/Menu/MenuApplet.cpp

@@ -362,6 +362,10 @@ void InkHUD::MenuApplet::execute(MenuItem item)
         inkhud->rotate();
         break;
 
+    case ALIGN_JOYSTICK:
+        inkhud->openAlignStick();
+        break;
+
     case LAYOUT:
         // Todo: smarter incrementing of tile count
         settings->userTiles.count++;
@@ -826,14 +830,17 @@ void InkHUD::MenuApplet::showPage(MenuPage page)
         items.push_back(MenuItem("Node Config", MenuPage::NODE_CONFIG));
         items.push_back(MenuItem("Save & Shut Down", MenuAction::SHUTDOWN));
         items.push_back(MenuItem("Exit", MenuPage::EXIT));
+        previousPage = MenuPage::EXIT;
         break;
 
     case SEND:
         populateSendPage();
+        previousPage = MenuPage::ROOT;
         break;
 
     case CANNEDMESSAGE_RECIPIENT:
         populateRecipientPage();
+        previousPage = MenuPage::OPTIONS;
         break;
 
     case OPTIONS:
@@ -852,6 +859,8 @@ void InkHUD::MenuApplet::showPage(MenuPage page)
         if (settings->userTiles.maxCount > 1)
             items.push_back(MenuItem("Layout", MenuAction::LAYOUT, MenuPage::OPTIONS));
         items.push_back(MenuItem("Rotate", MenuAction::ROTATE, MenuPage::OPTIONS));
+        if (settings->joystick.enabled)
+            items.push_back(MenuItem("Align Joystick", MenuAction::ALIGN_JOYSTICK, MenuPage::EXIT));
         items.push_back(MenuItem("Notifications", MenuAction::TOGGLE_NOTIFICATIONS, MenuPage::OPTIONS,
                                  &settings->optionalFeatures.notifications));
         items.push_back(MenuItem("Battery Icon", MenuAction::TOGGLE_BATTERY_ICON, MenuPage::OPTIONS,
@@ -859,18 +868,21 @@ void InkHUD::MenuApplet::showPage(MenuPage page)
         invertedColors = (config.display.displaymode == meshtastic_Config_DisplayConfig_DisplayMode_INVERTED);
         items.push_back(MenuItem("Invert Color", MenuAction::TOGGLE_INVERT_COLOR, MenuPage::OPTIONS, &invertedColors));
         items.push_back(MenuItem("Exit", MenuPage::EXIT));
+        previousPage = MenuPage::ROOT;
         break;
 
     case APPLETS:
         populateAppletPage(); // must be first
         items.insert(items.begin(), MenuItem("Back", MenuAction::BACK, MenuPage::OPTIONS));
         items.push_back(MenuItem("Exit", MenuPage::EXIT));
+        previousPage = MenuPage::OPTIONS;
         break;
 
     case AUTOSHOW:
         populateAutoshowPage(); // must be first
         items.insert(items.begin(), MenuItem("Back", MenuAction::BACK, MenuPage::OPTIONS));
         items.push_back(MenuItem("Exit", MenuPage::EXIT));
+        previousPage = MenuPage::OPTIONS;
         break;
 
     case RECENTS:
@@ -1408,15 +1420,21 @@ void InkHUD::MenuApplet::onButtonShortPress()
     // Push the auto-close timer back
     OSThread::setIntervalFromNow(MENU_TIMEOUT_SEC * 1000UL);
 
-    // Move menu cursor to next entry, then update
-    if (!cursorShown) {
-        cursorShown = true;
-    } else {
-        do {
+    if (!settings->joystick.enabled) {
+        // Move menu cursor to next entry, then update
+        if (cursorShown)
             cursor = (cursor + 1) % items.size();
-        } while (items.at(cursor).isHeader);
+        else
+            cursorShown = true;
+        requestUpdate(Drivers::EInk::UpdateTypes::FAST);
+    } else {
+        if (cursorShown)
+            execute(items.at(cursor));
+        else
+            showPage(MenuPage::EXIT);
+        if (!wantsToRender())
+            requestUpdate(Drivers::EInk::UpdateTypes::FAST);
     }
-    requestUpdate(Drivers::EInk::UpdateTypes::FAST);
 }
 
 void InkHUD::MenuApplet::onButtonLongPress()
@@ -1436,6 +1454,62 @@ void InkHUD::MenuApplet::onButtonLongPress()
         requestUpdate(Drivers::EInk::UpdateTypes::FAST);
 }
 
+void InkHUD::MenuApplet::onExitShort()
+{
+    // Exit the menu
+    showPage(MenuPage::EXIT);
+
+    requestUpdate(Drivers::EInk::UpdateTypes::FAST);
+}
+
+void InkHUD::MenuApplet::onNavUp()
+{
+    OSThread::setIntervalFromNow(MENU_TIMEOUT_SEC * 1000UL);
+
+    // Move menu cursor to previous entry, then update
+    if (cursor == 0)
+        cursor = items.size() - 1;
+    else
+        cursor--;
+
+    if (!cursorShown)
+        cursorShown = true;
+
+    requestUpdate(Drivers::EInk::UpdateTypes::FAST);
+}
+
+void InkHUD::MenuApplet::onNavDown()
+{
+    OSThread::setIntervalFromNow(MENU_TIMEOUT_SEC * 1000UL);
+
+    // Move menu cursor to next entry, then update
+    if (cursorShown)
+        cursor = (cursor + 1) % items.size();
+    else
+        cursorShown = true;
+
+    requestUpdate(Drivers::EInk::UpdateTypes::FAST);
+}
+
+void InkHUD::MenuApplet::onNavLeft()
+{
+    OSThread::setIntervalFromNow(MENU_TIMEOUT_SEC * 1000UL);
+
+    // Go to the previous menu page
+    showPage(previousPage);
+    requestUpdate(Drivers::EInk::UpdateTypes::FAST);
+}
+
+void InkHUD::MenuApplet::onNavRight()
+{
+    OSThread::setIntervalFromNow(MENU_TIMEOUT_SEC * 1000UL);
+
+    if (cursorShown)
+        execute(items.at(cursor));
+    if (!wantsToRender())
+        requestUpdate(Drivers::EInk::UpdateTypes::FAST);
+}
+
 // Dynamically create MenuItem entries for activating / deactivating Applets, for the "Applet Selection" submenu
 void InkHUD::MenuApplet::populateAppletPage()
 {
@@ -1729,4 +1803,4 @@ void InkHUD::MenuApplet::freeCannedMessageResources()
     cm.recipientItems.clear();
 }
 
-#endif
+#endif

src/graphics/niche/InkHUD/Applets/System/Menu/MenuApplet.h

@@ -27,6 +27,11 @@ class MenuApplet : public SystemApplet, public concurrency::OSThread
     void onBackground() override;
     void onButtonShortPress() override;
     void onButtonLongPress() override;
+    void onExitShort() override;
+    void onNavUp() override;
+    void onNavDown() override;
+    void onNavLeft() override;
+    void onNavRight() override;
     void onRender() override;
 
     void show(Tile *t); // Open the menu, onto a user tile
@@ -54,6 +59,7 @@ class MenuApplet : public SystemApplet, public concurrency::OSThread
 
     MenuPage startPageOverride = MenuPage::ROOT;
     MenuPage currentPage = MenuPage::ROOT;
+    MenuPage previousPage = MenuPage::EXIT;
     uint8_t cursor = 0;       // Which menu item is currently highlighted
     bool cursorShown = false; // Is *any* item highlighted? (Root menu: no initial selection)
 
@@ -106,4 +112,4 @@ class MenuApplet : public SystemApplet, public concurrency::OSThread
 
 } // namespace NicheGraphics::InkHUD
 
-#endif
+#endif

src/graphics/niche/InkHUD/Applets/System/Notification/NotificationApplet.cpp

@@ -153,6 +153,42 @@ void InkHUD::NotificationApplet::onButtonLongPress()
     inkhud->forceUpdate(EInk::UpdateTypes::FULL);
 }
 
+void InkHUD::NotificationApplet::onExitShort()
+{
+    dismiss();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::NotificationApplet::onExitLong()
+{
+    dismiss();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::NotificationApplet::onNavUp()
+{
+    dismiss();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::NotificationApplet::onNavDown()
+{
+    dismiss();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::NotificationApplet::onNavLeft()
+{
+    dismiss();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
+void InkHUD::NotificationApplet::onNavRight()
+{
+    dismiss();
+    inkhud->forceUpdate(EInk::UpdateTypes::FULL);
+}
+
 // Ask the WindowManager to check whether any displayed applets are already displaying the info from this notification
 // Called internally when we first get a "notifiable event", and then again before render,
 // in case autoshow swapped which applet was displayed

src/graphics/niche/InkHUD/Applets/System/Notification/NotificationApplet.h

@@ -31,6 +31,12 @@ class NotificationApplet : public SystemApplet
     void onBackground() override;
     void onButtonShortPress() override;
     void onButtonLongPress() override;
+    void onExitShort() override;
+    void onExitLong() override;
+    void onNavUp() override;
+    void onNavDown() override;
+    void onNavLeft() override;
+    void onNavRight() override;
 
     int onReceiveTextMessage(const meshtastic_MeshPacket *p);
 

src/graphics/niche/InkHUD/Applets/System/Tips/TipsApplet.cpp

@@ -140,6 +140,23 @@ void InkHUD::TipsApplet::onRender()
         printWrapped(0, 0, width(), title);
 
         setFont(fontSmall);
+        int16_t cursorY = fontMedium.lineHeight() * 1.5;
+
+        if (!settings->joystick.enabled) {
+            printAt(0, cursorY, "User Button");
+            cursorY += fontSmall.lineHeight() * 1.2;
+            printAt(0, cursorY, "- short press: next");
+            cursorY += fontSmall.lineHeight() * 1.2;
+            printAt(0, cursorY, "- long press: select / open menu");
+        } else {
+            printAt(0, cursorY, "Joystick");
+            cursorY += fontSmall.lineHeight() * 1.2;
+            printAt(0, cursorY, "- open menu / select");
+            cursorY += fontSmall.lineHeight() * 1.5;
+            printAt(0, cursorY, "Exit Button");
+            cursorY += fontSmall.lineHeight() * 1.2;
+            printAt(0, cursorY, "- switch tile / close menu");
+        }
         int16_t cursorY = h + fontSmall.lineHeight();
 
         auto drawBullet = [&](const char *text) {
@@ -163,14 +180,19 @@ void InkHUD::TipsApplet::onRender()
         printWrapped(0, 0, width(), title);
 
         setFont(fontSmall);
-        int16_t cursorY = h + fontSmall.lineHeight();
+        if (!settings->joystick.enabled) {
+            int16_t cursorY = h + fontSmall.lineHeight();
 
-        const char *body = "To rotate the display, use the InkHUD menu. "
+            const char *body = "To rotate the display, use the InkHUD menu. "
                            "Long-press the user button > Options > Rotate.";
 
         uint16_t bh = getWrappedTextHeight(0, width(), body);
         printWrapped(0, cursorY, width(), body);
         cursorY += bh + (fontSmall.lineHeight() / 2);
+        } else {
+            printWrapped(0, fontMedium.lineHeight() * 1.5, width(),
+                         "To rotate the display, use the InkHUD menu. Press the user button > Options > Rotate.");
+        }
 
         printAt(0, Y(1.0), "Press button to continue", LEFT, BOTTOM);
 
@@ -288,4 +310,10 @@ void InkHUD::TipsApplet::onButtonShortPress()
     }
 }
 
+// Functions the same as the user button in this instance
+void InkHUD::TipsApplet::onExitShort()
+{
+    onButtonShortPress();
+}
+
 #endif

src/graphics/niche/InkHUD/Applets/System/Tips/TipsApplet.h

@@ -37,6 +37,7 @@ class TipsApplet : public SystemApplet
     void onForeground() override;
     void onBackground() override;
     void onButtonShortPress() override;
+    void onExitShort() override;
 
   protected:
     void renderWelcome(); // Very first screen of tutorial