mirror of
https://github.com/meshcore-dev/MeshCore.git
synced 2026-05-11 04:16:55 +00:00
deploy: dee3e26ac0
This commit is contained in:
ripplebiz
+192
-4
@@ -471,6 +471,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#discover-zero-hop-neighbors" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Discover zero hop neighbors
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -683,6 +694,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-the-boosted-receive-gain-mode" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change the boosted receive gain mode
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -705,6 +727,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-only-v1141" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -926,6 +959,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-the-duty-cycle-limit" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change the duty cycle limit
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1136,6 +1180,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-the-default-scope-region-for-this-node" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change the default scope region for this node
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1601,6 +1656,33 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../number_allocations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
|
||||
|
||||
Number Allocations
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../packet_format/" class="md-nav__link">
|
||||
|
||||
@@ -1915,6 +1997,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#discover-zero-hop-neighbors" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Discover zero hop neighbors
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -2127,6 +2220,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-the-boosted-receive-gain-mode" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change the boosted receive gain mode
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -2149,6 +2253,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-only-v1141" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -2370,6 +2485,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-the-duty-cycle-limit" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change the duty cycle limit
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -2580,6 +2706,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#view-or-change-the-default-scope-region-for-this-node" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
View or change the default scope region for this node
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -2999,6 +3136,10 @@
|
||||
- <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>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="discover-zero-hop-neighbors">Discover zero hop neighbors</h3>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>discover.neighbors</code></p>
|
||||
<hr />
|
||||
<h2 id="statistics">Statistics</h2>
|
||||
<h3 id="clear-stats">Clear Stats</h3>
|
||||
<p><strong>Usage:</strong> <code>clear stats</code></p>
|
||||
@@ -3062,6 +3203,15 @@
|
||||
<p><strong>Default:</strong> Varies by board</p>
|
||||
<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>
|
||||
<hr />
|
||||
<h4 id="view-or-change-the-boosted-receive-gain-mode">View or change the boosted receive gain mode</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>get radio.rxgain</code>
|
||||
- <code>set radio.rxgain <state></code></p>
|
||||
<p><strong>Parameters:</strong>
|
||||
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
||||
<p><strong>Default:</strong> <code>off</code></p>
|
||||
<p><strong>Note:</strong> Only available on SX1262 and SX1268 based boards.</p>
|
||||
<hr />
|
||||
<h4 id="change-the-radio-parameters-for-a-set-duration">Change the radio parameters for a set duration</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>tempradio <freq>,<bw>,<sf>,<cr>,<timeout_mins></code></p>
|
||||
@@ -3082,6 +3232,16 @@
|
||||
<p><strong>Default:</strong> <code>869.525</code></p>
|
||||
<p><strong>Note:</strong> Requires reboot to apply
|
||||
<strong>Serial Only:</strong> <code>set freq <frequency></code></p>
|
||||
<hr />
|
||||
<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>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>get radio.rxgain</code>
|
||||
- <code>set radio.rxgain <state></code></p>
|
||||
<p><strong>Parameters:</strong>
|
||||
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
||||
<p><strong>Default:</strong> <code>on</code></p>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="system">System</h3>
|
||||
<h4 id="view-or-change-this-nodes-name">View or change this node's name</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
@@ -3238,7 +3398,26 @@
|
||||
- <code>value</code>: Receive delay base (0-20)</p>
|
||||
<p><strong>Default:</strong> <code>0.0</code></p>
|
||||
<hr />
|
||||
<h4 id="view-or-change-the-duty-cycle-limit">View or change the duty cycle limit</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>get dutycycle</code>
|
||||
- <code>set dutycycle <value></code></p>
|
||||
<p><strong>Parameters:</strong>
|
||||
- <code>value</code>: Duty cycle percentage (1-100)</p>
|
||||
<p><strong>Default:</strong> <code>50%</code> (equivalent to airtime factor 1.0)</p>
|
||||
<p><strong>Examples:</strong>
|
||||
- <code>set dutycycle 100</code> — no duty cycle limit
|
||||
- <code>set dutycycle 50</code> — 50% duty cycle (default)
|
||||
- <code>set dutycycle 10</code> — 10% duty cycle
|
||||
- <code>set dutycycle 1</code> — 1% duty cycle (strictest EU requirement)</p>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> Added in firmware v1.15.0</p>
|
||||
</blockquote>
|
||||
<hr />
|
||||
<h4 id="view-or-change-the-airtime-factor-duty-cycle-limit">View or change the airtime factor (duty cycle limit)</h4>
|
||||
<blockquote>
|
||||
<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>
|
||||
</blockquote>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>get af</code>
|
||||
- <code>set af <value></code></p>
|
||||
@@ -3247,8 +3426,8 @@
|
||||
- <code>af = 1</code> → ~50% duty
|
||||
- <code>af = 2</code> → ~33% duty
|
||||
- <code>af = 3</code> → ~25% duty
|
||||
- <code>af = 9</code> → ~10% duty<br />
|
||||
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>
|
||||
- <code>af = 9</code> → ~10% duty
|
||||
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>
|
||||
<p><strong>Default:</strong> <code>1.0</code></p>
|
||||
<hr />
|
||||
<h4 id="view-or-change-the-local-interference-threshold">View or change the local interference threshold</h4>
|
||||
@@ -3264,7 +3443,7 @@
|
||||
- <code>get agc.reset.interval</code>
|
||||
- <code>set agc.reset.interval <value></code></p>
|
||||
<p><strong>Parameters:</strong>
|
||||
- <code>value</code>: Interval in seconds rounded down to a multiple of 4 (17 becomes 16)</p>
|
||||
- <code>value</code>: Interval in seconds rounded down to a multiple of 4 (17 becomes 16). 0 to disable.</p>
|
||||
<p><strong>Default:</strong> <code>0.0</code></p>
|
||||
<hr />
|
||||
<h4 id="enable-or-disable-multi-acks-support">Enable or disable Multi-Acks support</h4>
|
||||
@@ -3367,6 +3546,13 @@
|
||||
<p><strong>Parameters:</strong>
|
||||
- <code>name</code>: Region name</p>
|
||||
<hr />
|
||||
<h4 id="view-or-change-the-default-scope-region-for-this-node">View or change the default scope region for this node</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>region default</code>
|
||||
- <code>region default {name|<null>}</code></p>
|
||||
<p><strong>Parameters:</strong>
|
||||
- <code>name</code>: Region name, or <null> to reset/clear</p>
|
||||
<hr />
|
||||
<h4 id="create-a-new-region">Create a new region</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>region put <name> [parent_name]</code></p>
|
||||
@@ -3471,7 +3657,9 @@ region save
|
||||
<p><strong>Parameters:</strong>
|
||||
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
||||
<p><strong>Default:</strong> <code>off</code></p>
|
||||
<p><strong>Note:</strong> Output format: <code>{status}, {fix}, {sat count}</code> (when enabled)</p>
|
||||
<p><strong>Note:</strong> Output format:
|
||||
- <code>off</code> when the GPS hardware is disabled
|
||||
- <code>on, {active|deactivated}, {fix|no fix}, {sat count} sats</code> when the GPS hardware is enabled</p>
|
||||
<hr />
|
||||
<h4 id="sync-this-nodes-clock-with-gps-time">Sync this node's clock with GPS time</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
|
||||
Reference in New Issue
Block a user