Allow local CLI maintenance across direct connections
This commit is contained in:
1 parent
001b4985f7
commit
06c51fdef5
39 files changed
+3338
-2312
No files matched your search
+13
-6
@@ -372,7 +372,8 @@ On a `companion_radio_full` build, port 5002 is the same role-specific text
|
||||
terminal available over USB, including chat, remote administration, radio and
|
||||
power settings, WiFi/WebConfig management, `tempradio`, and the source-only
|
||||
`ota` commands. Other
|
||||
OTA-enabled Companion builds keep the bounded `ota ...` console. LoRa staging
|
||||
OTA-enabled Companion builds expose the same local maintenance commands as
|
||||
binary command `0x42`, plus `ota ...` commands. LoRa staging
|
||||
and installation on the Full Companion itself remain disabled.
|
||||
|
||||
Port 5002 is plaintext and has no independent login gate. Use it only on a
|
||||
@@ -468,8 +469,8 @@ An inactive status is normal when `webui` is off: run `start webconfig` to
|
||||
connect temporarily. Standalone credentials can be changed through WebConfig
|
||||
or with the listed CLI commands. Changing the SSID or password stops an active
|
||||
WebConfig session; start it again to connect with the new values. Use
|
||||
`set wifi.pwd` with no value for an open network. The password is write-only
|
||||
and is never returned by `get`. Standalone WiFi accepts ordinary passphrases up
|
||||
`set wifi.pwd` with no value for an open network. `get wifi.pwd` returns the saved password on a local connection; LoRa
|
||||
callers cannot read it. Standalone WiFi accepts ordinary passphrases up
|
||||
to 63 characters and exact 64-character hexadecimal WPA/WPA2 PSKs; other
|
||||
64-character values and all longer values are rejected. MQTT observer WiFi
|
||||
passwords remain limited to 63 characters by their fixed persisted layout.
|
||||
@@ -492,8 +493,14 @@ get wifi.cli
|
||||
The saved `on` setting becomes active only when the WiFi station client is
|
||||
connected and WebConfig is running in LAN mode. It is never exposed on the open
|
||||
setup access point. When active, the WebConfig page has a **CLI** tab. Repeater
|
||||
and room-server commands use the authenticated administrator parser; commands
|
||||
restricted to a physical serial connection remain unavailable there.
|
||||
and room-server commands use their local CLI after admin authentication.
|
||||
The browser can run `get password`, `get prv.key`, `erase`, `set freq`,
|
||||
`stats-core`, `stats-radio`, `stats-radio-diag`, `stats-packets`, and explicit
|
||||
WiFi/MQTT credential getters. It also streams `get acl` and raw `log` dumps
|
||||
back to the browser. Log reads pause for slow clients and resume as output is
|
||||
read, using a fixed 160-byte file chunk. A dump snapshots the file length, so
|
||||
live logging cannot extend it indefinitely. The browser keeps the complete
|
||||
requested dump, including files larger than 64 KiB.
|
||||
|
||||
Companion uses the same complete terminal as USB and Full Companion TCP port
|
||||
5002, including `card`, `import meshcore://...`, `list`, `to`, messages, remote
|
||||
@@ -503,7 +510,7 @@ for contact import, terminal ownership, and disconnect behavior.
|
||||
|
||||
Type a command at the prompt, or paste multiple lines and confirm the sequence.
|
||||
Blank lines and comments are ignored. The device reports the supported batch
|
||||
limit. Companion sends each line after the previous command finishes and
|
||||
limit. The browser sends each line after the previous command finishes and
|
||||
continues polling for incoming text after the sequence. `help` lists the
|
||||
device's actual terminal commands; Tab completes command names and settings.
|
||||
|
||||
|
||||
@@ -63,6 +63,11 @@ limits reduce selected Generic E22, Heltec V2, Meshadventurer, T-Beam OTA/MQTT,
|
||||
and TLora MQTT profiles to 50. Check the artifact capability manifest and
|
||||
[ESP32 memory budget](esp32_memory_budget.md) for the exact target.
|
||||
|
||||
See [local maintenance commands](terminal_chat_cli.md#local-maintenance-commands)
|
||||
for USB, BLE/binary Companion, TCP/Ethernet, and browser CLI privileges.
|
||||
A direct connection can access local diagnostics and explicit credential
|
||||
getters; relaying a command over LoRa keeps its remote restrictions.
|
||||
|
||||
## Profile matrix
|
||||
|
||||
| Build/profile | Command availability |
|
||||
|
||||
@@ -9,7 +9,11 @@ sensor, and bridge firmware. Full Companion also has its own ASCII USB/TCP
|
||||
terminal; see [feature switches by role](role_feature_switches.md). Companion
|
||||
apps use the companion protocol,
|
||||
KISS firmware uses framed KISS/TNC commands, and terminal-chat firmware has its
|
||||
own interface, so those build roles are not represented here.
|
||||
own interface, so those build roles are not represented in the main matrices.
|
||||
The Companion section below lists its framed maintenance commands.
|
||||
Infrastructure `get password` is available locally in every profile; LoRa
|
||||
requests cannot read it. `get acl` and stored packet `log` are infrastructure
|
||||
features, not Companion contact or live USB-logging commands.
|
||||
|
||||
Build columns mean:
|
||||
|
||||
@@ -45,7 +49,9 @@ Cell values mean:
|
||||
- **No** - the profile does not expose the command.
|
||||
- **Feature** - available only when the target compiles the feature or hardware
|
||||
named in Scope.
|
||||
- **Serial** - available only from the local serial console.
|
||||
- **Local** - a direct USB, BLE/binary Companion, TCP/Ethernet, or LAN browser
|
||||
connection, when that transport and command exist on the role; unavailable
|
||||
over LoRa.
|
||||
- **Manifest** - available only when the MQTT target defines
|
||||
`OTA_MANIFEST_BASE`.
|
||||
- **Limited** - the family exists, but the limitation in Scope applies.
|
||||
@@ -62,6 +68,11 @@ over the normal binary USB, BLE, or TCP connection:
|
||||
|
||||
| Command | Availability |
|
||||
|---|---|
|
||||
| `stats-core`, `stats-radio`, `stats-radio-diag`, `stats-packets` | Local terminal and binary command `0x42` |
|
||||
| `erase`, `set freq <MHz>` | Local terminal and binary command `0x42`; stored changes apply on reboot |
|
||||
| `get prv.key` | Local terminal and binary command `0x42`; requires private key export enabled |
|
||||
| `get password` | Reports that Companion has no admin password; infrastructure returns its password locally |
|
||||
| `get wifi.pwd`, `get mqttN.password`, `get mqttN.token` | Local terminal and binary command `0x42`; corresponding WiFi/MQTT feature required |
|
||||
| [`board`](cli_commands.md#show-the-hardware-name) | Every Companion text terminal and command `0x42` |
|
||||
| [`version`](cli_commands.md#get-the-version) | Every Companion text terminal and protocol-v14 command `0x42`; returns the untruncated build identity |
|
||||
| [`get storage.layout`](cli_commands.md#show-the-storage-layout) | Every Companion text terminal and command `0x42`; reports the running platform's storage layout |
|
||||
@@ -82,14 +93,14 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
|---|---|---|---|---|---|
|
||||
| Operational | [`reboot`](cli_commands.md#reboot-the-node) | All text CLI roles | Yes | Yes | Yes |
|
||||
| Operational | [`poweroff`; `shutdown`](cli_commands.md#power-off-the-node) | Board power-off support | Yes | Yes | Yes |
|
||||
| Operational | [`uf2reset`](cli_commands.md#enter-the-uf2-bootloader-nrf52-only) | Local serial; supported UF2 boards | Serial | Serial | Serial |
|
||||
| Operational | [`uf2reset`](cli_commands.md#enter-the-uf2-bootloader-nrf52-only) | Local connection; supported UF2 boards | Local | Local | Local |
|
||||
| Operational | [`clkreboot`](cli_commands.md#reset-the-clock-and-reboot) | All text CLI roles | Yes | Yes | Yes |
|
||||
| Operational | [`clock sync`](cli_commands.md#sync-the-clock-with-the-remote-device) | All text CLI roles | Yes | Yes | Yes |
|
||||
| Operational | [`clock`](cli_commands.md#display-current-time-in-utc) | All text CLI roles | Yes | Yes | Yes |
|
||||
| Operational | [`time <epoch_seconds>`](cli_commands.md#set-the-time-to-a-specific-timestamp) | Clock only moves forward | Yes | Yes | Yes |
|
||||
| Operational | [`advert`](cli_commands.md#send-a-flood-advert) | Advert-capable role | Yes | Yes | Yes |
|
||||
| Operational | [`advert.zerohop`](cli_commands.md#send-a-zero-hop-advert) | Advert-capable role | Yes | Yes | Yes |
|
||||
| Operational | [`erase`](cli_commands.md#erasefactory-reset) | Local serial | Serial | Serial | Serial |
|
||||
| Operational | [`erase`](cli_commands.md#erasefactory-reset) | Local connection | Local | Local | Local |
|
||||
| Information | [`ver`](cli_commands.md#get-the-version) | All text CLI roles | Yes | Yes | Yes |
|
||||
| Information | [`board`](cli_commands.md#show-the-hardware-name) | All text CLI roles | Yes | Yes | Yes |
|
||||
| Diagnostics | [`get storage.layout`](cli_commands.md#show-the-storage-layout) | Internal layout and configured QSPI or SD storage | Yes | Yes | Yes |
|
||||
@@ -101,20 +112,20 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| Neighbors | [`discover.neighbors`](cli_commands.md#discover-zero-hop-neighbors) | Repeater; some MQTT room servers | Yes | Yes | Yes |
|
||||
| Neighbors | [`discover.scopes`](cli_commands.md#discover-neighbor-scopes-mqtt-observer-neighbors-feature) | MQTT observer with compiled neighbor support | No | No | No |
|
||||
| Statistics | [`clear stats`](cli_commands.md#clear-stats) | All full-parser text CLI roles | Yes | Yes | Yes |
|
||||
| Statistics | [`stats-core`](cli_commands.md#stats-core) | Local serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-radio`](cli_commands.md#stats-radio) | Local serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-radio-diag`](#stats-radio-diag) | Local serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-packets`](cli_commands.md#stats-packets) | Local serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-core`](cli_commands.md#stats-core) | Local connection | Local | Local | Local |
|
||||
| Statistics | [`stats-radio`](cli_commands.md#stats-radio) | Local connection | Local | Local | Local |
|
||||
| Statistics | [`stats-radio-diag`](#stats-radio-diag) | Local connection | Local | Local | Local |
|
||||
| Statistics | [`stats-packets`](cli_commands.md#stats-packets) | Local connection | Local | Local | Local |
|
||||
| Statistics | [`get telemetry.temp/volt/volt.i2c`; optional GPS history](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater or room server; I2C command requires a detected voltage monitor; GPS requires a provider; remote access requires administrator | Yes | Yes | Yes |
|
||||
| Statistics | [`set telemetry.gps`; `get/set/send telemetry.tx`](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater; GPS setting requires a provider; remote access requires administrator | Yes | Yes | Yes |
|
||||
| Logging | [`log start`; `log stop`; `log erase`](cli_commands.md#logging) | Storage-backed roles retain data; other roles can return empty data | Yes | Yes | Yes |
|
||||
| Logging | [`log`](cli_commands.md#print-the-captured-log-to-the-serial-terminal) | Local serial | Serial | Serial | Serial |
|
||||
| Logging | [`log`](cli_commands.md#print-the-captured-log-to-the-serial-terminal) | Local connection | Local | Local | Local |
|
||||
| Logging | [`get/set usb.logging`; unified FULL `get/set logging.output`](cli_commands.md#control-live-usb-logging) | Ordinary safe-USB artifacts; CommonCLI USB gate is persistent; unified ESP32 FULL selects off/USB/WiFi/both; nRF52 Full Companion can add a reboot-controlled second CDC | Yes | Yes | No |
|
||||
| Radio | [`get radio`; `set radio ...`](cli_commands.md#view-or-change-this-nodes-radio-parameters) | All text CLI roles | Yes | Yes | Yes |
|
||||
| Radio | [`get tx`; `set tx <dbm>`](cli_commands.md#view-or-change-this-nodes-transmit-power) | Board TX-power limits apply | Yes | Yes | Yes |
|
||||
| Radio | [`tempradio ...`; `normalradio`](cli_commands.md#change-the-radio-parameters-for-a-set-duration) | Full parser | Yes | Yes | Yes |
|
||||
| Radio | [`get/set/del radioat`; `get/set/del tempradioat`](cli_commands.md#schedule-radio-parameter-changes) | Full parser | Yes | Yes | Yes |
|
||||
| Radio | [`get freq`; `set freq <mhz>`](cli_commands.md#view-or-change-this-nodes-frequency) | `set` is local serial only | Yes | Yes | Yes |
|
||||
| Radio | [`get freq`; `set freq <mhz>`](cli_commands.md#view-or-change-this-nodes-frequency) | `set` requires a local connection | Yes | Yes | Yes |
|
||||
| Radio | [`get/set radio.rxgain`](cli_commands.md#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141) | Supported radio | Feature | Feature | Feature |
|
||||
| Radio | [`get/set radio.fem.rxgain`](cli_commands.md#view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards) | Controllable LoRa FEM | Feature | Feature | Feature |
|
||||
| Radio | [`get/set radio.fem.txgain`](cli_commands.md#view-or-change-the-lora-fem-transmit-path-gain-state-on-supported-boards) | Controllable LoRa FEM | Feature | Feature | Feature |
|
||||
@@ -122,8 +133,8 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| System | [`get/set name`](cli_commands.md#view-or-change-this-nodes-name) | All text CLI roles | Yes | Yes | Yes |
|
||||
| System | [`get/set lat`](cli_commands.md#view-or-change-this-nodes-latitude) | All text CLI roles | Yes | Yes | Yes |
|
||||
| System | [`get/set lon`](cli_commands.md#view-or-change-this-nodes-longitude) | All text CLI roles | Yes | Yes | Yes |
|
||||
| System | [`get/set prv.key`](cli_commands.md#view-or-change-this-nodes-identity-private-key) | `get` is local serial only | Yes | Yes | Yes |
|
||||
| System | [`password <new_password>`](cli_commands.md#change-this-nodes-admin-password) | Administrator | Yes | Yes | Yes |
|
||||
| System | [`get/set prv.key`](cli_commands.md#view-or-change-this-nodes-identity-private-key) | `get` requires a local connection | Yes | Yes | Yes |
|
||||
| System | [`get password`; `password <new_password>`](cli_commands.md#change-this-nodes-admin-password) | `get` requires a local connection; setter requires administrator | Yes | Yes | Yes |
|
||||
| System | [`get/set guest.password`](cli_commands.md#view-or-change-this-nodes-guest-password) | Role with guest administration | Yes | Yes | Yes |
|
||||
| System | [`get/set owner.info`](cli_commands.md#view-or-change-this-nodes-owner-info) | All text CLI roles | Yes | Yes | Yes |
|
||||
| System | [`get/set adc.multiplier`](cli_commands.md#fine-tune-the-battery-reading) | Board ADC override support | Feature | Feature | Feature |
|
||||
@@ -164,7 +175,7 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| Routing | [`get/set outpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes |
|
||||
| Routing | [`get/set altpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes |
|
||||
| ACL | [`setperm <pubkey> <permissions>`](cli_commands.md#add-update-or-remove-permissions-for-a-companion) | Repeater, room server, or sensor | Yes | Yes | Yes |
|
||||
| ACL | [`get acl`](cli_commands.md#view-the-current-acl) | Local serial | Serial | Serial | Serial |
|
||||
| ACL | [`get acl`](cli_commands.md#view-the-current-acl) | Local connection | Local | Local | Local |
|
||||
| ACL | [`get/set allow.read.only`](cli_commands.md#view-or-change-this-room-servers-read-only-flag) | Room server | Yes | Yes | No |
|
||||
| Regions | [`region load`](cli_commands.md#bulk-load-region-lists); [`region save`](cli_commands.md#save-any-changes-to-regions-made-since-reboot) | Role with region storage | Yes | Yes | Yes |
|
||||
| Regions | [`region allowf`](cli_commands.md#allow-a-region); [`region denyf`](cli_commands.md#block-a-region) | Role with region storage | Yes | Yes | Yes |
|
||||
@@ -232,7 +243,7 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| MQTT | [`get mqtt.ntp.diag`](cli_commands.md#diagnose-ntp-server-connectivity-mqtt-observer-only) | Full MQTT observer | No | No | No |
|
||||
| MQTT | [`get/set timezone`; `get/set timezone.offset`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#timezone-commands) | MQTT observer | No | No | No |
|
||||
| MQTT | [`get/set mqtt.analyzer.us`; `get/set mqtt.analyzer.eu`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#migration-from-old-configuration) | Legacy MQTT aliases | No | No | No |
|
||||
| MQTT | [`get/set mqtt.owner`; `get/set mqtt.email`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#mqtt-shared-commands) | MQTT observer; `get` is local serial only | No | No | No |
|
||||
| MQTT | [`get/set mqtt.owner`; `get/set mqtt.email`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#mqtt-shared-commands) | MQTT observer; `get` requires a local connection | No | No | No |
|
||||
| MQTT | [`get mqtt.config.valid`](#mqtt-config-valid) | MQTT observer | No | No | No |
|
||||
| SNMP | [`get/set snmp`; `get/set snmp.community`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_SNMP.md#cli-commands) | MQTT target compiled with SNMP | No | No | No |
|
||||
| Alerts | [`get/set alert`; `get/set alert.psk`; `get/set alert.hashtag`; `get/set alert.region`; `get/set alert.wifi`; `get/set alert.mqtt`; `get/set alert.interval`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/ALERTS.md#cli) | MQTT observer | No | No | No |
|
||||
@@ -254,7 +265,7 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| Operational | [`time <epoch_seconds>`](cli_commands.md#set-the-time-to-a-specific-timestamp) | Clock only moves forward | Yes | Yes | Yes | Yes | Yes |
|
||||
| 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 |
|
||||
| Operational | [`erase`](cli_commands.md#erasefactory-reset) | Local connection | Local | Local | Local | Local | Local |
|
||||
| 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 |
|
||||
@@ -267,20 +278,20 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| Neighbors | [`discover.neighbors`](cli_commands.md#discover-zero-hop-neighbors) | Repeater; some MQTT room servers | Yes | Yes | Yes | Yes | Yes |
|
||||
| Neighbors | [`discover.scopes`](cli_commands.md#discover-neighbor-scopes-mqtt-observer-neighbors-feature) | MQTT observer with compiled neighbor support | No | No | No | Feature | No |
|
||||
| Statistics | [`clear stats`](cli_commands.md#clear-stats) | Full parser | Yes | Yes | Yes | Yes | Yes |
|
||||
| Statistics | [`stats-core`](cli_commands.md#stats-core) | Local serial | Serial | Serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-radio`](cli_commands.md#stats-radio) | Local serial | Serial | Serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-radio-diag`](#stats-radio-diag) | Local serial | Serial | Serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-packets`](cli_commands.md#stats-packets) | Local serial | Serial | Serial | Serial | Serial | Serial |
|
||||
| Statistics | [`stats-core`](cli_commands.md#stats-core) | Local connection | Local | Local | Local | Local | Local |
|
||||
| Statistics | [`stats-radio`](cli_commands.md#stats-radio) | Local connection | Local | Local | Local | Local | Local |
|
||||
| Statistics | [`stats-radio-diag`](#stats-radio-diag) | Local connection | Local | Local | Local | Local | Local |
|
||||
| Statistics | [`stats-packets`](cli_commands.md#stats-packets) | Local connection | Local | Local | Local | Local | Local |
|
||||
| Statistics | [`get telemetry.temp/volt/volt.i2c`; optional GPS history](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater or room server; I2C command requires a detected voltage monitor; GPS requires a provider; remote access requires administrator | Yes | Yes | Yes | Yes | Yes |
|
||||
| Statistics | [`set telemetry.gps`; `get/set/send telemetry.tx`](cli_commands.md#read-repeater-telemetry-history) | Non-STM32 repeater; GPS setting requires a provider; remote access requires administrator | Yes | Yes | Yes | Yes | Yes |
|
||||
| Logging | [`log start`; `log stop`; `log erase`](cli_commands.md#logging) | Storage-backed roles retain data | Yes | Yes | Yes | Yes | Yes |
|
||||
| Logging | [`log`](cli_commands.md#print-the-captured-log-to-the-serial-terminal) | Local serial | Serial | Serial | Serial | Serial | Serial |
|
||||
| Logging | [`log`](cli_commands.md#print-the-captured-log-to-the-serial-terminal) | Local connection | Local | Local | Local | Local | Local |
|
||||
| Logging | [`get/set usb.logging`; unified FULL `get/set logging.output`](cli_commands.md#control-live-usb-logging) | Ordinary safe-USB artifacts; CommonCLI USB gate is persistent; unified ESP32 FULL selects off/USB/WiFi/both; every ESP32 Full Companion uses an input-capable single-TTY logging terminal with framed USB Companion disabled while logging | Yes | Yes | No | No | Yes |
|
||||
| Radio | [`get radio`; `set radio ...`](cli_commands.md#view-or-change-this-nodes-radio-parameters) | All text CLI roles | Yes | Yes | Yes | Yes | Yes |
|
||||
| Radio | [`get tx`; `set tx <dbm>`](cli_commands.md#view-or-change-this-nodes-transmit-power) | Board TX-power limits apply | Yes | Yes | Yes | Yes | Yes |
|
||||
| Radio | [`tempradio ...`; `normalradio`](cli_commands.md#change-the-radio-parameters-for-a-set-duration) | Full parser | Yes | Yes | Yes | Yes | Yes |
|
||||
| Radio | [`get/set/del radioat`; `get/set/del tempradioat`](cli_commands.md#schedule-radio-parameter-changes) | Full parser | Yes | Yes | Yes | Yes | Yes |
|
||||
| Radio | [`get freq`; `set freq <mhz>`](cli_commands.md#view-or-change-this-nodes-frequency) | `set` is local serial only | Yes | Yes | Yes | Yes | Yes |
|
||||
| Radio | [`get freq`; `set freq <mhz>`](cli_commands.md#view-or-change-this-nodes-frequency) | `set` requires a local connection | Yes | Yes | Yes | Yes | Yes |
|
||||
| Radio | [`get/set radio.rxgain`](cli_commands.md#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141) | Supported radio | Feature | Feature | Feature | Feature | Feature |
|
||||
| Radio | [`get/set espnow.channel`](cli_commands.md#view-or-change-the-primary-esp-nowwifi-channel) | Primary ESP-NOW mesh radio | Feature | Feature | Feature | Feature | Feature |
|
||||
| Radio | [`get/set radio.fem.rxgain`](cli_commands.md#view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards) | Controllable LoRa FEM | Feature | Feature | Feature | Feature | Feature |
|
||||
@@ -289,8 +300,8 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| System | [`get/set name`](cli_commands.md#view-or-change-this-nodes-name) | All full-parser text CLI roles | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get/set lat`](cli_commands.md#view-or-change-this-nodes-latitude) | All full-parser text CLI roles | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get/set lon`](cli_commands.md#view-or-change-this-nodes-longitude) | All full-parser text CLI roles | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get/set prv.key`](cli_commands.md#view-or-change-this-nodes-identity-private-key) | `get` is local serial only | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`password <new_password>`](cli_commands.md#change-this-nodes-admin-password) | Administrator | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get/set prv.key`](cli_commands.md#view-or-change-this-nodes-identity-private-key) | `get` requires a local connection | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get password`; `password <new_password>`](cli_commands.md#change-this-nodes-admin-password) | `get` requires a local connection; setter requires administrator | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get/set guest.password`](cli_commands.md#view-or-change-this-nodes-guest-password) | Role with guest administration | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get/set owner.info`](cli_commands.md#view-or-change-this-nodes-owner-info) | Full parser | Yes | Yes | Yes | Yes | Yes |
|
||||
| System | [`get/set adc.multiplier`](cli_commands.md#fine-tune-the-battery-reading) | Board ADC override support | Feature | Feature | Feature | Feature | Feature |
|
||||
@@ -331,7 +342,7 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| Routing | [`get/set outpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes | Yes | Yes |
|
||||
| Routing | [`get/set altpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes | Yes | Yes |
|
||||
| ACL | [`setperm <pubkey> <permissions>`](cli_commands.md#add-update-or-remove-permissions-for-a-companion) | Repeater, room server, or sensor | Yes | Yes | Yes | Yes | Yes |
|
||||
| ACL | [`get acl`](cli_commands.md#view-the-current-acl) | Local serial | Serial | Serial | Serial | Serial | Serial |
|
||||
| ACL | [`get acl`](cli_commands.md#view-the-current-acl) | Local connection | Local | Local | Local | Local | Local |
|
||||
| ACL | [`get/set allow.read.only`](cli_commands.md#view-or-change-this-room-servers-read-only-flag) | Room server | Yes | Yes | No | Yes | Yes |
|
||||
| Regions | [`region load`](cli_commands.md#bulk-load-region-lists); [`region save`](cli_commands.md#save-any-changes-to-regions-made-since-reboot) | Role with region storage | Yes | Yes | Yes | Yes | Yes |
|
||||
| Regions | [`region allowf`](cli_commands.md#allow-a-region); [`region denyf`](cli_commands.md#block-a-region) | Role with region storage | Yes | Yes | Yes | Yes | Yes |
|
||||
@@ -399,7 +410,7 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| MQTT | [`get mqtt.ntp.diag`](cli_commands.md#diagnose-ntp-server-connectivity-mqtt-observer-only) | MQTT observer | No | No | No | Yes | No |
|
||||
| MQTT | [`get/set timezone`; `get/set timezone.offset`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#timezone-commands) | MQTT observer | No | No | No | Yes | No |
|
||||
| MQTT | [`get/set mqtt.analyzer.us`; `get/set mqtt.analyzer.eu`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#migration-from-old-configuration) | Legacy MQTT aliases | No | No | No | Yes | No |
|
||||
| MQTT | [`get/set mqtt.owner`; `get/set mqtt.email`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#mqtt-shared-commands) | MQTT observer; `get` is local serial only | No | No | No | Yes | No |
|
||||
| MQTT | [`get/set mqtt.owner`; `get/set mqtt.email`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md#mqtt-shared-commands) | MQTT observer; `get` requires a local connection | No | No | No | Yes | No |
|
||||
| MQTT | [`get mqtt.config.valid`](#mqtt-config-valid) | MQTT observer | No | No | No | Yes | No |
|
||||
| SNMP | [`get/set snmp`; `get/set snmp.community`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_SNMP.md#cli-commands) | MQTT target compiled with SNMP | No | No | No | Feature | No |
|
||||
| Alerts | [`get/set alert`; `get/set alert.psk`; `get/set alert.hashtag`; `get/set alert.region`; `get/set alert.wifi`; `get/set alert.mqtt`; `get/set alert.interval`](https://github.com/mikecarper/MeshCore/blob/keymindCascade/ALERTS.md#cli) | MQTT observer | No | No | No | Yes | No |
|
||||
|
||||
+45
-21
@@ -80,7 +80,8 @@ command aliases are listed there explicitly.
|
||||
**Usage:**
|
||||
- `uf2reset`
|
||||
|
||||
**Serial Only:** Yes
|
||||
**Local connection only:** USB, direct network CLI, or Companion binary
|
||||
command `0x42` where the role supports the command; unavailable over LoRa.
|
||||
|
||||
**Note:** Reboots directly into the UF2 bootloader on supported nRF52 boards.
|
||||
This includes the Repeater, Room Server, Sensor, Companion, and Terminal Chat
|
||||
@@ -213,6 +214,7 @@ folder transport.
|
||||
- `set webui off`
|
||||
- `get webui`
|
||||
- `get wifi.ssid`
|
||||
- `get wifi.pwd`
|
||||
- `get wifi.status`
|
||||
- `get wifi.powersave`
|
||||
- `get wifi.cli`
|
||||
@@ -252,8 +254,8 @@ their profile's idle timeout.
|
||||
Every ESP32 build with WebConfig supports the browser command terminal,
|
||||
including WiFi Companion and Full Companion. Companions use their complete
|
||||
USB/TCP terminal on the trusted LAN, including contact import, chat, recipient
|
||||
selection, and delayed replies. Repeater and Room Server use the authenticated
|
||||
admin parser.
|
||||
selection, and delayed replies. Repeater and Room Server use their local CLI
|
||||
after admin authentication.
|
||||
|
||||
To add a Companion contact, run `import meshcore://<full-contact-card-data>`,
|
||||
then `list` to confirm it appears. Get the complete card with `card` on the
|
||||
@@ -266,8 +268,12 @@ the **CLI** tab.
|
||||
`get wifi.cli` reports `off`, `on, waiting for WiFi client`, or `on, active`.
|
||||
The saved setting becomes active only in station/LAN mode while the WiFi client
|
||||
is connected. It is deliberately unavailable on the open setup access point.
|
||||
The tab displays each reply in the browser. Commands explicitly restricted to
|
||||
a physical serial connection remain unavailable.
|
||||
The tab displays each reply in the browser, including local diagnostics,
|
||||
`get password`, private-key and WiFi/MQTT credential reads, `erase`, and
|
||||
`set freq`. Infrastructure `get acl` and raw `log` stream to the requesting
|
||||
browser, with backpressure for slow clients. LoRa callers retain their
|
||||
restrictions. The bounded `/api/cli` endpoint accepts local maintenance
|
||||
commands; use `/api/terminal` for complete ACL and log listings.
|
||||
Select **Command block** to paste up to 100 commands with one command per line.
|
||||
Blank lines are ignored, and every nonblank line must fit the normal 159-byte
|
||||
CLI command limit. The browser sends the lines sequentially and waits for each
|
||||
@@ -302,8 +308,9 @@ ordinary passphrases remain limited to 63 characters. Other 64-character values
|
||||
and all longer values are rejected. MQTT observer WiFi passwords retain their
|
||||
fixed 63-character limit.
|
||||
Power-save changes are applied immediately when WiFi is running and otherwise
|
||||
take effect on the next connection. `get wifi.pwd` is intentionally unavailable
|
||||
so the standalone password is never returned by the CLI.
|
||||
take effect on the next connection. `get wifi.pwd` returns the saved password
|
||||
on a local connection. It remains unavailable or masked over LoRa, and the
|
||||
configuration form continues to mask stored secrets.
|
||||
|
||||
ESP32 WiFi Companion WebConfig exposes the same `wifi.powersave` values in its
|
||||
WiFi card. Every ESP32 WiFi Companion with WebConfig exposes the standalone
|
||||
@@ -314,7 +321,9 @@ restarting the WiFi station, so a TCP client should expect to reconnect at the
|
||||
new address; USB password input is masked. Binary Companion clients can use
|
||||
USB, BLE, or TCP port 5000 without the terminal-start token: send command
|
||||
`0x42` (`CMD_RUN_CLI_COMMAND`) followed by the same CLI text, such as
|
||||
`get wifi.powersave` or `set wifi.powersave min`. WiFi-only Companions accept
|
||||
`get wifi.powersave`, `get wifi.pwd`, `stats-core`, or `set wifi.powersave min`.
|
||||
See [local maintenance commands](terminal_chat_cli.md#local-maintenance-commands)
|
||||
for the complete access rules. WiFi-only Companions accept
|
||||
all three modes. A Full Companion that runs BLE and infrastructure WiFi
|
||||
simultaneously rejects `none` because coexistence requires modem sleep.
|
||||
Companion device power saving and LoRa `radio.rxps` remain independent. On an
|
||||
@@ -378,7 +387,8 @@ remain available.
|
||||
**Usage:**
|
||||
- `erase`
|
||||
|
||||
**Serial Only:** Yes
|
||||
**Local connection only:** USB, direct network CLI, or Companion binary
|
||||
command `0x42` where the role supports the command; unavailable over LoRa.
|
||||
|
||||
**Warning:** _**This is destructive!**_
|
||||
|
||||
@@ -446,7 +456,8 @@ Elsewhere it replies `Err - neighbors not enabled in this build`. If a
|
||||
**Usage:**
|
||||
- `stats-core`
|
||||
|
||||
**Serial Only:** Yes
|
||||
**Local connection only:** USB, direct network CLI, or Companion binary
|
||||
command `0x42` where the role supports the command; unavailable over LoRa.
|
||||
|
||||
---
|
||||
|
||||
@@ -457,7 +468,8 @@ Elsewhere it replies `Err - neighbors not enabled in this build`. If a
|
||||
|
||||
**Usage:** `stats-radio`
|
||||
|
||||
**Serial Only:** Yes
|
||||
**Local connection only:** USB, direct network CLI, or Companion binary
|
||||
command `0x42` where the role supports the command; unavailable over LoRa.
|
||||
|
||||
---
|
||||
|
||||
@@ -465,7 +477,8 @@ Elsewhere it replies `Err - neighbors not enabled in this build`. If a
|
||||
### Packet stats - Packet counters: Received, Sent
|
||||
**Usage:** `stats-packets`
|
||||
|
||||
**Serial Only:** Yes
|
||||
**Local connection only:** USB, direct network CLI, or Companion binary
|
||||
command `0x42` where the role supports the command; unavailable over LoRa.
|
||||
|
||||
---
|
||||
|
||||
@@ -855,10 +868,12 @@ only `get mqtt.enabled`. WiFi modem power saving is a separate setting.
|
||||
|
||||
---
|
||||
|
||||
### Print the captured log to the serial terminal
|
||||
<a id="print-the-captured-log-to-the-serial-terminal"></a>
|
||||
### Print the captured log to the requesting terminal
|
||||
**Usage:** `log`
|
||||
|
||||
**Serial Only:** Yes
|
||||
**Local connection only:** USB, direct network CLI, or Companion binary
|
||||
command `0x42` where the role supports the command; unavailable over LoRa.
|
||||
|
||||
---
|
||||
|
||||
@@ -1052,7 +1067,8 @@ automation treats that version as the wire-format capability boundary.
|
||||
**Default:** `869.525`
|
||||
|
||||
**Note:** Requires reboot to apply
|
||||
**Serial Only:** `set freq <frequency>`
|
||||
**Local connection only:** `set freq <frequency>`. USB, browser/TCP/Ethernet
|
||||
CLI, and Companion binary command `0x42` can set it; LoRa cannot.
|
||||
|
||||
---
|
||||
|
||||
@@ -1315,16 +1331,18 @@ for the tested XIAO handoff and host-cache caveats.
|
||||
**Parameters:**
|
||||
- `private_key`: Private key in hex format (64 hex characters)
|
||||
|
||||
**Serial Only:**
|
||||
- `get prv.key`: Yes
|
||||
- `set prv.key`: No
|
||||
**Local connection only:** `get prv.key`. Companion also requires
|
||||
`ENABLE_PRIVATE_KEY_EXPORT=1`; use binary command `0x42` or the text terminal.
|
||||
Infrastructure `set prv.key` retains its administrator access rules.
|
||||
|
||||
**Note:** Requires reboot to take effect after setting
|
||||
|
||||
---
|
||||
|
||||
#### Change this node's admin password
|
||||
<a id="change-this-nodes-admin-password"></a>
|
||||
#### View or change this node's admin password
|
||||
**Usage:**
|
||||
- `get password`
|
||||
- `password <new_password>`
|
||||
|
||||
**Parameters:**
|
||||
@@ -1334,7 +1352,12 @@ for the tested XIAO handoff and host-cache caveats.
|
||||
|
||||
**Default:** `password`
|
||||
|
||||
**Note:** Command reply echoes the updated password for confirmation.
|
||||
`get password` returns the current admin password only on a local connection:
|
||||
USB, Ethernet, or the authenticated LAN browser CLI. It is rejected over LoRa.
|
||||
Companion has no local admin password and reports that explicitly, including
|
||||
through binary command `0x42`; this command does not report the Bluetooth PIN.
|
||||
|
||||
**Note:** The password setter replies with confirmation.
|
||||
|
||||
**Note:** Any node using this password will be added to the admin ACL list.
|
||||
|
||||
@@ -2804,7 +2827,8 @@ eviction like administrators.
|
||||
**Usage:**
|
||||
- `get acl`
|
||||
|
||||
**Serial Only:** Yes
|
||||
**Local connection only:** USB, direct network CLI, or Companion binary
|
||||
command `0x42` where the role supports the command; unavailable over LoRa.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -251,6 +251,16 @@ 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.
|
||||
|
||||
Direct USB, BLE, WiFi TCP, and Ethernet clients can also use this command for
|
||||
`stats-core`, `stats-radio`, `stats-radio-diag`, `stats-packets`, `erase`,
|
||||
`set freq <MHz>`, and `get prv.key` (when private key export is enabled).
|
||||
WiFi/MQTT builds accept `get wifi.pwd`, `get mqttN.password`, and
|
||||
`get mqttN.token`. `get password` reports that Companion has no admin password;
|
||||
infrastructure roles return their own admin password on a local CLI connection.
|
||||
These privileges do not apply to CLI commands relayed over LoRa. See
|
||||
[local maintenance commands](terminal_chat_cli.md#local-maintenance-commands)
|
||||
for role differences and the text-terminal equivalents.
|
||||
|
||||
Full Companion clients can send `version` through this command to receive the
|
||||
untruncated build identity, for example `Companion 1.17.1.5-... (protocol 14,
|
||||
build 31-Aug-2026)`. This deliberately supplements rather than changes the
|
||||
|
||||
@@ -245,7 +245,8 @@ persisted and requires a reboot, unlike a WiFi power-save change.
|
||||
SSID and password writes return their reply first, then restart the Companion
|
||||
WiFi station with the saved credentials. A TCP terminal therefore disconnects
|
||||
shortly after either write; reconnect to the IP reported by the new network.
|
||||
The password is write-only and is masked while it is entered over USB. It may
|
||||
Password entry is masked over USB. `get wifi.pwd` reads the saved password from
|
||||
any local connection, including binary command `0x42`; LoRa cannot read it. It may
|
||||
be empty for an open network, an ordinary passphrase of up to 63 characters, or
|
||||
an exact 64-character hexadecimal WPA/WPA2 PSK. Other 64-character values and
|
||||
all longer values are rejected.
|
||||
|
||||
@@ -41,6 +41,41 @@ available buffer while unread, the browser reports the missing output.
|
||||
USB protocol-switch and USB MOTA ownership commands still apply to the USB
|
||||
connection. Use the WiFi MOTA seeder on port 5001 for a host folder over WiFi.
|
||||
|
||||
## Local maintenance commands
|
||||
|
||||
Local means a connection directly to the node: USB, BLE or WiFi/Ethernet
|
||||
Companion protocol, a TCP terminal, or the browser CLI on the LAN. These
|
||||
connections can use the following commands when the role and build include
|
||||
the corresponding feature:
|
||||
|
||||
| Command | Result |
|
||||
|---|---|
|
||||
| `stats-core`, `stats-radio`, `stats-radio-diag`, `stats-packets` | Runtime diagnostics |
|
||||
| `get prv.key` | Node identity private key; Companion requires private key export enabled in the build |
|
||||
| `get password` | Infrastructure admin password; Companion reports that it has no admin password |
|
||||
| `set freq <MHz>` | Save the frequency; reboot to apply |
|
||||
| `erase` | Erase stored identity and settings; reboot for a fresh node |
|
||||
| `get wifi.pwd` | Stored WiFi password on WiFi builds |
|
||||
| `get mqttN.password`, `get mqttN.token` | Stored credentials for MQTT slot N |
|
||||
| `get acl`, `log` | Infrastructure ACL or captured packet log; these stores do not exist on Companion |
|
||||
|
||||
The command text is the same for direct connections. A binary Companion app
|
||||
can send `0x42` (`CMD_RUN_CLI_COMMAND`) followed by the ASCII command, without
|
||||
switching into terminal mode. The response is `0x1D` (`RESP_CODE_CLI_REPLY`)
|
||||
followed by the reply text. For example, payload `42 67 65 74 20 70 61 73 73 77
|
||||
6f 72 64` runs `get password`. USB framing remains the normal Companion frame;
|
||||
BLE and TCP use their existing Companion transport framing.
|
||||
|
||||
Commands relayed to another node using `cmd` travel over LoRa and retain the
|
||||
remote restrictions. These local permissions do not add an ACL or packet-log
|
||||
store to Companion. Use `list` or the binary contacts operations for Companion
|
||||
contacts. Interactive chat commands still use the text terminal or their
|
||||
corresponding binary protocol operations.
|
||||
|
||||
The browser CLI requires station/LAN mode and `wifi.cli on`. Infrastructure
|
||||
uses its admin login; Companion uses the trusted LAN. Configuration forms keep
|
||||
password fields masked; explicit local CLI getters return their values.
|
||||
|
||||
## Companion USB mode
|
||||
|
||||
An ordinary Companion USB build starts in the normal binary Companion protocol
|
||||
|
||||
Reference in new issue
Block a user