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

+8 -1
View File
@@ -7,7 +7,14 @@ It's **generated** by `../scripts/make_remote_hmi.py`: change the layout
there and re-run it, rather than editing the `.HMI` in Nextion Editor (an
Editor edit is lost on the next run). Then open `remote.HMI` in Nextion
Editor, compile, and upload the `.tft`: SETUP › UPDATE DISPLAY (tap twice)
or serial key `U` puts the remote in USB passthrough for the upload.
or serial key `U` puts the remote in USB passthrough for the upload. In the
Editor, upload to the Teensy's COM port with the baud rate on auto. When the
Editor is newer than the display's firmware, the upload first updates that
firmware: don't interrupt it. Power-cycle the remote afterwards to leave
upload mode.
The display is on the remote's **Serial2** (Teensy RX2 = pin 7, TX2 = pin 8),
at 115200.
```
python scripts\make_remote_hmi.py (from 2026-current)
+11 -5
View File
@@ -22,6 +22,10 @@ USB nRF24 dongle (`../sim/README.md`).
From the `2026-current` folder: `pio run -e remote`, flash with
`pio run -e remote -t upload`, monitor with `pio device monitor -e remote`.
The upload opens Teensy Loader; if the Teensy doesn't reboot into it by
itself, press its program button. If flashing works but the USB serial port
then won't open or goes quiet, try another USB port or cable before
suspecting the firmware (a bare Teensy 4.0 showed exactly that on one port).
## Wiring (edge headers only; edit `Config.h` if yours differs)
@@ -31,6 +35,7 @@ From the `2026-current` folder: `pio run -e remote`, flash with
| nRF24L01 | CE / CSN | 9 / 10 |
| nRF24L01 | VCC | 3.3 V, with a 10–100 µF cap right at the module |
| MPU6050 | SDA / SCL | **18 / 19 (Wire)** |
| MPU6050 | VCC | 3.3 V (a GY-521 runs fine on it). Check the polarity: one supply reversal killed the first board's regulator |
| Nextion | TX → RX2, RX ← TX2 | 7 / 8 (Serial2), 5 V supply (found on the real remote) |
| Sticks | 6 axes | left stick X / Y / twist on **A3 / A7 / A8** (17 / 21 / 22), right stick on **A0 / A1 / A2** (14 / 15 / 16). A7/A8 hold the two wires that were on A4/A5 (18/19). All but the right twist read inverted (`STICK_INVERT`). Checked on the real remote |
| Battery (planned) | divider | A6 (20) |
@@ -124,12 +129,13 @@ reads it after every send, and it counts as stale after
1. Power on with both sticks released and the remote held still. Each
axis's resting center is captured automatically.
2. For full calibration, disarm, then tap **CAL** (or press `c` on the
serial console). Move every axis of both sticks to both limits, release
them, and tap **SAVE CAL** (`c`). The result is saved to EEPROM.
2. For full calibration, disarm, then tap **CAL STICKS** on the SETUP page
(or press `c` on the serial console). Move every axis of both sticks to
both limits, release them, and tap **SAVE CAL** (`c`). The result is
saved to EEPROM, so it survives power cycles and reflashing.
3. If any axis moved less than `CAL_MIN_HALF_SPAN` either side of center,
the save is refused and you stay in calibration mode. **CANCEL CAL**
(`x`) aborts.
the save is refused and you stay in calibration mode. **CANCEL** (`x`)
aborts.
4. `p` prints the calibration in a form you can paste into `Config.h`
defaults. `R` wipes EEPROM back to the `Config.h` defaults.