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
+69-14Lines changed: 69 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
53
53
-`time <epoch_seconds>`
54
54
55
55
**Parameters:**
56
-
-`epoc_seconds`: Unix epoc time
56
+
-`epoch_seconds`: Unix epoch time
57
57
58
58
---
59
59
@@ -63,6 +63,12 @@ This document provides an overview of CLI commands that can be sent to MeshCore
63
63
64
64
---
65
65
66
+
### Send a zero-hop advert
67
+
**Usage:**
68
+
-`advert.zerohop`
69
+
70
+
---
71
+
66
72
### Start an Over-The-Air (OTA) firmware update
67
73
**Usage:**
68
74
-`start ota`
@@ -136,7 +142,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
136
142
137
143
---
138
144
139
-
### End capture of rx log to node sotrage
145
+
### End capture of rx log to node storage
140
146
**Usage:**`log stop`
141
147
142
148
---
@@ -200,7 +206,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
200
206
201
207
**Default:** Varies by board
202
208
203
-
**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.**
209
+
**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.**
204
210
205
211
---
206
212
@@ -230,6 +236,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
230
236
**Default:**`869.525`
231
237
232
238
**Note:** Requires reboot to apply
239
+
**Serial Only:**`set freq <frequency>`
233
240
234
241
### System
235
242
@@ -287,24 +294,24 @@ This document provides an overview of CLI commands that can be sent to MeshCore
287
294
288
295
**Serial Only:**
289
296
-`get prv.key`: Yes
290
-
-`set prv.key`: No
297
+
-`set prv.key`: Yes
291
298
292
299
**Note:** Requires reboot to take effect after setting
293
300
294
301
---
295
302
296
303
#### Change this node's admin password
297
304
**Usage:**
298
-
-`password <password>`
305
+
-`password <new_password>`
299
306
300
307
**Parameters:**
301
-
-`password`: Admin password
308
+
-`new_password`: New admin password
302
309
303
310
**Set by build flag:**`ADMIN_PASSWORD`
304
311
305
312
**Default:**`password`
306
313
307
-
**Note:**Echoed back for confirmation
314
+
**Note:**Command reply echoes the updated password for confirmation.
308
315
309
316
**Note:** Any node using this password will be added to the admin ACL list.
310
317
@@ -354,13 +361,25 @@ This document provides an overview of CLI commands that can be sent to MeshCore
354
361
355
362
---
356
363
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
+
357
374
#### View or change this node's power saving flag (Repeater Only)
358
375
**Usage:**
359
-
-`powersaving <state>`
360
376
-`powersaving`
377
+
-`powersaving on`
378
+
-`powersaving off`
361
379
362
380
**Parameters:**
363
-
-`state`: `on`|`off`
381
+
-`on`: enable power saving
382
+
-`off`: disable power saving
364
383
365
384
**Default:**`on`
366
385
@@ -769,7 +788,7 @@ region save
769
788
-`gps advert <policy>`
770
789
771
790
**Parameters:**
772
-
-`policy`: `none`|`shared`|`prefs`
791
+
-`policy`: `none`|`share`|`prefs`
773
792
-`none`: don't include location in adverts
774
793
-`share`: share gps location (from SensorManager)
775
794
-`prefs`: location stored in node's lat and lon settings
@@ -803,6 +822,11 @@ region save
803
822
804
823
### Bridge (When bridge support is compiled in)
805
824
825
+
#### View the compiled bridge type
826
+
**Usage:**`get bridge.type`
827
+
828
+
---
829
+
806
830
#### View or change the bridge enabled flag
807
831
**Usage:**
808
832
-`get bridge.enabled`
@@ -840,10 +864,10 @@ region save
840
864
841
865
**Parameters:**
842
866
-`source`:
843
-
-`rx`: bridges received packets
844
-
-`tx`: bridges transmitted packets
867
+
-`logRx`: bridges received packets
868
+
-`logTx`: bridges transmitted packets
845
869
846
-
**Default:**`tx`
870
+
**Default:**`logTx`
847
871
848
872
---
849
873
@@ -875,8 +899,39 @@ region save
875
899
-`set bridge.secret <secret>`
876
900
877
901
**Parameters:**
878
-
-`secret`: 16-character encryption secret
902
+
-`secret`: ESP-NOW bridge secret, up to 15 characters
879
903
880
904
**Default:** Varies by board
881
905
882
906
---
907
+
908
+
#### View the bootloader version (nRF52 only)
909
+
**Usage:**`get bootloader.ver`
910
+
911
+
---
912
+
913
+
#### View power management support
914
+
**Usage:**`get pwrmgt.support`
915
+
916
+
---
917
+
918
+
#### View the current power source
919
+
**Usage:**`get pwrmgt.source`
920
+
921
+
**Note:** Returns an error on boards without power management support.
922
+
923
+
---
924
+
925
+
#### View the boot reset and shutdown reasons
926
+
**Usage:**`get pwrmgt.bootreason`
927
+
928
+
**Note:** Returns an error on boards without power management support.
929
+
930
+
---
931
+
932
+
#### View the boot voltage
933
+
**Usage:**`get pwrmgt.bootmv`
934
+
935
+
**Note:** Returns an error on boards without power management support.
Copy file name to clipboardExpand all lines: docs/faq.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -221,11 +221,11 @@ MeshCore allows you to manually broadcast your name, position and public encrypt
221
221
* Zero hop means your advert is broadcasted out to anyone that can hear it, and that's it.
222
222
* Flooded means it's broadcasted out and then repeated by all the repeaters that hear it.
223
223
224
-
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:
224
+
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:
225
225
226
-
`set advert.interval {minutes}`
226
+
`set flood.advert.interval {hours}`
227
227
228
-
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.
228
+
The separate `set advert.interval {minutes}` command controls the local zero-hop advert timer.
229
229
230
230
### 2.5. Q: Is there a hop limit?
231
231
@@ -260,7 +260,9 @@ Repeater or room server can be administered with one of the options below:
260
260
### 3.2. Q: Do I need to set the location for a repeater?
261
261
**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:
262
262
263
-
`set lat <GPS Lat> set long <GPS Lon>`
263
+
`set lat <GPS Lat>`
264
+
265
+
`set lon <GPS Lon>`
264
266
265
267
You can get the latitude and longitude from Google Maps by right-clicking the location you are at on the map.
0 commit comments