You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli_commands.md
+75-4Lines changed: 75 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,6 +108,13 @@ This document provides an overview of CLI commands that can be sent to MeshCore
108
108
109
109
---
110
110
111
+
### Discover zero hop neighbors
112
+
113
+
**Usage:**
114
+
-`discover.neighbors`
115
+
116
+
---
117
+
111
118
## Statistics
112
119
113
120
### Clear Stats
@@ -212,6 +219,20 @@ This document provides an overview of CLI commands that can be sent to MeshCore
212
219
213
220
---
214
221
222
+
#### View or change the boosted receive gain mode
223
+
**Usage:**
224
+
-`get radio.rxgain`
225
+
-`set radio.rxgain <state>`
226
+
227
+
**Parameters:**
228
+
-`state`: `on`|`off`
229
+
230
+
**Default:**`off`
231
+
232
+
**Note:** Only available on SX1262 and SX1268 based boards.
233
+
234
+
---
235
+
215
236
#### Change the radio parameters for a set duration
216
237
**Usage:**
217
238
-`tempradio <freq>,<bw>,<sf>,<cr>,<timeout_mins>`
@@ -240,6 +261,22 @@ This document provides an overview of CLI commands that can be sent to MeshCore
240
261
**Note:** Requires reboot to apply
241
262
**Serial Only:**`set freq <frequency>`
242
263
264
+
---
265
+
266
+
#### View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)
267
+
**Usage:**
268
+
-`get radio.rxgain`
269
+
-`set radio.rxgain <state>`
270
+
271
+
**Parameters:**
272
+
-`state`: `on`|`off`
273
+
274
+
**Default:**`on`
275
+
276
+
**Temporary Note:** If you upgraded from an older version to 1.14.1 without erasing flash, this setting is `off` because of [#2118](https://github.com/meshcore-dev/MeshCore/issues/2118)
277
+
278
+
---
279
+
243
280
### System
244
281
245
282
#### View or change this node's name
@@ -479,7 +516,29 @@ This document provides an overview of CLI commands that can be sent to MeshCore
479
516
480
517
---
481
518
519
+
#### View or change the duty cycle limit
520
+
**Usage:**
521
+
-`get dutycycle`
522
+
-`set dutycycle <value>`
523
+
524
+
**Parameters:**
525
+
-`value`: Duty cycle percentage (1-100)
526
+
527
+
**Default:**`50%` (equivalent to airtime factor 1.0)
528
+
529
+
**Examples:**
530
+
-`set dutycycle 100` — no duty cycle limit
531
+
-`set dutycycle 50` — 50% duty cycle (default)
532
+
-`set dutycycle 10` — 10% duty cycle
533
+
-`set dutycycle 1` — 1% duty cycle (strictest EU requirement)
534
+
535
+
> **Note:** Added in firmware v1.15.0
536
+
537
+
---
538
+
482
539
#### View or change the airtime factor (duty cycle limit)
540
+
> **Deprecated** as of firmware v1.15.0. Use [`get/set dutycycle`](#view-or-change-the-duty-cycle-limit) instead.
541
+
483
542
**Usage:**
484
543
-`get af`
485
544
-`set af <value>`
@@ -489,8 +548,8 @@ This document provides an overview of CLI commands that can be sent to MeshCore
489
548
-`af = 1` → ~50% duty
490
549
-`af = 2` → ~33% duty
491
550
-`af = 3` → ~25% duty
492
-
-`af = 9` → ~10% duty
493
-
Yyou are responsible for choosing a value that is appropriate for your jurisdiction and channel plan (for example EU 868 Mhz 10% duty cycle regulation).
551
+
-`af = 9` → ~10% duty
552
+
You are responsible for choosing a value that is appropriate for your jurisdiction and channel plan (for example EU 868 Mhz 10% duty cycle regulation).
494
553
495
554
**Default:**`1.0`
496
555
@@ -514,7 +573,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
514
573
-`set agc.reset.interval <value>`
515
574
516
575
**Parameters:**
517
-
-`value`: Interval in seconds rounded down to a multiple of 4 (17 becomes 16)
576
+
-`value`: Interval in seconds rounded down to a multiple of 4 (17 becomes 16). 0 to disable.
518
577
519
578
**Default:**`0.0`
520
579
@@ -671,6 +730,16 @@ This document provides an overview of CLI commands that can be sent to MeshCore
671
730
672
731
---
673
732
733
+
#### View or change the default scope region for this node
#define PAYLOAD_TYPE_PATH 0x08 // returned path (prefixed with dest/src hashes, MAC) (enc data: path, extra)
434
434
@@ -740,7 +740,7 @@ Allow the browser user on it:
740
740
---
741
741
## 7. Other Questions:
742
742
743
-
### 7.1. Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?
743
+
### 7.1. Q: How to update nRF (RAK, T114, Seed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app?
744
744
745
745
**A:** The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms:
746
746
@@ -755,8 +755,14 @@ Allow the browser user on it:
755
755
10. Select the device you want to update. If the device you want to update is not on the list, try enabling`OTA` on the device again
756
756
11. If the device is not found, enable `Force Scanning` in the DFU app
757
757
12. Tab the `Upload` to begin OTA update
758
-
13. If it fails, try turning off and on Bluetooth on your phone. If that doesn't work, try rebooting your phone.
759
-
14. Wait for the update to complete. It can take a few minutes.
758
+
13. If it fails, try turning off and on Bluetooth on your phone. If that doesn't work, try rebooting your phone. If you keep getting failures at the "Enabling Bootloader" step, try forgetting the NRF board in your IOS or Andriod device's bluetooth settings and re-pair it through the DFU app.
759
+
14. Wait for the update to complete. It can take a few minutes.
760
+
15. It is strongly recommended that you install and use the OTAFIX bootloader at https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX.
761
+
16. To update a companion node over OTA, it must be running companion firmware v1.15 or greater.
762
+
17. Please see the Meshcore Blog for additional information on OTA firmware flashing:
This document lists unique numbers/identifiers used in various MeshCore protcol payloads.
4
+
5
+
# Group Data Types
6
+
7
+
The `PAYLOAD_TYPE_GRP_DATA` payloads have a 16-bit data-type field, which identifies which application the packet is for.
8
+
9
+
To make sure multiple applications can function without interfering with each other, the table below is for reserving various ranges of data-type values. Just modify this table, adding a row, then submit a PR to have it authorised/merged.
10
+
11
+
NOTE: the range FF00 - FFFF is for use while you're developing, doing POC, and for these you don't need to request to use/allocate.
12
+
13
+
Once you have a working app/project, you need to be able to demonstrate it exists/works, and THEN request type IDs. So, just use the testing/dev range while developing, then request IDs before you transition to publishing your project.
The plaintext contained in the ciphertext matches the format described in [plain text message](#plain-text-message). Specifically, it consists of a four byte timestamp, a flags byte, and the message. The flags byte will generally be `0x00` because it is a "plain text message". The message will be of the form `<sender name>: <message body>` (eg., `user123: I'm on my way`).
0 commit comments