deploy: c724f8cc9f

cli_commands/index.html

@@ -23,7 +23,7 @@
       
       
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.4">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
     
     
       
@@ -399,6 +399,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#send-a-zero-hop-advert" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Send a zero-hop advert
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -799,6 +810,28 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-this-nodes-public-key" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View this node's public key
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-this-nodes-configured-role" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View this node's configured role
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -838,6 +871,28 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-or-change-this-nodes-advert-path-hash-size" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View or change this node's advert path hash size
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-or-change-this-nodes-loop-detection" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View or change this node's loop detection
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -1255,6 +1310,17 @@
     <nav class="md-nav" aria-label="Bridge (When bridge support is compiled in)">
       <ul class="md-nav__list">
         
+          <li class="md-nav__item">
+  <a href="#view-the-compiled-bridge-type" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the compiled bridge type
+      
+    </span>
+  </a>
+  
+</li>
+        
           <li class="md-nav__item">
   <a href="#view-or-change-the-bridge-enabled-flag" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1330,6 +1396,61 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-bootloader-version-nrf52-only" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the bootloader version (nRF52 only)
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-power-management-support" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View power management support
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-current-power-source" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the current power source
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-boot-reset-and-shutdown-reasons" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the boot reset and shutdown reasons
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-boot-voltage" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the boot voltage
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -1733,6 +1854,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#send-a-zero-hop-advert" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Send a zero-hop advert
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -2133,6 +2265,28 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-this-nodes-public-key" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View this node's public key
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-this-nodes-configured-role" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View this node's configured role
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -2172,6 +2326,28 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-or-change-this-nodes-advert-path-hash-size" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View or change this node's advert path hash size
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-or-change-this-nodes-loop-detection" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View or change this node's loop detection
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -2589,6 +2765,17 @@
     <nav class="md-nav" aria-label="Bridge (When bridge support is compiled in)">
       <ul class="md-nav__list">
         
+          <li class="md-nav__item">
+  <a href="#view-the-compiled-bridge-type" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the compiled bridge type
+      
+    </span>
+  </a>
+  
+</li>
+        
           <li class="md-nav__item">
   <a href="#view-or-change-the-bridge-enabled-flag" class="md-nav__link">
     <span class="md-ellipsis">
@@ -2664,6 +2851,61 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-bootloader-version-nrf52-only" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the bootloader version (nRF52 only)
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-power-management-support" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View power management support
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-current-power-source" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the current power source
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-boot-reset-and-shutdown-reasons" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the boot reset and shutdown reasons
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-the-boot-voltage" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View the boot voltage
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -2751,6 +2993,10 @@
 <p><strong>Usage:</strong> 
 - <code>advert</code></p>
 <hr />
+<h3 id="send-a-zero-hop-advert">Send a zero-hop advert</h3>
+<p><strong>Usage:</strong>
+- <code>advert.zerohop</code></p>
+<hr />
 <h3 id="start-an-over-the-air-ota-firmware-update">Start an Over-The-Air (OTA) firmware update</h3>
 <p><strong>Usage:</strong>
 - <code>start ota</code></p>
@@ -2935,12 +3181,20 @@
 <p><strong>Default:</strong> <code>0.0</code> (value defined by board)</p>
 <p><strong>Note:</strong> Returns "Error: unsupported by this board" if hardware doesn't support it</p>
 <hr />
+<h4 id="view-this-nodes-public-key">View this node's public key</h4>
+<p><strong>Usage:</strong> <code>get public.key</code></p>
+<hr />
+<h4 id="view-this-nodes-configured-role">View this node's configured role</h4>
+<p><strong>Usage:</strong> <code>get role</code></p>
+<hr />
 <h4 id="view-or-change-this-nodes-power-saving-flag-repeater-only">View or change this node's power saving flag (Repeater Only)</h4>
 <p><strong>Usage:</strong>
-- <code>powersaving &lt;state&gt;</code>
-- <code>powersaving</code></p>
+- <code>powersaving</code>
+- <code>powersaving on</code>
+- <code>powersaving off</code></p>
 <p><strong>Parameters:</strong> 
-- <code>state</code>: <code>on</code>|<code>off</code> </p>
+- <code>on</code>: enable power saving
+- <code>off</code>: disable power saving</p>
 <p><strong>Default:</strong> <code>on</code></p>
 <p><strong>Note:</strong> When enabled, device enters sleep mode between radio transmissions</p>
 <hr />
@@ -2953,6 +3207,34 @@
   - <code>state</code>: <code>on</code>|<code>off</code></p>
 <p><strong>Default:</strong> <code>on</code></p>
 <hr />
+<h4 id="view-or-change-this-nodes-advert-path-hash-size">View or change this node's advert path hash size</h4>
+<p><strong>Usage:</strong>
+- <code>get path.hash.mode</code>
+- <code>set path.hash.mode &lt;value&gt;</code></p>
+<p><strong>Parameters:</strong>
+- <code>value</code>: Path hash size (0-2)
+  - <code>0</code>: 1 Byte hash size (256 unique ids)[64 max flood]
+  - <code>1</code>: 2 Byte hash size (65,536 unique ids)[32 max flood]
+  - <code>2</code>: 3 Byte hash size (16,777,216 unique ids)[21 max flood]
+  - <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>
+<hr />
+<h4 id="view-or-change-this-nodes-loop-detection">View or change this node's loop detection</h4>
+<p><strong>Usage:</strong>
+- <code>get loop.detect</code>
+- <code>set loop.detect &lt;state&gt;</code></p>
+<p><strong>Parameters:</strong>
+- <code>state</code>: 
+  - <code>off</code>: no loop detection is performed
+  - <code>minimal</code>: packets are dropped if repeater's ID/hash appears 4 or more times (1-byte), 2 or more (2-byte), 1 or more (3-byte)
+  - <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>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>
 <p><strong>Usage:</strong>
 - <code>get txdelay</code>
@@ -3242,6 +3524,9 @@ region save
 - <code>value</code>: The value to set the sensor to</p>
 <hr />
 <h3 id="bridge-when-bridge-support-is-compiled-in">Bridge (When bridge support is compiled in)</h3>
+<h4 id="view-the-compiled-bridge-type">View the compiled bridge type</h4>
+<p><strong>Usage:</strong> <code>get bridge.type</code></p>
+<hr />
 <h4 id="view-or-change-the-bridge-enabled-flag">View or change the bridge enabled flag</h4>
 <p><strong>Usage:</strong>
 - <code>get bridge.enabled</code>
@@ -3268,9 +3553,9 @@ region save
 - <code>set bridge.source &lt;source&gt;</code></p>
 <p><strong>Parameters:</strong>
 - <code>source</code>: 
-  - <code>rx</code>: bridges received packets
-  - <code>tx</code>: bridges transmitted packets</p>
-<p><strong>Default:</strong> <code>tx</code></p>
+  - <code>logRx</code>: bridges received packets
+  - <code>logTx</code>: bridges transmitted packets</p>
+<p><strong>Default:</strong> <code>logTx</code></p>
 <hr />
 <h4 id="view-or-change-the-speed-of-the-bridge-rs-232-only">View or change the speed of the bridge (RS-232 only)</h4>
 <p><strong>Usage:</strong>
@@ -3292,9 +3577,27 @@ region save
 - <code>get bridge.secret</code>
 - <code>set bridge.secret &lt;secret&gt;</code></p>
 <p><strong>Parameters:</strong>
-- <code>secret</code>: 16-character encryption secret</p>
+- <code>secret</code>: ESP-NOW bridge secret, up to 15 characters</p>
 <p><strong>Default:</strong> Varies by board</p>
 <hr />
+<h4 id="view-the-bootloader-version-nrf52-only">View the bootloader version (nRF52 only)</h4>
+<p><strong>Usage:</strong> <code>get bootloader.ver</code></p>
+<hr />
+<h4 id="view-power-management-support">View power management support</h4>
+<p><strong>Usage:</strong> <code>get pwrmgt.support</code></p>
+<hr />
+<h4 id="view-the-current-power-source">View the current power source</h4>
+<p><strong>Usage:</strong> <code>get pwrmgt.source</code></p>
+<p><strong>Note:</strong> Returns an error on boards without power management support.</p>
+<hr />
+<h4 id="view-the-boot-reset-and-shutdown-reasons">View the boot reset and shutdown reasons</h4>
+<p><strong>Usage:</strong> <code>get pwrmgt.bootreason</code></p>
+<p><strong>Note:</strong> Returns an error on boards without power management support.</p>
+<hr />
+<h4 id="view-the-boot-voltage">View the boot voltage</h4>
+<p><strong>Usage:</strong> <code>get pwrmgt.bootmv</code></p>
+<p><strong>Note:</strong> Returns an error on boards without power management support.</p>
+<hr />