feat: integrate R8 observer and companion updates

This commit is contained in:
mikecarper committed 2026-08-28 18:39:26 -07:00
1 parent 89c12d416e
commit da61c48e7b
54 files changed
+5471 -158

No files matched your search

+17
View File
@@ -39,6 +39,22 @@ Runtime state can still make an included command fail. Examples include no GPS
fix, no WiFi connection, an inactive bridge, or an nRF52 bootloader without
`.mota` apply support.
## Companion framed CLI
Companion builds are not represented by the role/profile matrices below. Their
local terminal and command `0x42` (`CMD_RUN_CLI_COMMAND`) expose these settings
over the normal binary USB, BLE, or TCP connection:
| Command | Availability |
|---|---|
| [`get/set radio.rxgain`](cli_commands.md#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141) | Companion with a supported radio |
| [`get/set radio.fem.rxgain`](cli_commands.md#view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards) | Companion on a board with controllable LoRa FEM LNA |
| [`get/set wifi.powersave`](cli_commands.md#browser-configuration-portal-esp32-repeater-and-room-server) | ESP32 WiFi Companion; active transport constraints still apply |
| [`get/set bluetooth.name`](cli_commands.md#view-or-change-the-independent-bluetooth-name-companion) | Companion firmware |
Deprecated binary aliases remain receive-only for older clients; new clients
should use command `0x42`. See [Companion radio binary protocol](companion_protocol.md).
## nRF52
| Area | Command | Scope | Standard | Logging | LoRa OTA |
@@ -218,6 +234,7 @@ fix, no WiFi connection, an inactive bridge, or an nRF52 bootloader without
| Operational | [`advert`](cli_commands.md#send-a-flood-advert) | Advert-capable role | Yes | Yes | Yes | Yes | Yes |
| Operational | [`advert.zerohop`](cli_commands.md#send-a-zero-hop-advert) | Advert-capable role | Yes | Yes | Yes | Yes | Yes |
| Operational | [`erase`](cli_commands.md#erasefactory-reset) | Local serial | Serial | Serial | Serial | Serial | Serial |
| Display | [`get/set display.timeout`; `get/set display.flip`](cli_commands.md#set-mqtt-observer-display-timeout-and-flip) | MQTT observer with display; flip needs a supported driver | No | No | No | Feature | No |
| Information | [`ver`](cli_commands.md#get-the-version) | All text CLI roles | Yes | Yes | Yes | Yes | Yes |
| Information | [`board`](cli_commands.md#show-the-hardware-name) | All text CLI roles | Yes | Yes | Yes | Yes | Yes |
| Diagnostics | [`get storage.layout`](cli_commands.md#show-the-storage-layout) | Detected flash size and live partition table | Yes | Yes | Yes | Yes | Yes |
+55
View File
@@ -620,6 +620,42 @@ board's compiled default. Unsupported display drivers return an error.
---
## Set MQTT observer display timeout and flip
MQTT observer builds with a display support a persisted inactivity timeout:
```text
get display.timeout
set display.timeout 0
set display.timeout 60
```
The value is seconds. `0` keeps the display on; `1` through `3600` blanks it
after that much inactivity. The default is `60`. A change applies immediately
and restarts the countdown. On the Heltec V4 R8 Expansion Kit V2 observer, a
panel tap or USER-button click can also blank or wake the display.
Supported observer displays, including the R8 OLED and ST7789 panels, can also
be turned 180 degrees relative to their compiled orientation:
```text
get display.flip
set display.flip off
set display.flip on
```
`0` and `1` are accepted aliases for `off` and `on`. This is intentionally
different from Full Companion `display.rotation`: observer `display.flip` is a
relative 180-degree mounting choice and cannot switch between portrait and
landscape. The value is harmless on an observer display driver that does not
support flipping.
Both settings survive reboot and firmware updates that preserve the filesystem;
erasing flash restores the `60`/`off` defaults. The boot log reports the saved
flip state on display-enabled observer builds.
---
## Logging
Builds compiled with `MESH_PACKET_LOGGING` emit one `RAW:` line for every
@@ -1024,6 +1060,25 @@ Station G2/G3 targets default to `off`.
---
#### View or change the independent Bluetooth name (Companion)
**Usage:**
- `get bluetooth.name`
- `set bluetooth.name <name|default>`
`get ble.name` and `set ble.name ...` are accepted aliases. This command is
specific to Companion firmware. The default is `MeshCore-<advert name>`;
`default` (or `clear`) removes a custom override. Names are limited to 31 valid
UTF-8 bytes without control characters and take effect after reboot.
A binary Companion client should carry the same text in command `0x42`
(`CMD_RUN_CLI_COMMAND`), which works over USB, BLE, or TCP without entering USB
terminal mode. See [Companion radio binary protocol](companion_protocol.md) for
the frame and reply format.
---
#### View or change this node's latitude
**Usage:**
- `get lat`
+23 -4
View File
@@ -237,6 +237,7 @@ catalog; bytes `0x2C`-`0x31` are parked and `0x35` is unused.
| `0x42` | `CMD_RUN_CLI_COMMAND` | Run a local CLI command (protocol v14+). |
| `0x4A` | `CMD_EXEC_LOCAL_OTA_CONTROL` | Run one bounded local TempRadio or OTA command on a Full Companion. |
| `0x4B` | `CMD_BLE_MOTA_SOURCE` | Query, start, or stop an nRF52 Full Companion's Bluetooth-backed LoRa mOTA source. |
| `0x78`-`0x7F` | Deprecated hardware-setting aliases | Receive-only compatibility for clients shipped before command `0x42` became the canonical settings path. |
The sections below detail the most common frames. Refer to the source named
above for command bodies that are not expanded here.
@@ -246,7 +247,9 @@ NUL. The device returns `RESP_CODE_CLI_REPLY` (`0x1D`) followed by the reply
text. This is separate from sending a remote on-air CLI command with
`CMD_SEND_TXT_MSG` and `TXT_TYPE_CLI_COMMAND`. The body must contain at least
one byte and must not contain an embedded NUL. An unknown command is returned
as the normal CLI reply text `Unknown command`, not as an error frame.
as the normal CLI reply text `Unknown command`, not as an error frame. Clients
may prefix the CLI text with any two-character correlation tag and `|` (for
example, `A7|get radio.rxgain`); the reply preserves that prefix.
Firmware from this fork predating the upstream `0x42` allocation used
`0x42`-`0x49` for these eight settings. This firmware accepts those values as
@@ -257,6 +260,21 @@ these settings, rather than allocating additional command bytes. For example,
send `0x42` followed by `get radio.rxgain` or `set radio.rxgain on`. The reply is
`RESP_CODE_CLI_REPLY` followed by the normal CLI reply text.
Two deprecated binary alias blocks remain receive-only for compatibility:
| Setting | Original alias | Later fork alias | GET body/reply | SET body/reply |
|---|---:|---:|---|---|
| FEM receive gain | `0x42` / `0x43` | `0x78` / `0x79` | No body; `OK, state` | One byte `0`/`1`; `OK` |
| Radio receive gain | `0x44` / `0x45` | `0x7A` / `0x7B` | No body; `OK, state` | One byte `0`/`1`; `OK` |
| WiFi power save | `0x46` / `0x47` | `0x7C` / `0x7D` | No body; `OK, mode` | One mode byte `0`-`2`; `OK` |
| Bluetooth name | `0x48` / `0x49` | `0x7E` / `0x7F` | No body; `OK, custom, name` | Zero to 31 UTF-8 bytes; `OK` |
Each pair lists GET then SET. Here `OK` is `RESP_CODE_OK`; the remaining reply
bytes have the same meanings as the CLI settings below. A bare `0x42` is the
old FEM GET, while `0x42` plus at least one text byte is
`CMD_RUN_CLI_COMMAND`. New clients must use the framed CLI form; these aliases
exist only so deployed clients do not break after a firmware update.
The equivalent framed CLI commands are:
| Setting | Commands |
@@ -284,9 +302,10 @@ also rejects `max`, because maximum modem sleep can miss broadcasts that the
access point cannot buffer. If an older image saved `max`, the effective mode
is capped to and reported as `min`. Device `powersaving` remains independent.
The Bluetooth name can be configured over USB or TCP before rebooting into BLE.
An empty/default selection restores `MeshCore-<advert name>`; a custom name is
limited to 31 valid UTF-8 bytes and takes effect after reboot.
The Bluetooth name can be configured over USB, BLE, or TCP. Use
`set bluetooth.name default` to restore `MeshCore-<advert name>`; an empty CLI
value is rejected. (`clear` is also accepted as an alias for `default`.) A
custom name is limited to 31 valid UTF-8 bytes and takes effect after reboot.
### Bluetooth LoRa mOTA source