Skip to content

Commit f1d489d

Browse files
committed
deploy: dee3e26
1 parent 60d3d3f commit f1d489d

17 files changed

Lines changed: 1368 additions & 31 deletions

File tree

404.html

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,33 @@
403403

404404

405405

406+
<li class="md-nav__item">
407+
<a href="/meshcore/number_allocations/" class="md-nav__link">
408+
409+
410+
411+
<span class="md-ellipsis">
412+
413+
414+
Number Allocations
415+
416+
417+
418+
</span>
419+
420+
421+
422+
</a>
423+
</li>
424+
425+
426+
427+
428+
429+
430+
431+
432+
406433
<li class="md-nav__item">
407434
<a href="/meshcore/packet_format/" class="md-nav__link">
408435

cli_commands/index.html

Lines changed: 192 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,17 @@
471471
</span>
472472
</a>
473473

474+
</li>
475+
476+
<li class="md-nav__item">
477+
<a href="#discover-zero-hop-neighbors" class="md-nav__link">
478+
<span class="md-ellipsis">
479+
480+
Discover zero hop neighbors
481+
482+
</span>
483+
</a>
484+
474485
</li>
475486

476487
</ul>
@@ -683,6 +694,17 @@
683694
</span>
684695
</a>
685696

697+
</li>
698+
699+
<li class="md-nav__item">
700+
<a href="#view-or-change-the-boosted-receive-gain-mode" class="md-nav__link">
701+
<span class="md-ellipsis">
702+
703+
View or change the boosted receive gain mode
704+
705+
</span>
706+
</a>
707+
686708
</li>
687709

688710
<li class="md-nav__item">
@@ -705,6 +727,17 @@
705727
</span>
706728
</a>
707729

730+
</li>
731+
732+
<li class="md-nav__item">
733+
<a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-only-v1141" class="md-nav__link">
734+
<span class="md-ellipsis">
735+
736+
View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)
737+
738+
</span>
739+
</a>
740+
708741
</li>
709742

710743
</ul>
@@ -926,6 +959,17 @@
926959
</span>
927960
</a>
928961

962+
</li>
963+
964+
<li class="md-nav__item">
965+
<a href="#view-or-change-the-duty-cycle-limit" class="md-nav__link">
966+
<span class="md-ellipsis">
967+
968+
View or change the duty cycle limit
969+
970+
</span>
971+
</a>
972+
929973
</li>
930974

931975
<li class="md-nav__item">
@@ -1136,6 +1180,17 @@
11361180
</span>
11371181
</a>
11381182

1183+
</li>
1184+
1185+
<li class="md-nav__item">
1186+
<a href="#view-or-change-the-default-scope-region-for-this-node" class="md-nav__link">
1187+
<span class="md-ellipsis">
1188+
1189+
View or change the default scope region for this node
1190+
1191+
</span>
1192+
</a>
1193+
11391194
</li>
11401195

11411196
<li class="md-nav__item">
@@ -1601,6 +1656,33 @@
16011656

16021657

16031658

1659+
<li class="md-nav__item">
1660+
<a href="../number_allocations/" class="md-nav__link">
1661+
1662+
1663+
1664+
<span class="md-ellipsis">
1665+
1666+
1667+
Number Allocations
1668+
1669+
1670+
1671+
</span>
1672+
1673+
1674+
1675+
</a>
1676+
</li>
1677+
1678+
1679+
1680+
1681+
1682+
1683+
1684+
1685+
16041686
<li class="md-nav__item">
16051687
<a href="../packet_format/" class="md-nav__link">
16061688

@@ -1915,6 +1997,17 @@
19151997
</span>
19161998
</a>
19171999

2000+
</li>
2001+
2002+
<li class="md-nav__item">
2003+
<a href="#discover-zero-hop-neighbors" class="md-nav__link">
2004+
<span class="md-ellipsis">
2005+
2006+
Discover zero hop neighbors
2007+
2008+
</span>
2009+
</a>
2010+
19182011
</li>
19192012

19202013
</ul>
@@ -2127,6 +2220,17 @@
21272220
</span>
21282221
</a>
21292222

2223+
</li>
2224+
2225+
<li class="md-nav__item">
2226+
<a href="#view-or-change-the-boosted-receive-gain-mode" class="md-nav__link">
2227+
<span class="md-ellipsis">
2228+
2229+
View or change the boosted receive gain mode
2230+
2231+
</span>
2232+
</a>
2233+
21302234
</li>
21312235

21322236
<li class="md-nav__item">
@@ -2149,6 +2253,17 @@
21492253
</span>
21502254
</a>
21512255

2256+
</li>
2257+
2258+
<li class="md-nav__item">
2259+
<a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-only-v1141" class="md-nav__link">
2260+
<span class="md-ellipsis">
2261+
2262+
View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)
2263+
2264+
</span>
2265+
</a>
2266+
21522267
</li>
21532268

21542269
</ul>
@@ -2370,6 +2485,17 @@
23702485
</span>
23712486
</a>
23722487

2488+
</li>
2489+
2490+
<li class="md-nav__item">
2491+
<a href="#view-or-change-the-duty-cycle-limit" class="md-nav__link">
2492+
<span class="md-ellipsis">
2493+
2494+
View or change the duty cycle limit
2495+
2496+
</span>
2497+
</a>
2498+
23732499
</li>
23742500

23752501
<li class="md-nav__item">
@@ -2580,6 +2706,17 @@
25802706
</span>
25812707
</a>
25822708

2709+
</li>
2710+
2711+
<li class="md-nav__item">
2712+
<a href="#view-or-change-the-default-scope-region-for-this-node" class="md-nav__link">
2713+
<span class="md-ellipsis">
2714+
2715+
View or change the default scope region for this node
2716+
2717+
</span>
2718+
</a>
2719+
25832720
</li>
25842721

25852722
<li class="md-nav__item">
@@ -2999,6 +3136,10 @@ <h3 id="remove-a-neighbor">Remove a neighbor</h3>
29993136
- <code>pubkey_prefix</code>: The public key of the node to remove from the neighbors list. This can be a short prefix or the full key. All neighbors matching the provided prefix will be removed.</p>
30003137
<p><strong>Note:</strong> You can remove all neighbors by sending a space character as the prefix. The space indicates an empty prefix, which matches all existing neighbors.</p>
30013138
<hr />
3139+
<h3 id="discover-zero-hop-neighbors">Discover zero hop neighbors</h3>
3140+
<p><strong>Usage:</strong>
3141+
- <code>discover.neighbors</code></p>
3142+
<hr />
30023143
<h2 id="statistics">Statistics</h2>
30033144
<h3 id="clear-stats">Clear Stats</h3>
30043145
<p><strong>Usage:</strong> <code>clear stats</code></p>
@@ -3062,6 +3203,15 @@ <h4 id="view-or-change-this-nodes-transmit-power">View or change this node's tra
30623203
<p><strong>Default:</strong> Varies by board</p>
30633204
<p><strong>Notes:</strong> 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. <strong>Setting a value too high may violate the laws in your country.</strong></p>
30643205
<hr />
3206+
<h4 id="view-or-change-the-boosted-receive-gain-mode">View or change the boosted receive gain mode</h4>
3207+
<p><strong>Usage:</strong>
3208+
- <code>get radio.rxgain</code>
3209+
- <code>set radio.rxgain &lt;state&gt;</code></p>
3210+
<p><strong>Parameters:</strong>
3211+
- <code>state</code>: <code>on</code>|<code>off</code></p>
3212+
<p><strong>Default:</strong> <code>off</code></p>
3213+
<p><strong>Note:</strong> Only available on SX1262 and SX1268 based boards.</p>
3214+
<hr />
30653215
<h4 id="change-the-radio-parameters-for-a-set-duration">Change the radio parameters for a set duration</h4>
30663216
<p><strong>Usage:</strong>
30673217
- <code>tempradio &lt;freq&gt;,&lt;bw&gt;,&lt;sf&gt;,&lt;cr&gt;,&lt;timeout_mins&gt;</code></p>
@@ -3082,6 +3232,16 @@ <h4 id="view-or-change-this-nodes-frequency">View or change this node's frequenc
30823232
<p><strong>Default:</strong> <code>869.525</code></p>
30833233
<p><strong>Note:</strong> Requires reboot to apply
30843234
<strong>Serial Only:</strong> <code>set freq &lt;frequency&gt;</code></p>
3235+
<hr />
3236+
<h4 id="view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-only-v1141">View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)</h4>
3237+
<p><strong>Usage:</strong>
3238+
- <code>get radio.rxgain</code>
3239+
- <code>set radio.rxgain &lt;state&gt;</code></p>
3240+
<p><strong>Parameters:</strong>
3241+
- <code>state</code>: <code>on</code>|<code>off</code></p>
3242+
<p><strong>Default:</strong> <code>on</code></p>
3243+
<p><strong>Temporary Note:</strong> If you upgraded from an older version to 1.14.1 without erasing flash, this setting is <code>off</code> because of <a href="https://github.com/meshcore-dev/MeshCore/issues/2118">#2118</a></p>
3244+
<hr />
30853245
<h3 id="system">System</h3>
30863246
<h4 id="view-or-change-this-nodes-name">View or change this node's name</h4>
30873247
<p><strong>Usage:</strong>
@@ -3238,7 +3398,26 @@ <h4 id="experimental-view-or-change-the-processing-delay-for-received-traffic">[
32383398
- <code>value</code>: Receive delay base (0-20)</p>
32393399
<p><strong>Default:</strong> <code>0.0</code></p>
32403400
<hr />
3401+
<h4 id="view-or-change-the-duty-cycle-limit">View or change the duty cycle limit</h4>
3402+
<p><strong>Usage:</strong>
3403+
- <code>get dutycycle</code>
3404+
- <code>set dutycycle &lt;value&gt;</code></p>
3405+
<p><strong>Parameters:</strong>
3406+
- <code>value</code>: Duty cycle percentage (1-100)</p>
3407+
<p><strong>Default:</strong> <code>50%</code> (equivalent to airtime factor 1.0)</p>
3408+
<p><strong>Examples:</strong>
3409+
- <code>set dutycycle 100</code> — no duty cycle limit
3410+
- <code>set dutycycle 50</code> — 50% duty cycle (default)
3411+
- <code>set dutycycle 10</code> — 10% duty cycle
3412+
- <code>set dutycycle 1</code> — 1% duty cycle (strictest EU requirement)</p>
3413+
<blockquote>
3414+
<p><strong>Note:</strong> Added in firmware v1.15.0</p>
3415+
</blockquote>
3416+
<hr />
32413417
<h4 id="view-or-change-the-airtime-factor-duty-cycle-limit">View or change the airtime factor (duty cycle limit)</h4>
3418+
<blockquote>
3419+
<p><strong>Deprecated</strong> as of firmware v1.15.0. Use <a href="#view-or-change-the-duty-cycle-limit"><code>get/set dutycycle</code></a> instead.</p>
3420+
</blockquote>
32423421
<p><strong>Usage:</strong>
32433422
- <code>get af</code>
32443423
- <code>set af &lt;value&gt;</code></p>
@@ -3247,8 +3426,8 @@ <h4 id="view-or-change-the-airtime-factor-duty-cycle-limit">View or change the a
32473426
- <code>af = 1</code> → ~50% duty
32483427
- <code>af = 2</code> → ~33% duty
32493428
- <code>af = 3</code> → ~25% duty
3250-
- <code>af = 9</code> → ~10% duty<br />
3251-
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).</p>
3429+
- <code>af = 9</code> → ~10% duty
3430+
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).</p>
32523431
<p><strong>Default:</strong> <code>1.0</code></p>
32533432
<hr />
32543433
<h4 id="view-or-change-the-local-interference-threshold">View or change the local interference threshold</h4>
@@ -3264,7 +3443,7 @@ <h4 id="view-or-change-the-agc-reset-interval">View or change the AGC Reset Inte
32643443
- <code>get agc.reset.interval</code>
32653444
- <code>set agc.reset.interval &lt;value&gt;</code></p>
32663445
<p><strong>Parameters:</strong>
3267-
- <code>value</code>: Interval in seconds rounded down to a multiple of 4 (17 becomes 16)</p>
3446+
- <code>value</code>: Interval in seconds rounded down to a multiple of 4 (17 becomes 16). 0 to disable.</p>
32683447
<p><strong>Default:</strong> <code>0.0</code></p>
32693448
<hr />
32703449
<h4 id="enable-or-disable-multi-acks-support">Enable or disable Multi-Acks support</h4>
@@ -3367,6 +3546,13 @@ <h4 id="view-or-change-the-home-region-for-this-node">View or change the home re
33673546
<p><strong>Parameters:</strong>
33683547
- <code>name</code>: Region name</p>
33693548
<hr />
3549+
<h4 id="view-or-change-the-default-scope-region-for-this-node">View or change the default scope region for this node</h4>
3550+
<p><strong>Usage:</strong>
3551+
- <code>region default</code>
3552+
- <code>region default {name|&lt;null&gt;}</code></p>
3553+
<p><strong>Parameters:</strong>
3554+
- <code>name</code>: Region name, or <null> to reset/clear</p>
3555+
<hr />
33703556
<h4 id="create-a-new-region">Create a new region</h4>
33713557
<p><strong>Usage:</strong>
33723558
- <code>region put &lt;name&gt; [parent_name]</code></p>
@@ -3471,7 +3657,9 @@ <h4 id="view-or-change-gps-state">View or change GPS state</h4>
34713657
<p><strong>Parameters:</strong>
34723658
- <code>state</code>: <code>on</code>|<code>off</code></p>
34733659
<p><strong>Default:</strong> <code>off</code></p>
3474-
<p><strong>Note:</strong> Output format: <code>{status}, {fix}, {sat count}</code> (when enabled)</p>
3660+
<p><strong>Note:</strong> Output format:
3661+
- <code>off</code> when the GPS hardware is disabled
3662+
- <code>on, {active|deactivated}, {fix|no fix}, {sat count} sats</code> when the GPS hardware is enabled</p>
34753663
<hr />
34763664
<h4 id="sync-this-nodes-clock-with-gps-time">Sync this node's clock with GPS time</h4>
34773665
<p><strong>Usage:</strong>

0 commit comments

Comments
 (0)