InkHUD DIY builds for ProMicro & Heltec T114 (#7039)

* DIY InkHUD variants (ProMicro & T114) * Fix file encoding > We’ve detected the file encoding as ISO-8859-1. When you commit changes we will transcode it to UTF-8. * Update comment justifying trunk suppression
2026-01-06 09:57:52 +00:00 · 2025-06-15 11:39:46 +12:00
parent 1557219bad
commit 425f384b1f
9 changed files with 590 additions and 19 deletions
--- a/variants/diy/nrf52_promicro_diy_tcxo/custom_build_tasks.py
+++ b/variants/diy/nrf52_promicro_diy_tcxo/custom_build_tasks.py
@@ -0,0 +1,62 @@
+# Simplifies DIY InkHUD builds, with presets for several common E-Ink displays
+# - build using custom task in Platformio's "Project Tasks" panel
+# - build with `pio run -e <variant> -t build_weact_154` (or similar)
+
+# Silence trunk's objections to the import statements
+# trunk-ignore-all(ruff/F821)
+# trunk-ignore-all(flake8/F821)
+
+from SCons.Script import COMMAND_LINE_TARGETS
+
+Import("env")
+Import("projenv")
+
+# Custom targets
+# These wrappers just run the normal build task under a different target name
+# We intercept the build later on, based on the target name
+env.AddTarget(
+    name="build_weact_154",
+    dependencies=["buildprog"],
+    actions=None,
+    title='Build (WeAct 1.54")',
+)
+env.AddTarget(
+    name="build_weact_213",
+    dependencies=["buildprog"],
+    actions=None,
+    title='Build (WeAct 2.13")',
+)
+env.AddTarget(
+    name="build_weact_290",
+    dependencies=["buildprog"],
+    actions=None,
+    title='Build (WeAct 2.9")',
+)
+env.AddTarget(
+    name="build_weact_420",
+    dependencies=["buildprog"],
+    actions=None,
+    title='Build (WeAct 4.2")',
+)
+
+# Check whether a build was started via one of our custom targets above
+
+if "build_weact_154" in COMMAND_LINE_TARGETS:
+    print('Building for WeAct 1.54" Display')
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DRIVER", "ZJY200200_0154DAAMFGN"))
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DISPLAYRESILIENCE", "15"))
+
+elif "build_weact_213" in COMMAND_LINE_TARGETS:
+    print('Building for WeAct 2.13" Display')
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DRIVER", "HINK_E0213A289"))
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DISPLAYRESILIENCE", "10"))
+
+elif "build_weact_290" in COMMAND_LINE_TARGETS:
+    print('Building for WeAct 2.9" Display')
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DRIVER", "ZJY128296_029EAAMFGN"))
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DISPLAYRESILIENCE", "15"))
+
+elif "build_weact_420" in COMMAND_LINE_TARGETS:
+    print('Building for WeAct 4.2" Display')
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DRIVER", "HINK_E042A87"))
+    projenv["CPPDEFINES"].append(("INKHUD_BUILDCONF_DISPLAYRESILIENCE", "15"))
--- a/variants/diy/nrf52_promicro_diy_tcxo/nicheGraphics.h
+++ b/variants/diy/nrf52_promicro_diy_tcxo/nicheGraphics.h
@@ -0,0 +1,94 @@
+#pragma once
+
+#include "configuration.h"
+
+#ifdef MESHTASTIC_INCLUDE_NICHE_GRAPHICS
+
+// InkHUD-specific components
+// ---------------------------
+#include "graphics/niche/InkHUD/InkHUD.h"
+
+// Applets
+#include "graphics/niche/InkHUD/Applets/User/AllMessage/AllMessageApplet.h"
+#include "graphics/niche/InkHUD/Applets/User/DM/DMApplet.h"
+#include "graphics/niche/InkHUD/Applets/User/Heard/HeardApplet.h"
+#include "graphics/niche/InkHUD/Applets/User/Positions/PositionsApplet.h"
+#include "graphics/niche/InkHUD/Applets/User/RecentsList/RecentsListApplet.h"
+#include "graphics/niche/InkHUD/Applets/User/ThreadedMessage/ThreadedMessageApplet.h"
+
+// Shared NicheGraphics components
+// --------------------------------
+#include "graphics/niche/Drivers/EInk/HINK_E0213A289.h"        // WeAct 2.13"
+#include "graphics/niche/Drivers/EInk/HINK_E042A87.h"          // WeAct 4.2"
+#include "graphics/niche/Drivers/EInk/ZJY128296_029EAAMFGN.h"  // WeAct 2.9"
+#include "graphics/niche/Drivers/EInk/ZJY200200_0154DAAMFGN.h" // WeACt 1.54"
+
+#include "graphics/niche/Inputs/TwoButton.h"
+
+#if !defined(INKHUD_BUILDCONF_DRIVER) || !defined(INKHUD_BUILDCONF_DISPLAYRESILIENCE)
+#error If not using a DIY preset, display model and resilience must be set manually
+#endif
+
+void setupNicheGraphics()
+{
+    using namespace NicheGraphics;
+
+    // SPI
+    // -----------------------------
+    SPI.begin();
+
+    // Driver
+    // -----------------------------
+
+    // Use E-Ink driver
+    Drivers::EInk *driver = new Drivers::INKHUD_BUILDCONF_DRIVER;
+    driver->begin(&SPI, PIN_EINK_DC, PIN_EINK_CS, PIN_EINK_BUSY, PIN_EINK_RES);
+
+    // InkHUD
+    // ----------------------------
+
+    InkHUD::InkHUD *inkhud = InkHUD::InkHUD::getInstance();
+
+    // Set the driver
+    inkhud->setDriver(driver);
+
+    // Set how many FAST updates per FULL update.
+    inkhud->setDisplayResilience(INKHUD_BUILDCONF_DISPLAYRESILIENCE); // Suggest roughly ten
+
+    // Prepare fonts
+    InkHUD::Applet::fontLarge = FREESANS_9PT_WIN1252;
+    InkHUD::Applet::fontSmall = FREESANS_6PT_WIN1252;
+
+    // Init settings, and customize defaults
+    // Values ignored individually if found saved to flash
+    inkhud->persistence->settings.rotation = (driver->height > driver->width ? 1 : 0); // Rotate 90deg to landscape, if needed
+    inkhud->persistence->settings.userTiles.maxCount = 4;
+    inkhud->persistence->settings.optionalFeatures.batteryIcon = true;
+
+    // Pick applets
+    // Note: order of applets determines priority of "auto-show" feature
+    inkhud->addApplet("All Messages", new InkHUD::AllMessageApplet);
+    inkhud->addApplet("DMs", new InkHUD::DMApplet, true, false, 3);                       // Default on tile 3
+    inkhud->addApplet("Channel 0", new InkHUD::ThreadedMessageApplet(0), true, false, 2); // Default on tile 2
+    inkhud->addApplet("Channel 1", new InkHUD::ThreadedMessageApplet(1));
+    inkhud->addApplet("Positions", new InkHUD::PositionsApplet, true, false, 1);      // Default on tile 1
+    inkhud->addApplet("Recents List", new InkHUD::RecentsListApplet, true, false, 0); // Default on tile 0
+    inkhud->addApplet("Heard", new InkHUD::HeardApplet, true);                        // Background
+
+    // Start running InkHUD
+    inkhud->begin();
+
+    // Buttons
+    // --------------------------
+
+    Inputs::TwoButton *buttons = Inputs::TwoButton::getInstance(); // Shared NicheGraphics component
+
+    // Setup the main user button
+    buttons->setWiring(0, Inputs::TwoButton::getUserButtonPin(), true); // Internal pull up
+    buttons->setHandlerShortPress(0, [inkhud]() { inkhud->shortpress(); });
+    buttons->setHandlerLongPress(0, [inkhud]() { inkhud->longpress(); });
+
+    buttons->start();
+}
+
+#endif
--- a/variants/diy/nrf52_promicro_diy_tcxo/variant.h
+++ b/variants/diy/nrf52_promicro_diy_tcxo/variant.h
@@ -22,26 +22,26 @@ extern "C" {
 /*
 NRF52 PRO MICRO PIN ASSIGNMENT

-| Pin   | Function    |     | Pin      | Function     | RF95  |
+| Pin   | Function    |     | Pin      | Function     | RF95  |
 | ----- | ----------- | --- | -------- | ------------ | ----- |
-| Gnd   |             |     | vbat     |              |       |
-| P0.06 | Serial2 RX  |     | vbat     |              |       |
-| P0.08 | Serial2 TX  |     | Gnd      |              |       |
-| Gnd   |             |     | reset    |              |       |
-| Gnd   |             |     | ext_vcc  | *see 0.13    |       |
-| P0.17 | RXEN        |     | P0.31    | BATTERY_PIN  |       |
-| P0.20 | GPS_RX      |     | P0.29    | BUSY         | DIO0  |
-| P0.22 | GPS_TX      |     | P0.02    | MISO         | MISO  |
-| P0.24 | GPS_EN      |     | P1.15    | MOSI         | MOSI  |
-| P1.00 | BUTTON_PIN  |     | P1.13    | CS           | CS    |
-| P0.11 | SCL         |     | P1.11    | SCK          | SCK   |
-| P1.04 | SDA         |     | P0.10    | DIO1/IRQ     | DIO1  |
-| P1.06 | Free pin    |     | P0.09    | RESET        | RST   |
-|       |             |     |          |              |       |
-|       | Mid board   |     |          | Internal     |       |
-| P1.01 | Free pin    |     | 0.15     | LED          |       |
-| P1.02 | Free pin    |     | 0.13     | 3V3_EN       |       |
-| P1.07 | Free pin    |     |          |              |       |
+| Gnd   |             |     | vbat     |              |       |
+| P0.06 | Serial2 RX  |     | vbat     |              |       |
+| P0.08 | Serial2 TX  |     | Gnd      |              |       |
+| Gnd   |             |     | reset    |              |       |
+| Gnd   |             |     | ext_vcc  | *see 0.13    |       |
+| P0.17 | RXEN        |     | P0.31    | BATTERY_PIN  |       |
+| P0.20 | GPS_RX      |     | P0.29    | BUSY         | DIO0  |
+| P0.22 | GPS_TX      |     | P0.02    | MISO         | MISO  |
+| P0.24 | GPS_EN      |     | P1.15    | MOSI         | MOSI  |
+| P1.00 | BUTTON_PIN  |     | P1.13    | CS           | CS    |
+| P0.11 | SCL         |     | P1.11    | SCK          | SCK   |
+| P1.04 | SDA         |     | P0.10    | DIO1/IRQ     | DIO1  |
+| P1.06 | Free pin    |     | P0.09    | RESET        | RST   |
+|       |             |     |          |              |       |
+|       | Mid board   |     |          | Internal     |       |
+| P1.01 | Free pin    |     | 0.15     | LED          |       |
+| P1.02 | Free pin    |     | 0.13     | 3V3_EN       |       |
+| P1.07 | Free pin    |     |          |              |       |
 */

 // Number of pins defined in PinDescription array
@@ -185,6 +185,12 @@ settings.
 #define SX126X_DIO3_TCXO_VOLTAGE 1.8
 #define TCXO_OPTIONAL // make it so that the firmware can try both TCXO and XTAL

+// E-Ink DIY
+#define PIN_EINK_CS (32 + 7)
+#define PIN_EINK_DC (32 + 2)
+#define PIN_EINK_RES (32 + 1)
+#define PIN_EINK_BUSY (32 + 6)
+
 #ifdef __cplusplus
 }
 #endif
--- a/variants/diy/platformio.ini
+++ b/variants/diy/platformio.ini
@@ -68,6 +68,27 @@ lib_deps =
  ${nrf52840_base.lib_deps}
 debug_tool = jlink

+; NRF52 ProMicro w/ E-Ink display
+[env:nrf52_promicro_diy-inkhud]
+board_level = extra
+extends = nrf52840_base, inkhud
+board = promicro-nrf52840
+build_flags =
+  ${nrf52840_base.build_flags}
+  ${inkhud.build_flags}
+  -I variants/diy/nrf52_promicro_diy_tcxo
+  -D NRF52_PROMICRO_DIY
+build_src_filter =
+  ${nrf52_base.build_src_filter}
+  ${inkhud.build_src_filter}
+  +<../variants/diy/nrf52_promicro_diy_tcxo>
+lib_deps =
+  ${inkhud.lib_deps} ; InkHUD libs first, so we get GFXRoot instead of AdafruitGFX
+  ${nrf52840_base.lib_deps}
+extra_scripts =
+  ${env.extra_scripts}
+  variants/diy/nrf52_promicro_diy_tcxo/custom_build_tasks.py ; Add to PIO's Project Tasks pane: preset builds for common displays
+
 ; Seeed XIAO nRF52840 + XIAO Wio SX1262 DIY
 [env:seeed-xiao-nrf52840-wio-sx1262]
 board = xiao_ble_sense