https://meshtastic-bice.vercel.app/assets/js/0e20d13d.8284b5e4.js

1"use strict";(self.webpackChunkmeshtastic=self.webpackChunkmeshtastic||[]).push([["14653"],{3692(e,i,n){n.r(i),n.d(i,{metadata:()=>s,default:()=>u,frontMatter:()=>o,contentTitle:()=>d,toc:()=>r,assets:()=>h});var s=JSON.parse('{"id":"configuration/device-uis/inkhud/inkhud","title":"InkHUD","description":"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.","source":"@site/versioned_docs/version-2.7/configuration/device-uis/inkhud/index.mdx","sourceDirName":"configuration/device-uis/inkhud","slug":"/configuration/device-uis/inkhud/","permalink":"/docs/2.7/configuration/device-uis/inkhud/","draft":false,"unlisted":false,"tags":[],"version":"2.7","lastUpdatedBy":"rcarteraz","sidebarPosition":3,"frontMatter":{"id":"inkhud","title":"InkHUD","sidebar_label":"InkHUD","sidebar_position":3,"description":"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."},"sidebar":"Sidebar","previous":{"title":"Meshtastic UI","permalink":"/docs/2.7/configuration/device-uis/meshtasticui/"},"next":{"title":"List of Applets","permalink":"/docs/2.7/configuration/device-uis/inkhud/applets"}}'),t=n(91987),a=n(67008),l=n(87622);n(42506),n(69671);let o={id:"inkhud",title:"InkHUD",sidebar_label:"InkHUD",sidebar_position:3,description:'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.'},d,h={},r=[{value:"What is InkHUD?",id:"what-is-inkhud",level:2},{value:"Supported Devices",id:"supported-devices",level:2},{value:"Installation",id:"installation",level:2},{value:"Initial Setup",id:"initial-setup",level:2},{value:"Buttons",id:"buttons",level:2},{value:"Applets",id:"applets",level:2},{value:"On-Screen Menu",id:"on-screen-menu",level:2},{value:"Send",id:"send",level:3},{value:"Ping",id:"ping",level:4},{value:"Canned Messages",id:"canned-messages",level:4},{value:"Options",id:"options",level:3},{value:"Enable / Disable GPS",id:"enable--disable-gps",level:4},{value:"Applet Selection",id:"applet-selection",level:4},{value:"Auto-show",id:"auto-show",level:4},{value:"Recents Duration",id:"recents-duration",level:4},{value:"Layout",id:"layout",level:4},{value:"Rotation",id:"rotation",level:4},{value:"Notifications",id:"notifications",level:4},{value:"Battery Icon",id:"battery-icon",level:4},{value:"12-Hour Clock",id:"12-hour-clock",level:4},{value:"Multiple Applets",id:"multiple-applets",level:2},{value:"Moving between tiles",id:"moving-between-tiles",level:3},{value:"Using the Menu",id:"using-the-menu",level:4},{value:"Using an Extra Button",id:"using-an-extra-button",level:4}];function c(e){let i={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.h2,{id:"what-is-inkhud",children:"What is InkHUD?"}),"\n",(0,t.jsxs)(i.p,{children:['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 ',(0,t.jsx)(i.a,{href:"/downloads/",children:"client app"}),". Specifically targeting E-Ink displays, it is offered as an alternative to the original ",(0,t.jsx)(l.A,{term:"OLED",definition:"A display type used on many Meshtastic devices. The OLED Type setting selects which panel driver the firmware uses.",routePath:"/docs/terms/",children:"OLED"})," user interface."]}),"\n",(0,t.jsx)(i.p,{children:"Under active development since late 2024, the list of features and supported devices will continue to grow."}),"\n",(0,t.jsx)(i.h2,{id:"supported-devices",children:"Supported Devices"}),"\n",(0,t.jsx)(i.p,{children:"As of June 2025. Watch this space \u{1F440}"}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsxs)(i.li,{children:[(0,t.jsx)(i.strong,{children:"Complete Devices"}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsx)(i.li,{children:"Elecrow ThinkNode M1"}),"\n",(0,t.jsx)(i.li,{children:"LilyGo T3 S3 E-Paper"}),"\n",(0,t.jsx)(i.li,{children:"LilyGo T-Echo"}),"\n",(0,t.jsx)(i.li,{children:"Heltec MeshPocket"}),"\n",(0,t.jsx)(i.li,{children:"Heltec Vision Master E213"}),"\n",(0,t.jsx)(i.li,{children:"Heltec Vision Master E290"}),"\n",(0,t.jsx)(i.li,{children:"Heltec Wireless Paper"}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(i.li,{children:[(0,t.jsx)(i.strong,{children:"DIY Displays"})," (",(0,t.jsx)(i.a,{href:"./diy-builds/",children:"custom builds"}),", ",(0,t.jsx)(i.em,{children:"for the brave.."}),")","\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsx)(i.li,{children:'WeAct Studio 1.54" Black & White'}),"\n",(0,t.jsx)(i.li,{children:'WeAct Studio 2.13" Black & White (2025 Revision)'}),"\n",(0,t.jsx)(i.li,{children:'WeAct Studio 2.9" Black & White'}),"\n",(0,t.jsx)(i.li,{children:'WeAct Studio 4.2" Black & White'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(i.h2,{id:"installation",children:"Installation"}),"\n",(0,t.jsxs)(i.p,{children:["InkHUD can be installed on supported devices using the ",(0,t.jsx)(i.a,{href:"https://flasher.meshtastic.org",children:"Meshtastic Web Flasher"}),". Select a 2.6+ version firmware, and toggle the ",(0,t.jsx)(i.co

1de,{children:"Install InkHUD display"})," option on the flash screen."]}),"\n",(0,t.jsxs)(i.p,{children:["Prebuilt firmware binaries are also available on the ",(0,t.jsx)(i.a,{href:"/downloads/",children:"downloads page"}),". The InkHUD versions are identified by the ",(0,t.jsx)(i.strong,{children:'"-inkhud"'})," suffix in the filename."]}),"\n",(0,t.jsxs)(i.p,{children:["For ",(0,t.jsx)(i.a,{href:"./diy-builds/",children:"DIY InkHUD devices"}),", the firmware must be built manually."]}),"\n",(0,t.jsx)(i.h2,{id:"initial-setup",children:"Initial Setup"}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsx)(i.li,{children:(0,t.jsx)(i.a,{href:"/docs/2.7/configuration/region-by-country/",children:"Set your LoRa region"})}),"\n",(0,t.jsx)(i.li,{children:(0,t.jsx)(i.a,{href:"/docs/2.7/configuration/radio/device#tzdef-timezone-definition",children:"Set your timezone"})}),"\n"]}),"\n",(0,t.jsx)(i.h2,{id:"buttons",children:"Buttons"}),"\n",(0,t.jsx)(i.p,{children:"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."}),"\n",(0,t.jsx)(i.h2,{id:"applets",children:"Applets"}),"\n",(0,t.jsxs)(i.p,{children:["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 ",(0,t.jsx)(i.a,{href:"/docs/2.7/configuration/device-uis/inkhud/applets",children:"List of InkHUD Applets"}),"."]}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsxs)(i.li,{children:[(0,t.jsx)(i.strong,{children:"Short-press"}),": switch to the next applet."]}),"\n"]}),"\n",(0,t.jsx)("img",{src:"/img/software/inkhud/next-applet.gif",alt:"animation of cycling though inkhud applets with user button",style:{maxHeight:"256px",width:"auto"}}),"\n",(0,t.jsx)(i.h2,{id:"on-screen-menu",children:"On-Screen Menu"}),"\n",(0,t.jsx)(i.p,{children:"InkHUD has a built in menu, with a few basic actions, and options for configuring the device."}),"\n",(0,t.jsxs)(i.p,{children:["To open the on-screen menu, ",(0,t.jsx)(i.strong,{children:"long-press"})," the user button."]}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsxs)(i.li,{children:[(0,t.jsx)(i.strong,{children:"short-press"}),": next item"]}),"\n",(0,t.jsxs)(i.li,{children:[(0,t.jsx)(i.strong,{children:"long-press"}),": select"]}),"\n"]}),"\n",(0,t.jsx)(i.p,{children:"Only wanted a quick peek at the clock? Long-press a second time to close the menu."}),"\n",(0,t.jsx)("img",{src:"/img/software/inkhud/menu.gif",alt:"animation of navigating inkhud menu",style:{maxHeight:"256px",width:"auto"}}),"\n",(0,t.jsx)(i.h3,{id:"send",children:"Send"}),"\n",(0,t.jsx)(i.h4,{id:"ping",children:"Ping"}),"\n",(0,t.jsx)(i.p,{children:"Manually announces the device to other nodes on the mesh."}),"\n",(0,t.jsx)(i.p,{children:"This is optional, as nodes are discovered automatically,\nhowever sending a ping manually may speed up this process is some situations."}),"\n",(0,t.jsx)(i.h4,{id:"canned-messages",children:"Canned Messages"}),"\n",(0,t.jsxs)(i.p,{children:["Send predefined text messages to the mesh network from the device without using the phone app.\nTo enable this feature, ",(0,t.jsx)(i.a,{href:"/docs/2.7/configuration/module/canned-message/#messages",children:"set a list of predefined messages"}),".\nNo further configuration is required."]}),"\n",(0,t.jsxs)(i.p,{children:["To send, select the predefined message in the ",(0,t.jsx)(i.code,{children:"Send"})," menu, then select a destination. The list of possible destinations will include the device's available channels, and nodes marked favorite."]}),"\n",(0,t.jsx)(i.h3,{id:"options",children:"Options"}),"\n",(0,t.jsx)(i.h4,{id:"enable--disable-gps",children:"Enable / Disable GPS"}),"\n",(0,t.jsxs)(i.p,{children:["Enables or disables the device's ",(0,t.jsx)(l.A,{term:"GPS",definition:"A satellite positioning system. A node with a GPS module determines its own location and can report that position to the mesh.",routePath:"/docs/terms/",children:"GPS"})," hardware. This option is hidden if ",(0,t.jsx)(l.A,{term:"GPS",definition:"A satellite positioning system. A node with a GPS module determines its own location and can report that position to the mesh.",routePath:"/docs/terms/",children:"GPS"}

1)," is ",(0,t.jsx)(i.code,{children:"NOT_PRESENT"}),"."]}),"\n",(0,t.jsx)(i.h4,{id:"applet-selection",children:"Applet Selection"}),"\n",(0,t.jsx)(i.p,{children:"Choose which applets to enable. Allows you to customize the information shown by the display."}),"\n",(0,t.jsx)(i.h4,{id:"auto-show",children:"Auto-show"}),"\n",(0,t.jsx)(i.p,{children:"Choose which applets will be automatically shown, when they have new information to display."}),"\n",(0,t.jsx)(i.p,{children:"Example: enabling auto-show for the All Messages applet will cause InkHUD to swap to All Messages when a new text message arrives."}),"\n",(0,t.jsx)(i.h4,{id:"recents-duration",children:"Recents Duration"}),"\n",(0,t.jsx)(i.p,{children:"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."}),"\n",(0,t.jsx)(i.h4,{id:"layout",children:"Layout"}),"\n",(0,t.jsx)(i.p,{children:'InkHUD can "tile" multiple applets at once, dividing the display area between them. This option changes how many applets are shown.'}),"\n",(0,t.jsx)(i.h4,{id:"rotation",children:"Rotation"}),"\n",(0,t.jsx)(i.p,{children:"Rotate the display clockwise, 90\xb0 at a time."}),"\n",(0,t.jsx)(i.h4,{id:"notifications",children:"Notifications"}),"\n",(0,t.jsx)(i.p,{children:"If enabled, show pop-up notifications for new messages at top of display. This is an alternative to the auto-show feature, which would instead switch applets to display the new message."}),"\n",(0,t.jsx)(i.h4,{id:"battery-icon",children:"Battery Icon"}),"\n",(0,t.jsx)(i.p,{children:"If enabled, show a small icon which indicates battery's state of charge, in the top-right corner of the display."}),"\n",(0,t.jsx)(i.h4,{id:"12-hour-clock",children:"12-Hour Clock"}),"\n",(0,t.jsxs)(i.p,{children:["If enabled, times will be shown in 12 hour format (",(0,t.jsx)(i.code,{children:"1:50 PM"}),"), instead of 24 hour format (",(0,t.jsx)(i.code,{children:"13:50"}),")."]}),"\n",(0,t.jsx)(i.h2,{id:"multiple-applets",children:"Multiple Applets"}),"\n",(0,t.jsxs)(i.p,{children:["InkHUD can show multiple applets at the same time; a feature knows as ",(0,t.jsx)(i.em,{children:"tiling"}),". To change the amount of tiles, select ",(0,t.jsx)(i.code,{children:"Options > Layout"})," in the on-screen menu."]}),"\n",(0,t.jsx)(i.h3,{id:"moving-between-tiles",children:"Moving between tiles"}),"\n",(0,t.jsx)(i.h4,{id:"using-the-menu",children:"Using the Menu"}),"\n",(0,t.jsx)(i.p,{children:"For most devices, the on-screen menu is used to move between tiles."}),"\n",(0,t.jsx)("img",{src:"/img/software/inkhud/next-tile.gif",alt:"animation of changing tiles in inkhud using the menu",style:{maxHeight:"256px",width:"auto"}}),"\n",(0,t.jsx)(i.h4,{id:"using-an-extra-button",children:"Using an Extra Button"}),"\n",(0,t.jsx)(i.p,{children:"Some devices have an extra hardware button, which provides a more convenient method of moving between tiles."}),"\n",(0,t.jsx)("img",{src:"/img/software/inkhud/next-tile-aux.gif",alt:"animation of changing tiles in inkhud using an aux button",style:{maxHeight:"256px",width:"auto"}})]})}function u(e={}){let{wrapper:i}={...(0,a.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}}}]);