Skip to content

Commit 82d1a3d

Browse files
authored
Merge pull request #1977 from robekl/docs/implementation-sync-release
Update docs to align with implementation
2 parents c80bd9c + 095f97b commit 82d1a3d

5 files changed

Lines changed: 140 additions & 153 deletions

File tree

docs/cli_commands.md

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ This document provides an overview of CLI commands that can be sent to MeshCore
6363

6464
---
6565

66+
### Send a zero-hop advert
67+
**Usage:**
68+
- `advert.zerohop`
69+
70+
---
71+
6672
### Start an Over-The-Air (OTA) firmware update
6773
**Usage:**
6874
- `start ota`
@@ -355,13 +361,25 @@ This document provides an overview of CLI commands that can be sent to MeshCore
355361

356362
---
357363

364+
#### View this node's public key
365+
**Usage:** `get public.key`
366+
367+
---
368+
369+
#### View this node's configured role
370+
**Usage:** `get role`
371+
372+
---
373+
358374
#### View or change this node's power saving flag (Repeater Only)
359375
**Usage:**
360-
- `powersaving <state>`
361376
- `powersaving`
377+
- `powersaving on`
378+
- `powersaving off`
362379

363380
**Parameters:**
364-
- `state`: `on`|`off`
381+
- `on`: enable power saving
382+
- `off`: disable power saving
365383

366384
**Default:** `on`
367385

@@ -844,6 +862,11 @@ region save
844862

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

865+
#### View the compiled bridge type
866+
**Usage:** `get bridge.type`
867+
868+
---
869+
847870
#### View or change the bridge enabled flag
848871
**Usage:**
849872
- `get bridge.enabled`
@@ -881,10 +904,10 @@ region save
881904

882905
**Parameters:**
883906
- `source`:
884-
- `rx`: bridges received packets
885-
- `tx`: bridges transmitted packets
907+
- `logRx`: bridges received packets
908+
- `logTx`: bridges transmitted packets
886909

887-
**Default:** `tx`
910+
**Default:** `logTx`
888911

889912
---
890913

@@ -916,8 +939,39 @@ region save
916939
- `set bridge.secret <secret>`
917940

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

921944
**Default:** Varies by board
922945

923946
---
947+
948+
#### View the bootloader version (nRF52 only)
949+
**Usage:** `get bootloader.ver`
950+
951+
---
952+
953+
#### View power management support
954+
**Usage:** `get pwrmgt.support`
955+
956+
---
957+
958+
#### View the current power source
959+
**Usage:** `get pwrmgt.source`
960+
961+
**Note:** Returns an error on boards without power management support.
962+
963+
---
964+
965+
#### View the boot reset and shutdown reasons
966+
**Usage:** `get pwrmgt.bootreason`
967+
968+
**Note:** Returns an error on boards without power management support.
969+
970+
---
971+
972+
#### View the boot voltage
973+
**Usage:** `get pwrmgt.bootmv`
974+
975+
**Note:** Returns an error on boards without power management support.
976+
977+
---

0 commit comments

Comments
 (0)