Files
wadamesh/README.md
T
Kaj SchittecatandClaude Opus 5 a6c447e7d7 docs + tools: sideloading wadamesh on the Tanmatsu
There was no way for anyone but me to put a self-built wadamesh on a Tanmatsu.
The repo carried tanmatsu/build.sh and nothing that could install what it built:
the AppFS writer lived only on my machine, so a fresh clone produced a binary and
no path onto the device. Anyone trying would land on `idf.py flash`, which
replaces the launcher OS.

tanmatsu/tools/ now carries the loop, generalised out of my local copy:

  fetch-appfs.sh     one-time, clones badge.team's esp32-component-appfs
  dump-pristine.sh   one-time, dumps YOUR device's AppFS partition as the baseline
  tan_deploy.py      builds the write-images and works out the changed sectors
  tan_flash.sh       detects the P4, writes app then metadata, verifies the commit
  sermon.py          non-resetting serial monitor

Three things had to change before this could work for anybody else. Absolute
paths to my checkout are gone. The hardcoded MAC of MY Tanmatsu is replaced by
detecting whichever port answers as an ESP32-P4, which is also more robust since
the board exposes two ports whose names move between replugs. And tan_flash.sh no
longer invokes tan_deploy.py twice: the second run would have read the metadata
the first had just written and bumped the version an extra time.

appfs.py is deliberately NOT vendored. It is badge.team's and the copy in
circulation has no licence header, so it is cloned instead. dev_appfs.bin is not
committed either: it is 8 MB and device-specific, and using someone else's dump
risks overwriting apps you have, since the deploy writes only what differs from
it. Both are gitignored.

Written up in TANMATSU_SIDELOAD.md and as a page on the site, linked from the
user guide, the homepage resources section and the README. The guide leads with
the model rather than the commands, because the failure that matters is not a
typo, it is not knowing that this board runs wadamesh as an app under a launcher
and that flashing it normally destroys that launcher.

Not re-verified on hardware: the tooling is the same loop that has been deploying
to my Tanmatsu, with the paths and device detection generalised. The first person
to run it on another machine is the real test.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-21 19:32:50 +02:00

3.9 KiB

WADAMESH

A real touchscreen UI for your mesh radio. · open source · GPL-3.0

Touch-UI MeshCore companion-radio firmware for the LilyGo T-Deck / T-Deck Plus, Heltec V4 + TFT and eight other boards (ESP32-S3).

An LVGL touch UI — map, chat, contacts, channels, settings — split out of meshcomod. The app depends on a MeshCore fork via PlatformIO lib_deps.

Boards

See DEVICES.md for the full support matrix, install paths and per-board status.

  • LilyGo T-Deck / T-Deck Plus — env LilyGo_TDeck_companion_radio_touch (stable)
  • Heltec V4 + TFT + CHSC6x touch — env heltec_v4_tft_companion_radio_usb_tcp_touch (stable)
  • Tanmatsu (ESP32-P4) — built from tanmatsu/ (ESP-IDF), ships via the Tanmatsu app store — sideload guide for running your own build
  • Elecrow ThinkNode M9 — env ThinkNode_M9_companion_radio_touch (beta) — keyboard & d-pad guide
  • RAK WisMesh Tap V2 (RAK3312) — env rak_tap_v2_companion_radio_touch (beta)
  • LilyGo T-Lora Pager — envs tlora_pager_lr1121_companion_radio_touch / tlora_pager_sx1262_companion_radio_touch (stable) — keyboard shortcuts
  • Heltec V4-R8 + Expansion Kit V2 — env heltec_v4_r8_tft_companion_radio_usb_tcp_touch (stable)
  • LilyGo T-Display P4 — built from tdisplay_p4/ (ESP-IDF); AMOLED by default, WADA_P4_LCD=1 for the TFT-LCD SKU
  • Attaky Mesh Series — env attaky_mesh_series_companion_radio_touch (beta)

Architecture

This repo holds only the app: the companion_radio glue, the ui-touch LVGL UI, each board's glue/variants, and platformio.ini. The MeshCore core is not vendored here — it's pulled as a library via lib_deps from the ALLFATHER-BV/meshcomod monorepo (the same repo as the non-touch firmware), pinned by a lean source-only core-* git tag. The touch-app files this repo owns (TouchPrefsStore, WifiRuntimeStore, the transports, …) are dropped from the lib via -DMC_VENDORED_TOUCH_APP so they aren't compiled twice. The build is byte-identical to the original in-tree meshcomod firmware.

Build

PlatformIO pulls the core fork and all libraries automatically:

pio run -e heltec_v4_tft_companion_radio_usb_tcp_touch   # Heltec V4 TFT
pio run -e LilyGo_TDeck_companion_radio_touch            # LilyGo T-Deck
# or just `pio run` to build both

Flash with the NVS-preserving 4-component chain (bootloader / partitions / boot_app0 / firmware at 0x0 / 0x8000 / 0xe000 / 0x10000) so saved Wi-Fi credentials survive — not a merged image, which 0xFF-pads and wipes NVS.

Contributing

Contributions are welcome — see CONTRIBUTING.md. One topic per PR; inbound contributions are accepted under the project's GPL-3.0 license.

License

GPL-3.0-or-later — see LICENSE. wadamesh is copyleft: anyone who distributes a build or a fork must also make their source available under the GPL. This keeps the UI open and concentrates community effort instead of fragmenting it into closed forks.

wadamesh incorporates and depends on MeshCore (MIT, © Scott Powell / rippleradios.com) and other third-party components — see NOTICE for the full list and their licenses. MeshCore-derived files keep their MIT notices; the combined work is distributed under the GPL (MIT is GPL-compatible). The MeshCore fork that wadamesh builds against stays MIT on purpose, so its Wi-Fi/BLE hooks remain upstreamable to MeshCore.