cmd/totememu turns a stock ESP32 into a Totem on the ESP-NOW mesh.
It pairs with a real Totem over the air, and from then on the two exchange peer status every
radio window like any two bonded Totems. It is written in Go and built with TinyGo and
tinygo.org/x/espradio.
A Totem’s GNSS receiver, magnetometer, motion sensor and power chip are modelled too, so the
emulator reports a position that moves, a compass, a battery that drains and a clock
(see simulated hardware). On a board that has those parts, its own
drivers replace the model — which is what the T-Beam S3 Supreme
does for the position, the clock, the battery and the orientation.
Hardware-tested on 2026-09-19 with an ESP32-D0WD-V3 and a Totem on firmware 5.0.3:
- the bond completed through the normal Touch Crystal pairing;
- the Totem unicast its status to the emulator every second, and acknowledged every frame the emulator sent;
- a walk at 5 km/h and a drive at 50 km/h arrived with the position, speed, compass, heading of motion and clock the firmware expects, including the duplicate status a Totem sends once a peer is more than 30 m away;
- the bond came back by itself after the board rebooted.
rx command:
- the settings sector survived a power cycle: the name, the boot count and the bond came back, and the bonded peer was in the node before the radio heard anything;
- an injected locate request was answered, and relayed with the hop count stepped and the last-hop position replaced by the board’s own;
- an injected Smart Group invitation was joined while pairing was open, and the board never
transmitted a
(7,0)host beacon.
Layout
Build and flash
Two binaries: the firmware, built with TinyGo and flashed to the board, andtotemctl, built
with the ordinary Go toolchain and run on your machine. Everything below that begins totemctl
needs the second one, so it is worth having first:
main.owned lists the ESP-NOW (WiFi station) MACs of your own Totems, comma-separated. It is
the MAC that totemctl info shows. main.name sets the name other Totems display (default
emu_totem_ plus the last four hex digits of the board’s MAC, such as emu_totem_abb0).
To pair, put the Totem next to the board and hold its Touch Crystal until the pairing
animation starts (about 1.2 s). The emulator notices the Totem’s bond request and pairs
back. Bonding needs RSSI ≥ −25 dBm on both sides, so the two must nearly touch. The board
keeps the bond in flash, so a reboot comes up still bonded; it also takes a bond back when a
Totem that kept it in config.json sends a status frame.
The T-Beam S3 Supreme
The emulator also runs on a LILYGO T-Beam S3 Supreme, an ESP32-S3 board that has the parts a Totem has. On it the position, the speed, the course, the clock, the battery and the orientation are read from hardware instead of modelled. The heading waits on one command, and the reason is worth reading: a magnetometer is fitted and it works — it is the field around it that is not the Earth’s, untilmag calibrate measures the difference (see below).
tinygo flash then talks to.
That same wiring is why totemctl opens the port with DTR and RTS deasserted on a port
whose USB vendor id is Espressif’s 303A. On a board with a bridge chip, DTR and RTS reach
the chip through the auto-reset circuit, which pulls EN low only when RTS is asserted and DTR
is not, so asserting both — the library default — leaves the board running. Inside the S3
there is no such circuit and RTS drives EN directly, so the port merely being open held the
chip in reset: three seconds of reading returned nothing, and with both lines deasserted the
same read returned the boot log and every line after it.
What is read, and what is not
The magnetometer is a QMC6310 at 0x3c, the N variant; the vendor’s map allows for a U at
0x1c or a QMC6309 at 0x7c, and neither of those acknowledges. It identifies itself, its
register map is a magnetometer’s, and it measures — but what it measures on this bench is
2.27 gauss, against an Earth field of 0.25 to 0.65 anywhere on the surface.
The reading is the same to three digits on every boot — around (1.92, -1.20, 0.00) g — which
is what a fixed magnetic offset looks like: something on the board or mounted with it,
rather than anything moving nearby. That is ordinary, it is called hard iron, and it is
removed by turning the sensor through every orientation and taking the center of the box the
readings sweep out. It is what the firmware’s own 2D and 3D calibration runs do. Until it has
been done a bearing from this part would be confidently wrong, so the board takes none and
says so in the log, and the heading stays on the console.
mag calibrate is that turn. It watches for twenty seconds, takes the extremes each axis
reaches, and the center of the box they sweep out is the offset — then the heading comes from
the magnetometer, tilt-compensated with the IMU’s pitch and roll, and keeps coming until the
board is rebooted. It needs someone to pick the board up and turn it over, slowly, through
every face.
A turn that was not one is refused rather than believed, which is the part worth testing: on a
board left sitting on a bench the twenty seconds gathered 389 readings whose axes moved 0.023,
0.026 and 0.046 gauss, against a floor of 0.15, and the calibration was declined. The center
of a reading that never moved is just where it was pointing, and accepting it would leave the
heading exactly as wrong as before while the board stopped saying it had no compass.
Two things this cost, both worth knowing before trusting a reading from this part:
- It was written off as absent first. Read over a bus that had not yet been made reliable, 0x1c and 0x7c returned nothing and 0x3c returned 0xff — which reads as “no magnetometer, and the thing at 0x3c is the display”. All three conclusions were wrong. Absence is established by a write now, because a write is the only transaction whose NACK this driver reports.
- A range that did not stick. The vendor’s reset is 0x80, a pause, then zero, and writing the range in place of that final zero left the register reading 0x00 — the part stayed on its default scale and every reading came out six times too small, with nothing downstream able to tell. The driver writes the range and then reads it back.
pos, heading, batt, flat and
clock all work, and the ones that hardware also fills say in the log that they have stopped
being read from it, because Controls means a command must not quietly do nothing.
Three things in TinyGo that do not reach this board
Worth writing down, because each one looked like broken hardware:- The console reads nothing.
machine.Serialon the S3 is the USB Serial/JTAG controller, and its driver moves bytes out of the receive FIFO in exactly one place:Buffered. The interrupt handler only masks the interrupt, andReadByteanswers(0, nil)on an empty buffer rather than an error — so the ESP32’s “read it and checkerr” reported success for a byte nobody typed, and fed the line reader NULs forever while the host’s input sat unread. - A UART at 9600 baud runs at the wrong speed.
UART.ConfiguresetsCLKDIVto40000000/baudand nothing else. The integer part of that register is twelve bits, and 4166 does not fit in 4095, so the value lands wrapped. On the board that arrived as 154 bytes of0x00in a second — a line that reads as a break rather than as data. The driver now pre-divides the crystal the way ESP-IDF does. - I2C stops working after a transaction or two, silently. Ten reads of the AXP2101’s
identity register returned 0x4a once and then 0xff nine times; ten reads of a status register
holding 0x20 alternated 0x20, 0xff, 0x20, 0xff. Nothing in the driver resets the controller
after a failure, so no amount of retrying recovers it — and a failed read is not even
reported, because a NACK on a transaction ending in a read is dropped. Every transaction now
runs
Configurefirst, and with that the same twenty reads all came back correct.
i2c command identifies parts by a known register value
rather than sweeping addresses: a sweep asked whether an address acknowledged, a question this
driver cannot answer, and reported 112 devices on each bus — every address, including two
magnetometer variants at once and an IMU that is wired to SPI.
Hardware-tested on 2026-09-28 with a T-Beam S3 Supreme (ESP32-S3FN8, 8 MB flash, base MAC
48:ca:43:5a:cd:14):
- boots, and the console works both ways over USB-Serial/JTAG;
- ESP-NOW starts, and the radio receives: the
selftestcommand counted 209 frames on the mesh channel in three seconds; - the flash driver’s self-test passes on its scratch sector — erase 13 ms, a 64-byte write 141 µs, the ROM descriptor reading device 0xc84017 — and the settings survive a reboot, with the boot count and journal sequence both climbing;
- the AXP2101 identifies itself, reports no cell fitted, and brings up all three rails;
- the PCF8563 clock is ticking;
- the GNSS receiver sends NMEA that parses with nothing rejected, and reports no fix indoors:
$GNRMC,001655.00,V,,,,,,,290926,,,N,V*18; - the IMU identifies itself and reads gravity: (-0.827, 0.046, 0.541) g, a magnitude of 0.989;
- the magnetometer identifies itself and measures a field, of 2.27 gauss, which is why no heading is taken from it yet.
Watching the mesh
totemctl mesh talks to the board over USB serial and decodes on the host, with the same
mesh package, every frame your Totem sends it:
--port. They open it with DTR and RTS asserted and leave them so: on
ESP32 boards the auto-reset circuit pulls EN low when RTS is set without DTR, so a monitor that
clears both on open (pyserial’s dtr=False, rts=False) reboots the emulator. The commands
switch the console to JSON lines with format json and back to text when they exit. With
--trace they log every console line.
The ESP32 only receives frames addressed to itself or broadcast. Status frames your Totem
unicasts to its other peers do not reach it.
Console
The UART console (115200 baud) logs withlog/slog and takes commands. tinygo monitor -port <port> shows it directly:
The console is parsed by
emulator.ParseCommand, which rejects values out of range (and
NaN or Inf coordinates) with a bad command warning rather than put them on the air. It is
fuzzed on the host.
Simulated hardware
A Totem has a GNSS receiver, a magnetometer, a motion sensor and a power chip. On a board without them theemulator package provides a Sim that behaves like one, so the emulator
reports what a Totem in someone’s hand would:
get_heading_mot does, drains the battery and reports satellites and a solution id.
The clock matters for more than the display. With one, the node holds wall-clock radio
windows and advertises the time to peers the way a Totem with a GNSS lock does
(rtc_method 1); without one it borrows a peer’s clock and stays quiet about it
(rtc_method 2). A board that has just booted counts from 1970, so the node refuses any
clock before 2020 rather than push that at a peer whose own clock is not set.
SensorSource is the seam: Sim on a board with no sensors, and a board’s own GNSS,
magnetometer, motion sensor and power chip where they exist. Controls is the other half
of it, the settings pos, heading, flat, batt and clock drive. Both the simulation
and the fixed reading take them, so the same console command works whichever is installed;
a source that reports real hardware and takes no settings says so instead of accepting the
command and changing nothing.
The rest of the device
A Totem is more than its radio, and the emulator now models the rest of it: what the ring and the crystal are doing, the three inputs, the power state, and an update over WiFi. Each is grounded in the firmware where the disassembly gives a number, and says so where it does not.The halo and the crystal
Sixty ring pixels (RING_PX_COUNT) and seven in the crystal
(CRYSTAL_PX_COUNT), the 13-colour palette from project_data.Colors
with the exact RGB values, and the animations the LED task plays as events
arrive: the pairing breathe, the fill when a peer bonds, the countdown
when one is deleted, the SOS blink, the demi-god flash, the white 30%
progress ring of a download (PROGRESS_RGB) and the orange fill of a
failure (ERROR_RGB). The charger going in replays the power-up ring, as
power_conn_new does once v_in has read high for three 100 ms samples
— a contact that bounces on the way into the socket does not set it off,
and neither does a poll rate, because the wait is 300 ms of clock rather
than a count of polls. It only goes on over a resting ring: plugging in
during an alarm, a pairing window or an update leaves those showing. At
rest the ring is the compass: a lit pixel, with
its neighbours feathered, pointing at the bonded Totem, in the colour that
peer was given when it bonded (shuffle_bond_colors).
Frame timings are the one thing the firmware keeps out of reach — they
live in undisassembled bytecode — so the ones here are chosen to look like
the device, at 25 ms a frame.
emulator.LEDs().Ring() is what to write
to it. On a stock dev board there is one LED, on GPIO2, and it follows the
crystal: enough to see a pairing breathe, an SOS blink, and the dark of a
device that has powered down.
Touch and the buttons
The Touch Crystal and the power and SOS buttons all report the same gestures — taps counted inside a window, and holds — andcompass wires
each to a callback:
The recogniser takes edges, not gestures, so the same code serves a real
pin, a capacitive reading and the console. v5.0.3’s 30 ms edge lockout is
there, and so is the wait before touch is enabled after a boot. A hold
fires when it matures, not when the finger lands, so a three-second hold
of the crystal opens its pairing window 1.2 s in and keeps it open for
the full six seconds.
A device that has been powered down answers one gesture — the power
button held, which turns it back on — and its strip stays dark: on a
board whose LED follows the crystal, switching it off switches the light
off.
Power
The battery curve isget_batt_pct’s own breakpoint table, decoded from
the 232-byte constant in peripherals.py: 58 pairs of millivolts and a
raw level, from 4120 mV down to 3190, with the percentage taken as
(raw*1000//605 + 5)//10. So 4.12 V reads 100%, 4.0 V reads 86% and
3.8 V reads 50%, and anything above 4.12 V reads full — a Totem on its
charger reports 4.48 V at 100%.
The learned maximum (config.batt_max_volts) rescales a reading only
when it is below the table’s top, lifting it so a pack that no longer
reaches 4.12 V still reads full at its own ceiling; above the top there
is no rescale at all. It is learned the way one_min_coro learns it:
only while charging, and only once the peak stops rising, stored as that
peak less 0.04 V.
The mode follows the battery — normal, eco, low below 3.45 V — and below
3.15 V the device powers itself down rather than brown out, which a peer
sees as the status frames stopping. That is a different number from the
one the gauge reaches zero at: the table’s flat end is 3.19 V, so a
Totem reports 0% for a stretch and keeps running. A pack on the charger
never hits the cutoff, however flat it reads. The mode is not settable by hand, because the next battery
reading five milliseconds later would undo it: change the battery with
batt instead. Light sleep is accounted the way the firmware logs it,
including the two reasons it stays awake: a radio window about to open,
and a clock sync that has not finished. The watchdog model is
wdt_manager’s: the feed loop runs only while no blocker is held, and a
flash write holds vfs write.
The sleep is accounted, not taken: the board stays awake. A Totem light-sleeps between
radio windows and still keeps its link, and the board could do the same, but the counter is
what a peer can see the effect of — the mode in a status frame, and a device that has
powered down going quiet. Powering down is the emulator’s deep sleep: the radio windows
stop, frames are no longer answered, and only a held power button brings it back.
WiFi OTA
The update client runs the firmware’s exchange againstapi.totemportal.com: POST the release poll, GET contents.json, pick the
.bin (or the .tgz for a preview), read the version out of the name
between _v and the extension, download it with the progress ring
running. A device that has switched itself off is refused first — there is
no rebooting a device that has already stopped — and then the battery
gate, as Battery too low for OTA update does. A board wired without a
power chip is exempt, but only if it was built with NoPowerChip — never
because it happens to read zeroes. A reading of 0 V and 0% is also what a
dead cell and a failed ADC report, and those two are exactly what the gate
is for, so the flag is written the way round where forgetting it keeps the
gate on.
The emulator stops before writing a slot: it has one image, and losing it
would take the board off the mesh. Everything up to that point is real,
including the refusals — the exchange is plain HTTP with no key, no
signature and no TLS, so a release object with no ota_url, an index that
is not a JSON array, or a name with a path in it are all rejected rather
than followed. FuzzOTAServer covers exactly that.
Settings that survive a reboot
A Totem keeps its name, its crystal colour and every bond inconfig.json on its
filesystem. The board has no filesystem, so the store package keeps the same things in one
4 KB flash sector as an append-only journal: a save appends a record, and only a full sector
costs an erase. Bonds go back into the node before the radio starts, so the emulator comes up
already bonded.
store prints them — but not read
back, because the firmware keeps both in modes, whose constructor sets them to zero: they
start again at every boot, and a power cycle is a boot.
Everything read back is untrusted — a write cut short by a reset, a previous firmware, or
noise — so a record is believed only if its header and checksum agree, and a sector that
makes no sense boots with defaults rather than failing. FuzzScan covers exactly that.
Flashing the board erases the sector with the rest of the chip, so a reflash starts from
defaults; a power cut does not.
The driver underneath is the fiddly part, because on the ESP32 the code itself runs from
flash through the MMU cache. Touching flash means turning that cache off, and while it is off
the CPU cannot fetch an instruction or a constant from flash — so the operations live in
IRAM, take every address they need as data, and each is its own function (a branch on an
operation number compiled into a jump table, which lives in flash, and the board jumped into
0xbad00bad). An erase takes about 51 ms with interrupts off, so the settings are written
only when a bond or a setting actually changed.
Two things about this board are worth knowing if you port it: its flash ships without block
protection but the ROM’s erase still refuses anything past the chip_size in the ROM’s own
descriptor, and the bootloader leaves that at 2 MB on a 4 MB part — so the sector sits just
under 2 MB rather than at the end of the chip.
Injecting frames
Some paths need a second Totem: a locate relay, a Smart Group invitation.rx feeds the node
a frame as though the radio had heard it, so they can be exercised on the board itself:
allowedTX.
Radio setup
espradio starts the WiFi station, and the firmware then applies the Totem’s settings from
EspConn.power_on through the WiFi blob functions that espradio links but does not wrap:
esp_wifi_set_protocol(STA, WIFI_PROTOCOL_LR), esp_wifi_set_channel(6),
esp_wifi_set_max_tx_power(84) (21 dBm) and esp_wifi_config_espnow_rate(STA, WIFI_PHY_RATE_LORA_250K). The send reports confirm rate 0x29.
Untrusted input
Everything that reaches the emulator from outside is fuzzed, and the fuzz targets run in CI:Scope
The emulator only listens to and talks to the Totems inmain.owned:
- Frames from any other sender are dropped unread.
-
Unicasts go only to owned Totems.
emulatorchecks every outgoing frame in one place, and the tests assert this for every frame. -
It relays only locate frames that an owned Totem originated. This is the one place the
emulator knowingly does less than the firmware. A Totem relays a locate frame from any
origin and sheds it only under load, past a budget, too close to the last hop, or outside
its node slots; see the relay rules.
Refusing them outright means the board never transmits on behalf of a device its owner
does not own, which near other people’s Totems is the difference between joining their
mesh and staying out of it.
Config.RelayUnownedturns the firmware’s behaviour on, off by default. It opens the locate path — and only the locate path — to senders outsideowned, and applies the two budgets the firmware applies there (20 requests, 10 replies). Peer, Smart Group and demi-god frames from an unowned sender are still dropped unread either way, and unicasts still only go to owned Totems. What it does not model, because a board sitting beside one Totem cannot reach any of it:is_rx_overloaded, theload_fps/pending_txpair, and the node slots, which need six or more nearby nodes before they shed anything. - It never hosts a Smart Group, because a host’s finalize makes every member delete its existing peers.
- It never sends demi-god commands.