Skip to main content

InkHUD

What is InkHUD?โ€‹

InkHUD is a user interface for Meshtastic devices which have an E-Ink display. It is designed to give a quick "heads-up", showing important information at a glance, complimenting a connected client app. Specifically targeting E-Ink displays, it is offered as an alternative to the original OLED user interface.

Under active development since late 2024, the list of features and supported devices will continue to grow.

Supported Devicesโ€‹

As of March 2025. Watch this space ๐Ÿ‘€

  • Complete Devices
    • LilyGo T-Echo
    • Heltec Wireless Paper
    • Heltec Vision Master E213
    • Heltec Vision Master E290
  • DIY Displays (custom builds, for the brave..)
    • WeAct Studio 4.2" Black & White

Installationโ€‹

InkHUD can be installed on supported devices using the Meshtastic Web Flasher. Select a 2.6+ version firmware, and toggle the Install InkHUD display option on the flash screen.

Prebuilt firmware binaries are also available on the downloads page. The InkHUD versions are identified by the "-inkhud" suffix in the filename.

If you wish to use InkHUD with a DIY Meshtastic device, you will need to build the firmware manually, specially configuring InkHUD for your hardware.

Initial Setupโ€‹

Buttonsโ€‹

InkHUD is designed to be used with just one button. A mixture of short and long button presses are use to control the user interface.

Appletsโ€‹

InkHUD provides a set of applets, each one showing a different set of information. You can choose which applets to enable using the on-screen menu. For in-depth descriptions, see the List of InkHUD Applets.

  • Short-press: switch to the next applet.
animation of cycling though inkhud applets with user button

On-Screen Menuโ€‹

InkHUD has a built in menu, with a few basic actions, and options for configuring the device.

To open the on-screen menu, long-press the user button.

  • short-press: next item
  • long-press: select

Only wanted a quick peek at the clock? Long-press a second time to close the menu.

animation of navigating inkhud menu

Optionsโ€‹

Applet Selectionโ€‹

Choose which applets to enable. Allows you to customize the information shown by the display.

Auto-showโ€‹

Choose which applets will be automatically shown, when they have new information to display.

Example: enabling auto-show for the All Messages applet will cause InkHUD to swap to All Messages when a new text message arrives.

Recents Durationโ€‹

Some applets show information which is a summary of the last few minutes. This option allows you to configure how many minutes of information those applets should show.

Layoutโ€‹

InkHUD can "tile" multiple applets at once, dividing the display area between them. This option changes how many applets are shown.

Rotationโ€‹

Rotate the display clockwise, 90ยฐ at a time.

Notificationsโ€‹

If enabled, show pop-up notifications for new messages at top of display. This is an alternative to the the auto-show feature, which would instead switch applets to display the new message.

Battery Iconโ€‹

If enabled, show a small icon which indicates battery's state of charge, in the top-right corner of the display.

Multiple Appletsโ€‹

InkHUD can show multiple applets at the same time; a feature knows as tiling. To change the amount of tiles, select Options > Layout in the on-screen menu.

Moving between tilesโ€‹

Using the Menuโ€‹

For most devices, the on-screen menu is used to move between tiles.

animation of changing tiles in inkhud using the menu

Using an Extra Buttonโ€‹

Some devices have an extra hardware button, which provides a more convenient method of moving between tiles.

animation of changing tiles in inkhud using an aux button