InkHUD refactoring (#6216)

* chore: todo.txt * chore: comments * fix: no fast refresh on VME290 Reverts a line of code which was accidentally committed * refactor: god class Divide the behavior from the old WindowManager class into several subclasses which each have a clear role. * refactor: cppcheck medium warnings Enough to pass github CI for now * refactor: updateType selection * refactor: don't use a setter for the shared AppletFonts * fix: update prioritization forceUpdate calls weren't being prioritized * refactor: remove unhelpful logging getTimeString is used for parsing our own time, but also the timestamps of messages. The "one time only" log printing will likely fire in unhelpful situations. * fix: " " * refactor: get rid of types.h file for enums * Keep that sneaky todo file out of commits
2025-03-06 11:25:41 +01:00
parent b2ef92a328
commit e6a98b1d6b
70 changed files with 2381 additions and 1955 deletions
@@ -0,0 +1,110 @@
+#ifdef MESHTASTIC_INCLUDE_INKHUD
+
+/*
+
+    InkHUD's main class
+    - singleton
+    - mediator between the various components
+
+*/
+
+#pragma once
+
+#include "configuration.h"
+
+#include "graphics/niche/Drivers/EInk/EInk.h"
+
+#include "./AppletFont.h"
+
+#include <vector>
+
+namespace NicheGraphics::InkHUD
+{
+
+// Color, understood by display controller IC (as bit values)
+// Also suitable for use as AdafruitGFX colors
+enum Color : uint8_t {
+    BLACK = 0,
+    WHITE = 1,
+};
+
+class Applet;
+class Events;
+class Persistence;
+class Renderer;
+class SystemApplet;
+class Tile;
+class WindowManager;
+
+class InkHUD
+{
+  public:
+    static InkHUD *getInstance(); // Access to this singleton class
+
+    // Configuration
+    // - before InkHUD::begin, in variant nicheGraphics.h,
+
+    void setDriver(Drivers::EInk *driver);
+    void setDisplayResilience(uint8_t fastPerFull = 5, float stressMultiplier = 2.0);
+    void addApplet(const char *name, Applet *a, bool defaultActive = false, bool defaultAutoshow = false, uint8_t onTile = -1);
+
+    void begin();
+
+    // Handle user-button press
+    // - connected to an input source, in variant nicheGraphics.h
+
+    void shortpress();
+    void longpress();
+
+    // Trigger UI changes
+    // - called by various InkHUD components
+    // - suitable(?) for use by aux button, connected in variant nicheGraphics.h
+
+    void nextApplet();
+    void openMenu();
+    void nextTile();
+    void rotate();
+    void toggleBatteryIcon();
+
+    // Updating the display
+    // - called by various InkHUD components
+
+    void requestUpdate();
+    void forceUpdate(Drivers::EInk::UpdateTypes type = Drivers::EInk::UpdateTypes::UNSPECIFIED, bool async = true);
+    void awaitUpdate();
+
+    // (Re)configuring WindowManager
+
+    void autoshow();              // Bring an applet to foreground
+    void updateAppletSelection(); // Change which applets are active
+    void updateLayout();          // Change multiplexing (count, rotation)
+
+    // Information passed between components
+
+    uint16_t width();                    // From E-Ink driver
+    uint16_t height();                   // From E-Ink driver
+    std::vector<Tile *> getEmptyTiles(); // From WindowManager
+
+    // Applets
+
+    SystemApplet *getSystemApplet(const char *name);
+    std::vector<Applet *> userApplets;
+    std::vector<SystemApplet *> systemApplets;
+
+    // Pass drawing output to Renderer
+    void drawPixel(int16_t x, int16_t y, Color c);
+
+    // Shared data which persists between boots
+    Persistence *persistence = nullptr;
+
+  private:
+    InkHUD() {} // Constructor made private to force use of InkHUD::getInstance
+
+    Events *events = nullptr;               // Handle non-specific firmware events
+    Renderer *renderer = nullptr;           // Co-ordinate display updates
+    WindowManager *windowManager = nullptr; // Multiplexing of applets
+};
+
+} // namespace NicheGraphics::InkHUD
+
+#endif