docs: sync CLI and payload docs with implementation

3 months ago · 0d0b31eb52
3 changed files with 90 additions and 38 deletions
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@ -53,7 +53,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
 - `time <epoch_seconds>`

 **Parameters:**
- `epoc_seconds`: Unix epoc time
+- `epoch_seconds`: Unix epoch time

 ---

@ -63,6 +63,12 @@ This document provides an overview of CLI commands that can be sent to MeshCore

 ---

+### Send a zero-hop advert
+**Usage:**
+- `advert.zerohop`
+
+---
+
 ### Start an Over-The-Air (OTA) firmware update
 **Usage:**
 - `start ota`
@ -136,7 +142,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore

 ---

-### End capture of rx log to node sotrage
+### End capture of rx log to node storage
 **Usage:** `log stop`

 ---
@ -200,7 +206,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore

 **Default:** Varies by board

-**Notes:** This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Referr to the node's manual for the correct setting to use. **Setting a value too high may violate the laws in your country.**
+**Notes:** This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Refer to the node's manual for the correct setting to use. **Setting a value too high may violate the laws in your country.**

 ---

@ -230,6 +236,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
 **Default:** `869.525`

 **Note:** Requires reboot to apply
+**Serial Only:** `set freq <frequency>`

 ### System

@ -287,7 +294,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore

 **Serial Only:**
 - `get prv.key`: Yes
- `set prv.key`: No
+- `set prv.key`: Yes

 **Note:** Requires reboot to take effect after setting

@ -295,16 +302,16 @@ This document provides an overview of CLI commands that can be sent to MeshCore

 #### Change this node's admin password
 **Usage:**
- `password <password>`
+- `password <new_password>`

 **Parameters:**
- `password`: Admin password
+- `new_password`: New admin password

 **Set by build flag:** `ADMIN_PASSWORD`

 **Default:** `password`

-**Note:** Echoed back for confirmation
+**Note:** Command reply echoes the updated password for confirmation.

 **Note:** Any node using this password will be added to the admin ACL list.

@ -354,13 +361,25 @@ This document provides an overview of CLI commands that can be sent to MeshCore

 ---

+#### View this node's public key
+**Usage:** `get public.key`
+
+---
+
+#### View this node's configured role
+**Usage:** `get role`
+
+---
+
 #### View or change this node's power saving flag (Repeater Only)
 **Usage:**
- `powersaving <state>`
 - `powersaving`
+- `powersaving on`
+- `powersaving off`

 **Parameters:** 
- `state`: `on`|`off` 
+- `on`: enable power saving
+- `off`: disable power saving

 **Default:** `on`

@ -769,7 +788,7 @@ region save
 - `gps advert <policy>`

 **Parameters:** 
- `policy`: `none`|`shared`|`prefs` 
+- `policy`: `none`|`share`|`prefs` 
  - `none`: don't include location in adverts
  - `share`: share gps location (from SensorManager)
  - `prefs`: location stored in node's lat and lon settings
@ -803,6 +822,11 @@ region save

 ### Bridge (When bridge support is compiled in)

+#### View the compiled bridge type
+**Usage:** `get bridge.type`
+
+---
+
 #### View or change the bridge enabled flag
 **Usage:**
 - `get bridge.enabled`
@ -840,10 +864,10 @@ region save

 **Parameters:**
 - `source`: 
-  - `rx`: bridges received packets
-  - `tx`: bridges transmitted packets
+  - `logRx`: bridges received packets
+  - `logTx`: bridges transmitted packets

-**Default:** `tx`
+**Default:** `logTx`

 ---

@ -875,8 +899,39 @@ region save
 - `set bridge.secret <secret>`

 **Parameters:**
- `secret`: 16-character encryption secret
+- `secret`: ESP-NOW bridge secret, up to 15 characters

 **Default:** Varies by board

 ---
+
+#### View the bootloader version (nRF52 only)
+**Usage:** `get bootloader.ver`
+
+---
+
+#### View power management support
+**Usage:** `get pwrmgt.support`
+
+---
+
+#### View the current power source
+**Usage:** `get pwrmgt.source`
+
+**Note:** Returns an error on boards without power management support.
+
+---
+
+#### View the boot reset and shutdown reasons
+**Usage:** `get pwrmgt.bootreason`
+
+**Note:** Returns an error on boards without power management support.
+
+---
+
+#### View the boot voltage
+**Usage:** `get pwrmgt.bootmv`
+
+**Note:** Returns an error on boards without power management support.
+
+---
--- a/docs/faq.md
+++ b/docs/faq.md
@ -221,11 +221,11 @@ MeshCore allows you to manually broadcast your name, position and public encrypt
 * Zero hop means your advert is broadcasted out to anyone that can hear it, and that's it.
 * Flooded means it's broadcasted out and then repeated by all the repeaters that hear it.

-MeshCore clients only advertise themselves when the user initiates it. A repeater sends a flood advert once every 3 hours by default. This interval can be configured using the following command:
+MeshCore clients only advertise themselves when the user initiates it. A repeater sends a flood advert once every 12 hours by default. This interval can be configured using the following command:

-`set advert.interval {minutes}`
+`set flood.advert.interval {hours}`

-As of Aug 20 2025, a pending PR on github will change the flood advert to 12 hours to minimize airtime utilization caused by repeaters' flood adverts.
+The separate `set advert.interval {minutes}` command controls the local zero-hop advert timer.

 ### 2.5. Q: Is there a hop limit?

@ -260,7 +260,9 @@ Repeater or room server can be administered with one of the options below:
 ### 3.2. Q: Do I need to set the location for a repeater?
 **A:** While not required, with location set for a repeater it will show up on the MeshCore map in the future. Set location with the following command:

-`set lat <GPS Lat> set long <GPS Lon>`
+`set lat <GPS Lat>`
+
+`set lon <GPS Lon>`

 You can get the latitude and longitude from Google Maps by right-clicking the location you are at on the map.

--- a/docs/payloads.md
+++ b/docs/payloads.md
@ -90,23 +90,17 @@ Returned path messages provide a description of the route a packet took from the

 ## Request

-| Field        | Size (bytes)    | Description                |
-|--------------|-----------------|----------------------------|
-| timestamp    | 4               | send time (unix timestamp) |
-| request type | 1               | see below                  |
-| request data | rest of payload | depends on request type    |
+| Field        | Size (bytes)    | Description                              |
+|--------------|-----------------|------------------------------------------|
+| timestamp    | 4               | sender time (unix timestamp)             |
+| request data | rest of payload | application-defined request payload body |

-Request type
+For the common chat/server helpers in `BaseChatMesh`, the current request type values are:

 | Value  | Name                 | Description                           |
 |--------|----------------------|---------------------------------------|
 | `0x01` | get stats            | get stats of repeater or room server  |
-| `0x02` | keepalive            | (deprecated) |
-| `0x03` | get telemetry data   | TODO |
-| `0x04` | get min,max,avg data | sensor nodes - get min, max, average for given time span |
-| `0x05` | get access list      | get node's approved access list            |
-| `0x06` | get neighbors        | get repeater node's neighbors              |
-| `0x07` | get owner info       | get repeater firmware-ver/name/owner info  |
+| `0x02` | keepalive            | keep-alive request used for maintained connections |

 ### Get stats

@ -133,35 +127,36 @@ Gets information about the node, possibly including the following:

 ### Get telemetry data

-Request data about sensors on the node, including battery level.
+Not defined in `BaseChatMesh`. Sensor- and application-specific request payloads may be implemented by higher-level firmware.

 ### Get Telemetry

-TODO
+Not defined in `BaseChatMesh`.

 ### Get Min/Max/Ave  (Sensor nodes)

-TODO
+Not defined in `BaseChatMesh`.

 ### Get Access List

-TODO
+Not defined in `BaseChatMesh`.

 ### Get Neighors

-TODO
+Not defined in `BaseChatMesh`.

 ### Get Owner Info

-TODO
+Not defined in `BaseChatMesh`.


 ## Response

 | Field   | Size (bytes)    | Description |
 |---------|-----------------|-------------|
-| tag     | 4               | TODO        |
-| content | rest of payload | TODO        |
+| content | rest of payload | application-defined response body |
+
+Response contents are opaque application data. There is no single generic response envelope beyond the encrypted payload wrapper shown above.

 ## Plain text message