Merge pull request #6 from xJARiD/develop

chore: add instructions on setting wifi for companion via cli rescue

README.md

@@ -168,6 +168,14 @@ Some constrained targets disable the panel to stay within flash limits. For exam
 
 `*_companion_radio_wifi` targets now support persisted WiFi rescue commands:
 
+- open a serial monitor at `115200` baud
+- reboot the device
+- long-press the user button within the first 8 seconds after boot to enter `CLI Rescue`
+- wait for `========= CLI Rescue =========`
+- send the commands from the serial monitor
+
+These rescue commands are only available after entering `CLI Rescue`:
+
 - `get wifi.status`
 - `get wifi.ssid`
 - `get wifi.powersaving`

docs/custom-cli.md

@@ -147,6 +147,13 @@ That allowlist currently includes:
 
 These commands are available in the serial rescue CLI for `*_companion_radio_wifi` builds.
 
+To enter `CLI Rescue`:
+
+- open a serial monitor at `115200` baud
+- reboot the device
+- long-press the user button within the first 8 seconds after boot
+- wait for `========= CLI Rescue =========`
+
 - `get wifi.status`
   - shows configured SSID, connection status, raw WiFi status code, and IP when connected
 - `get wifi.ssid`

docs/local-builds.md

@@ -125,6 +125,12 @@ T_Beam_S3_Supreme_SX1262_companion_radio_wifi
 
 Current companion WiFi builds support persisted WiFi rescue commands:
 
+- open a serial monitor at `115200` baud
+- reboot the device
+- long-press the user button within the first 8 seconds after boot to enter `CLI Rescue`
+- wait for `========= CLI Rescue =========`
+- then run the WiFi rescue commands below from the serial monitor
+
 ```text
 get wifi.status
 get wifi.ssid