Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 68 additions & 13 deletions docs/cli_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand All @@ -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`
Expand Down Expand Up @@ -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`

---
Expand Down Expand Up @@ -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.**

---

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`

---

Expand Down Expand Up @@ -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.

---
Loading