2026 docs: review of every README against today's state

- README / CLAUDE.md layout: dongle/, hardware/, tools/ submodule,
  make_remote_hmi.py; telemetry in the protocol; the PC can take the
  robot's place on the radio. CLAUDE.md: NextionUI is on Serial2 (said
  Serial1); remote-without-robot via the dongle + sim.
- remote/README: MPU6050 supply row; stick calibration button names of the
  new SETUP page; upload/USB-port hints.
- remote/NEXTION.md: display on Serial2, how the Editor upload goes.
- robot/README: Battery in the file list, Comms/ServoDriver roles, packet
  structs instead of payload size, check the IMU gives live data (the
  remote's MPU6050 needed a full reset; RobotIMU::begin() only wakes it).
- sim/README: smoke test covers telemetry and servo calibration;
  OpenScadModel.
- dongle/README: AT2401C test result, app command table, SignalRGB note,
  air settings incl. ack payloads.
- PLANNING.md: the display direction is in the generated HMI.
- Unity README: what the project is.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
mangavalkandClaude Opus 5.5 committed 2026-11-17 22:56:14 +01:00
1 parent a59faf3b03
commit 179afdb705
9 files changed
+92 -33

No files matched your search

+10 -5
View File
@@ -1,7 +1,9 @@
# Hexapod
A six-legged walking robot (Teensy 3.6) and its handheld remote
(Teensy 4.0 + Nextion touchscreen), linked over nRF24L01.
(Teensy 4.0 + Nextion touchscreen), linked over nRF24L01: commands from the
remote, telemetry back from the robot. A USB nRF24 stick lets the PC (the
Unity simulation) take the robot's place on the radio.
![The hexapod, OpenSCAD model in its standing pose](hardware/openscad/renders/hexapod.png)
![The remote (v2), OpenSCAD model: black ASA with a red honeycomb and white ON/OFF inlay](hardware/openscad/renders/remote_v2.png)
@@ -11,16 +13,19 @@ printed yet). The original printed remote is on the
[archive page](hardware/openscad/ARCHIVE.md).
```
robot/ robot firmware: IK, gait, body pose, IMU stabilization, state machine
remote/ remote firmware: 2 x 3-axis sticks, MPU6050 tilt, Nextion UI, RF24 TX
shared/ HexapodProtocol: the CmdPacket wire format + radio settings used by both
robot/ robot firmware: IK, gait, body pose, IMU stabilization, state machine,
servo centre calibration, telemetry
remote/ remote firmware: 2 x 3-axis sticks, MPU6050 tilt, Nextion UI, RF24 link
(+ remote.HMI, the touchscreen project)
shared/ HexapodProtocol: CmdPacket + Telemetry wire formats + radio settings
sim/ the unchanged robot firmware compiled into a DLL for the simulation
Hexapod_Simulation_Unity/ Unity project that runs that DLL on the 3D model
dongle/ USB nRF24 stick firmware (STM32F030): the PC-side radio, see dongle/README.md
hardware/openscad/ OpenSCAD model of the robot (rebuilt from the Fusion designs) and the new remote
hardware/openscad/stl/ print-ready STL exports
hardware/fusion360/ Fusion 360 designs: body, legs, servo, servo horn, remote case
scripts/ PlatformIO helper (per-environment sketch folder)
scripts/ PlatformIO helper (per-environment sketch folder), make_remote_hmi.py
tools/nextion-hmi-tools/ git submodule: .HMI reader/writer/renderer (nxhmi), used by the HMI generator
```
This is the `2026-current/` folder of the hexapod-robot repo; the earlier