From 6c4c17d7407d6ac8260c079589560d57d35ce74f Mon Sep 17 00:00:00 2001 From: user Date: Wed, 4 Feb 2026 15:37:44 +0100 Subject: [PATCH] docs: Add esp-cmd usage and LED states to cheatsheet --- docs/CHEATSHEET.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/CHEATSHEET.md b/docs/CHEATSHEET.md index f7eeecf..0f97938 100644 --- a/docs/CHEATSHEET.md +++ b/docs/CHEATSHEET.md @@ -29,7 +29,34 @@ idf.py reconfigure # Re-fetch managed components | amber-maple | 192.168.129.30 | Office | | hollow-acorn | 192.168.129.31 | Kitchen | -**Target:** `192.168.129.11:5500` (Pi) +**Target:** `192.168.129.11:5500` (Pi) | **Cmd port:** `5501` + +## Remote Management (esp-cmd) + +```bash +esp-cmd STATUS # Uptime, heap, RSSI, tx_power, rate +esp-cmd IDENTIFY # LED solid 5s (find the device) +esp-cmd RATE 50 # Set ping rate to 50 Hz (NVS saved) +esp-cmd POWER 15 # Set TX power to 15 dBm (NVS saved) +esp-cmd REBOOT # Restart device +``` + +Examples with deployed sensors: + +```bash +esp-cmd 192.168.129.29 STATUS # muddy-storm +esp-cmd 192.168.129.30 IDENTIFY # amber-maple +esp-cmd 192.168.129.31 RATE 25 # hollow-acorn +``` + +### LED States + +| LED | Meaning | +|-----|---------| +| Off | Not connected to WiFi | +| Slow blink (1 Hz) | Connected, no CSI activity | +| Fast blink (5 Hz) | CSI data flowing | +| Solid (5s) | IDENTIFY command active | ## Test CSI Reception @@ -70,7 +97,8 @@ secondary_channel,timestamp,ant,sig_len,rx_state,len,first_word,"[I,Q,...]" | File | Purpose | |------|---------| | `get-started/csi_recv_router/main/app_main.c` | Main firmware source | -| `get-started/csi_recv_router/main/Kconfig.projbuild` | UDP target config | +| `get-started/csi_recv_router/main/Kconfig.projbuild` | UDP/cmd port config | +| `tools/esp-cmd` | Pi-side management CLI | | `get-started/csi_recv_router/sdkconfig.defaults` | SDK defaults | | `get-started/csi_recv_router/main/idf_component.yml` | Dependencies | | `get-started/csi_recv_router/CMakeLists.txt` | Build config |