deploy: 07a3ca9e05

cli_commands/index.html

@@ -694,17 +694,6 @@
     </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">
@@ -730,10 +719,10 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-only-v1141" class="md-nav__link">
+  <a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141" class="md-nav__link">
     <span class="md-ellipsis">
       
-        View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)
+        View or change this node's rx boosted gain mode (SX12xx and LR1110, v1.14.1+)
       
     </span>
   </a>
@@ -1058,6 +1047,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#limit-the-number-of-hops-for-an-unscoped-flood-message" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Limit the number of hops for an unscoped flood message
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -1213,6 +1213,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#define-region-hierarchy-single-line" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Define region hierarchy (single line)
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -1349,10 +1360,10 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#view-or-change-thevalue-of-a-sensor" class="md-nav__link">
+  <a href="#view-or-change-the-value-of-a-sensor" class="md-nav__link">
     <span class="md-ellipsis">
       
-        View or change thevalue of a sensor
+        View or change the value of a sensor
       
     </span>
   </a>
@@ -2231,17 +2242,6 @@
     </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">
@@ -2267,10 +2267,10 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-only-v1141" class="md-nav__link">
+  <a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141" class="md-nav__link">
     <span class="md-ellipsis">
       
-        View or change this node's rx boosted gain mode (SX12xx only, v1.14.1+)
+        View or change this node's rx boosted gain mode (SX12xx and LR1110, v1.14.1+)
       
     </span>
   </a>
@@ -2595,6 +2595,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#limit-the-number-of-hops-for-an-unscoped-flood-message" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Limit the number of hops for an unscoped flood message
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -2750,6 +2761,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#define-region-hierarchy-single-line" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Define region hierarchy (single line)
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -2886,10 +2908,10 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#view-or-change-thevalue-of-a-sensor" class="md-nav__link">
+  <a href="#view-or-change-the-value-of-a-sensor" class="md-nav__link">
     <span class="md-ellipsis">
       
-        View or change thevalue of a sensor
+        View or change the value of a sensor
       
     </span>
   </a>
@@ -3225,15 +3247,6 @@
 <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 &lt;state&gt;</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 &lt;freq&gt;,&lt;bw&gt;,&lt;sf&gt;,&lt;cr&gt;,&lt;timeout_mins&gt;</code></p>
@@ -3255,7 +3268,7 @@
 <p><strong>Note:</strong> Requires reboot to apply
 <strong>Serial Only:</strong> <code>set freq &lt;frequency&gt;</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>
+<h4 id="view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141">View or change this node's rx boosted gain mode (SX12xx and LR1110, v1.14.1+)</h4>
 <p><strong>Usage:</strong>
 - <code>get radio.rxgain</code>
 - <code>set radio.rxgain &lt;state&gt;</code></p>
@@ -3331,7 +3344,7 @@
 - <code>text</code>: Owner information text</p>
 <p><strong>Default:</strong> <code>&lt;blank&gt;</code></p>
 <p><strong>Note:</strong> <code>|</code> characters are translated to newlines</p>
-<p><strong>Note:</strong> Requires firmware 1.12.+</p>
+<p><strong>Note:</strong> Requires firmware 1.12+</p>
 <hr />
 <h4 id="fine-tune-the-battery-reading">Fine-tune the battery reading</h4>
 <p><strong>Usage:</strong>
@@ -3359,7 +3372,7 @@
 <p><strong>Parameters:</strong> 
 - <code>on</code>: enable power saving
 - <code>off</code>: disable power saving</p>
-<p><strong>Default:</strong> <code>on</code></p>
+<p><strong>Default:</strong> <code>off</code></p>
 <p><strong>Note:</strong> When enabled, device enters sleep mode between radio transmissions</p>
 <hr />
 <h3 id="routing">Routing</h3>
@@ -3383,7 +3396,7 @@
   - <code>3</code>: DO NOT USE (Reserved) </p>
 <p><strong>Default:</strong> <code>0</code></p>
 <p><strong>Note:</strong> the 'path.hash.mode' sets the low-level ID/hash encoding size used when the repeater adverts. This setting has no impact on what packet ID/hash size this repeater forwards, all sizes should be forwarded on firmware &gt;= 1.14. This feature was added in firmware 1.14</p>
-<p><strong>Temporary Note:</strong> adverts with ID/hash sizes of 2 or 3 bytes may have limited flood propogation in your network while this feature is new as v1.13.0 firmware and older will drop packets with multibyte path ID/hashes as only 1-byte hashes are suppored. Consider your install base of firmware &gt;=1.14 has reached a criticality for effective network flooding before implementing higher ID/hash sizes. </p>
+<p><strong>Temporary Note:</strong> adverts with ID/hash sizes of 2 or 3 bytes may have limited flood propagation in your network while this feature is new as v1.13.0 firmware and older will drop packets with multibyte path ID/hashes as only 1-byte hashes are supported. Consider your install base of firmware &gt;=1.14 has reached a criticality for effective network flooding before implementing higher ID/hash sizes. </p>
 <hr />
 <h4 id="view-or-change-this-nodes-loop-detection">View or change this node's loop detection</h4>
 <p><strong>Usage:</strong>
@@ -3396,7 +3409,7 @@
   - <code>moderate</code>: packets are dropped if repeater's ID/hash appears 2 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)
   - <code>strict</code>: packets are dropped if repeater's ID/hash appears 1 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)</p>
 <p><strong>Default:</strong> <code>off</code></p>
-<p><strong>Note:</strong> When it is enabled, repeaters will now reject flood packets which look like they are in a loop. This has been happening recently in some meshes when there is just a single 'bad' repeater firmware out there (prob some forked or custom firmware). If the payload is messed with, then forwarded, the same packet ends up causing a packet storm, repeated up to the max 64 hops. This feature was added in firmware 1.14</p>
+<p><strong>Note:</strong> When it is enabled, repeaters will now reject flood packets which look like they are in a loop. This has been happening recently in some meshes when there is just a single 'bad' repeater firmware out there (probably some forked or custom firmware). If the payload is messed with, then forwarded, the same packet ends up causing a packet storm, repeated up to the max 64 hops. This feature was added in firmware 1.14</p>
 <p><strong>Example:</strong> If preference is <code>loop.detect minimal</code>, and a 1-byte path size packet is received, the repeater will see if its own ID/hash is already in the path. If it's already encoded 4 times, it will reject the packet.  If the packet uses 2-byte path size, and repeater's own ID/hash is already encoded 2 times, it rejects. If the packet uses 3-byte path size, and the repeater's own ID/hash is already encoded 1 time, it rejects. </p>
 <hr />
 <h4 id="view-or-change-the-retransmit-delay-factor-for-flood-traffic">View or change the retransmit delay factor for flood traffic</h4>
@@ -3406,6 +3419,7 @@
 <p><strong>Parameters:</strong>
 - <code>value</code>: Transmit delay factor (0-2)</p>
 <p><strong>Default:</strong> <code>0.5</code></p>
+<p><strong>Note:</strong> When multiple nearby repeaters all hear the same flood packet, each waits a random amount of time before retransmitting to avoid simultaneous collisions. This factor scales the size of that random window. Higher values reduce collision risk at the cost of added latency. <code>0</code> disables the window entirely.</p>
 <hr />
 <h4 id="view-or-change-the-retransmit-delay-factor-for-direct-traffic">View or change the retransmit delay factor for direct traffic</h4>
 <p><strong>Usage:</strong>
@@ -3414,6 +3428,7 @@
 <p><strong>Parameters:</strong>
 - <code>value</code>: Direct transmit delay factor (0-2)</p>
 <p><strong>Default:</strong> <code>0.2</code></p>
+<p><strong>Note:</strong> Same collision-avoidance random window as <code>txdelay</code>, but applied to direct (non-flood, routed) traffic. The default is lower because direct packets are addressed to a specific next hop, so far fewer nodes compete to retransmit them.</p>
 <hr />
 <h4 id="experimental-view-or-change-the-processing-delay-for-received-traffic">[Experimental] View or change the processing delay for received traffic</h4>
 <p><strong>Usage:</strong>
@@ -3422,6 +3437,7 @@
 <p><strong>Parameters:</strong>
 - <code>value</code>: Receive delay base (0-20)</p>
 <p><strong>Default:</strong> <code>0.0</code></p>
+<p><strong>Note:</strong> When enabled, repeaters that received a flood packet with a weak signal are held in a delay queue before processing, while those that received it with a strong signal process it immediately. This gives strong-signal paths forwarding priority. By the time weak-signal nodes process their copy, the packet may have already propagated and will be suppressed as a duplicate, reducing redundant retransmissions.</p>
 <hr />
 <h4 id="view-or-change-the-duty-cycle-limit">View or change the duty cycle limit</h4>
 <p><strong>Usage:</strong>
@@ -3503,6 +3519,15 @@
 - <code>value</code>: Maximum flood hop count (0-64)</p>
 <p><strong>Default:</strong> <code>64</code></p>
 <hr />
+<h4 id="limit-the-number-of-hops-for-an-unscoped-flood-message">Limit the number of hops for an unscoped flood message</h4>
+<p><strong>Usage:</strong>
+- <code>get flood.max.unscoped</code>
+- <code>set flood.max.unscoped &lt;value&gt;</code></p>
+<p><strong>Parameters:</strong>
+- <code>value</code>: Maximum flood hop count (0-64) for a packet without a scope (no region set)</p>
+<p><strong>Default:</strong> <code>0xFF</code> - indicates it hasn't been set, will track flood.max until it is.</p>
+<p><strong>Note:</strong> An alternative to <code>region denyf *</code>, setting <code>flood.max.unscoped</code> to a lower value such as <code>3</code> would allow for local unscoped messages to propagate, while preventing noisy neighbors from flooding a local region.</p>
+<hr />
 <h3 id="acl">ACL</h3>
 <h4 id="add-update-or-remove-permissions-for-a-companion">Add, update or remove permissions for a companion</h4>
 <p><strong>Usage:</strong> 
@@ -3585,6 +3610,34 @@
 - <code>name</code>: Region name
 - <code>parent_name</code>: Parent region name (optional, defaults to wildcard)</p>
 <hr />
+<h4 id="define-region-hierarchy-single-line">Define region hierarchy (single line)</h4>
+<p><strong>Usage:</strong>
+- <code>region def &lt;token&gt; [&lt;token&gt; ...]</code></p>
+<p><strong>Parameters (tokens):</strong> Space-separated. A logical <strong>cursor</strong> starts at the wildcard <code>*</code>.</p>
+<ul>
+<li><strong><code>name</code></strong> — Create <code>name</code> as a child of the current cursor (equivalent to <code>region put name</code> with the cursor as parent). Cursor moves to <code>name</code>.</li>
+<li><strong><code>name|jump</code></strong> <em>(or <code>name,jump</code>)</em> — Create <code>name</code> as a child of the current cursor, then move the cursor to <code>jump</code> (must already exist on the node, or have been created earlier in this command). <code>jump</code> is <strong>not</strong> the parent of <code>name</code>; use this form to pop back up and start another branch.</li>
+</ul>
+<p><strong>Behavior:</strong> Each created region defaults to flood-allowed (same as <code>region put</code>). The reply is the resulting region tree (same format as bare <code>region</code>); review it before running <code>region save</code> to persist. On error, the reply is <code>Err - ...</code> and any regions placed before the failure remain on the node, just like a partial chain of <code>region put</code>.</p>
+<p><strong>Existing regions:</strong> <code>region def</code> does not clear the existing tree — if a name already exists, its parent is updated to the current cursor; otherwise a new region is created. To start from scratch, <code>region remove</code> the unwanted regions first.</p>
+<p><strong>Limits:</strong> Repeater serial accepts one line up to <strong>160 characters</strong>. For larger trees, split across multiple <code>region def</code> commands; the cursor resets to <code>*</code> between commands, so lead the next command with <code>child|ancestor</code> to reposition. Each token splits at most once on <code>|</code> — <code>region def a|b|c|d</code> is not a flat-list shorthand; see the flat-list example below.</p>
+<p><strong>Example — linear chain</strong> (each token becomes a child of the previous):</p>
+<pre><code>region def a b c d e
+region save
+</code></pre>
+<p><strong>Example — branched tree</strong> (equivalent to <code>region put a</code>, <code>region put b a</code>, <code>region put c b</code>, <code>region put d c</code>, <code>region put e b</code>, <code>region put f e</code>):</p>
+<pre><code>region def a b c d|b e f
+region save
+</code></pre>
+<p><strong>Example — error and partial state:</strong></p>
+<pre><code>region def a b c|nope d
+</code></pre>
+<p>The reply is <code>Err - unknown jump: nope</code>. <code>a</code>, <code>b</code>, and <code>c</code> were placed before the failure; <code>d</code> was not. Run <code>region</code> to inspect, then re-run with a corrected jump or repair with <code>region remove</code> / <code>region put</code>.</p>
+<p><strong>Example — flat list</strong> (each region a child of <code>*</code>). Use <code>|*</code> after each token to pop the cursor back to the root before the next token:</p>
+<pre><code>region def a|* b|* c|* d|* e|* f
+region save
+</code></pre>
+<hr />
 <h4 id="remove-a-region">Remove a region</h4>
 <p><strong>Usage:</strong> 
 - <code>region remove &lt;name&gt;</code></p>
@@ -3598,7 +3651,7 @@
 <p><strong>Serial Only:</strong> Yes</p>
 <p><strong>Parameters:</strong>
 - <code>filter</code>: <code>allowed</code>|<code>denied</code></p>
-<p><strong>Note:</strong> Requires firmware 1.12.+</p>
+<p><strong>Note:</strong> Requires firmware 1.12+</p>
 <hr />
 <h4 id="dump-all-defined-regions-and-flood-permissions">Dump all defined regions and flood permissions</h4>
 <p><strong>Usage:</strong> 
@@ -3712,7 +3765,7 @@ region save
 - <code>start</code>: Optional starting index (defaults to 0)</p>
 <p><strong>Note:</strong> Output format: <code>&lt;var_name&gt;=&lt;value&gt;\n</code></p>
 <hr />
-<h4 id="view-or-change-thevalue-of-a-sensor">View or change thevalue of a sensor</h4>
+<h4 id="view-or-change-the-value-of-a-sensor">View or change the value of a sensor</h4>
 <p><strong>Usage:</strong> 
 - <code>sensor get &lt;key&gt;</code>
 - <code>sensor set &lt;key&gt; &lt;value&gt;</code></p>