Files
rich 157646e093 firmware/tools: fake companion radio on a pty for transmit-free testing
Answers the companion protocol per MyMesh.cpp: device/self info, clock
(forward-only like the firmware), channels with stale bytes in unused
slots, one contact of each type plus a UTF-8 name, queued messages behind
PUSH_MSG_WAITING, and DM sends with SENT, a confirmation ~2 s later (none
for 'noack') and an echo reply. Verified with companion_query.py.
2026-11-01 15:53:04 -05:00

3.0 KiB

Firmware

meshcore-xiao-nrf52-uart-companion.patch

Adds a Xiao_nrf52_companion_radio_uart PlatformIO env to MeshCore. It runs the companion protocol on the XIAO nRF52840's hardware UART, D6 (TX, P1.11) / D7 (RX, P1.12), at 115200 8N1, for the Visor. It also keeps the USB link (ENABLE_USB_INTERFACE) for bench testing and setup with meshcore-cli or the MeshCore app. I2C moves to unused internal pins 16/17.

cd firmware
make                 # clone MeshCore @ MESHCORE_REF into meshcore/, apply the patch, build
make upload          # flash the XIAO over USB
make MESHCORE_URL=~/Code_Repo/MeshCore-Stock   # clone from a local checkout instead of GitHub
make upload UPLOAD_PORT=/dev/cu.usbmodemXXXX   # pick the port explicitly

The patch is generated against MeshCore a366955c (2026-09-30), pinned as MESHCORE_REF in the Makefile. meshcore/ is a git-ignored build checkout.

I2C is moved off D6/D7 with build_unflags. A -U flag in build_flags doesn't work under PlatformIO: it collects -D defines together and emits -U after them, which erases the new value too.

On Apple Silicon without Rosetta, the nRF52 platform's default GCC 7.2.1 (x86_64-only) won't run. The Makefile pins PlatformIO's native GCC 14.2.1 for the build checkout instead (TOOLCHAIN_PIN). Stock MeshCore nRF52 releases use GCC 7, so treat GCC 14 builds as untested until they've run on hardware.

Verified: builds cleanly (RAM 60.8%, flash 54.0%); the compile flags show PIN_WIRE_SCL=16, PIN_WIRE_SDA=17, SERIAL_TX=D6, SERIAL_RX=D7.

Verified on hardware (2026-11-01): flashed to the SB-LoRa XIAO (serial 87F2365FB1415308). Over USB it answers CMD_DEVICE_QUERY with DEVICE_INFO: MeshCore v1.17.1, "Seeed Xiao-nrf52". Over an FT232R USB-TTL adapter on D6 (TX) / D7 (RX) at 115200 8N1 it returns the identical DEVICE_INFO frame.

tools/companion_query.py

Sends a companion frame and prints the reply frames. Uses only the Python standard library.

tools/companion_query.py /dev/cu.usbmodemXXXX            # CMD_DEVICE_QUERY over the XIAO's USB
tools/companion_query.py /dev/cu.usbserial-XXXX 16 03    # over a USB-TTL adapter on D6/D7

tools/fake_radio.py

A fake companion radio on a pseudo-terminal, for testing clients without transmitting. It answers the protocol with:

  • device and self info, and the clock
  • channels (Public, #test; unused slots carry stale bytes like the real firmware)
  • one contact of each type, plus one with a UTF-8 name
  • queued messages announced with PUSH_MSG_WAITING
  • DM sends: SENT, then PUSH_SEND_CONFIRMED after about 2 s (never if the text contains "noack"), then an echo reply
  • a channel message from "Bob" every --chat seconds
tools/fake_radio.py                                  # prints its pty, e.g. /dev/ttys004
../palm-client/tools/visor_bridge.py /dev/ttys004    # bridge the Visor to it

Type c <text> or d <text> at its prompt to inject a channel message or a DM. Note that the Visor stores what it receives from the fake radio in its real message database.