deploy: 6c7c9f3f83

cli_commands/index.html

@@ -738,6 +738,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View or change the LoRa FEM receive-path gain state on supported boards
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -1003,6 +1014,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#enable-or-disable-hardware-channel-activity-detection-cad" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Enable or disable hardware Channel Activity Detection (CAD)
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -1544,6 +1566,34 @@
       </ul>
     </nav>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#ethernet-when-ethernet-support-is-compiled-in" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Ethernet (when Ethernet support is compiled in)
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Ethernet (when Ethernet support is compiled in)">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#view-ethernet-connection-status" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View Ethernet connection status
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
         
       </ul>
@@ -3108,6 +3158,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View or change the LoRa FEM receive-path gain state on supported boards
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -3373,6 +3434,17 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#enable-or-disable-hardware-channel-activity-detection-cad" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Enable or disable hardware Channel Activity Detection (CAD)
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -3914,6 +3986,34 @@
       </ul>
     </nav>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#ethernet-when-ethernet-support-is-compiled-in" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Ethernet (when Ethernet support is compiled in)
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Ethernet (when Ethernet support is compiled in)">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#view-ethernet-connection-status" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        View Ethernet connection status
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
         
       </ul>
@@ -3967,6 +4067,7 @@
 <li><a href="#gps-when-gps-support-is-compiled-in">GPS</a></li>
 <li><a href="#sensors-when-sensor-support-is-compiled-in">Sensors</a></li>
 <li><a href="#bridge-when-bridge-support-is-compiled-in">Bridge</a></li>
+<li><a href="#ethernet-when-ethernet-support-is-compiled-in">Ethernet</a></li>
 </ul>
 <hr />
 <h2 id="operational">Operational</h2>
@@ -4129,6 +4230,16 @@
 <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 />
+<h4 id="view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards">View or change the LoRa FEM receive-path gain state on supported boards</h4>
+<p><strong>Usage:</strong>
+- <code>get radio.fem.rxgain</code>
+- <code>set radio.fem.rxgain &lt;state&gt;</code></p>
+<p><strong>Parameters:</strong>
+- <code>state</code>: <code>on</code>|<code>off</code></p>
+<p><strong>Notes:</strong>
+- This controls the external LoRa FEM receive-path LNA where the board supports it.
+- This is separate from <code>radio.rxgain</code>, which controls the radio chip receive gain mode.</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>
@@ -4138,7 +4249,7 @@
 - <code>name</code>: Node name</p>
 <p><strong>Set by build flag:</strong> <code>ADVERT_NAME</code></p>
 <p><strong>Default:</strong> Varies by board</p>
-<p><strong>Note:</strong> Max length varies. If a location is set, the max length is 24 bytes; 32 otherwise. Emoji and unicode characters may take more than one byte.</p>
+<p><strong>Note:</strong> Advertised names can use up to 23 bytes when location is included and 31 bytes otherwise. Emoji and Unicode characters may take more than one byte. Names that exceed the available advert space are truncated at a valid UTF-8 code point boundary.</p>
 <hr />
 <h4 id="view-or-change-this-nodes-latitude">View or change this node's latitude</h4>
 <p><strong>Usage:</strong>
@@ -4331,6 +4442,15 @@
 - <code>value</code>: Interference threshold value</p>
 <p><strong>Default:</strong> <code>0.0</code></p>
 <hr />
+<h4 id="enable-or-disable-hardware-channel-activity-detection-cad">Enable or disable hardware Channel Activity Detection (CAD)</h4>
+<p><strong>Usage:</strong>
+- <code>get cad</code>
+- <code>set cad &lt;on|off&gt;</code></p>
+<p><strong>Description:</strong> When enabled, the radio performs a hardware Channel Activity Detection scan before transmitting and defers if the channel is busy. Runs independently of <code>int.thresh</code> — either, both, or none may be active.</p>
+<p><strong>Parameters:</strong>
+- <code>on|off</code>: Enable or disable hardware CAD</p>
+<p><strong>Default:</strong> <code>off</code></p>
+<hr />
 <h4 id="view-or-change-the-agc-reset-interval">View or change the AGC Reset Interval</h4>
 <p><strong>Usage:</strong>
 - <code>get agc.reset.interval</code>
@@ -4704,6 +4824,21 @@ region save
 <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 />
+<h3 id="ethernet-when-ethernet-support-is-compiled-in">Ethernet (when Ethernet support is compiled in)</h3>
+<p>Ethernet support is available on RAK4631 boards with a RAK13800 (W5100S) Ethernet module. Use the <code>_ethernet</code> firmware variants (e.g. <code>RAK_4631_repeater_ethernet</code>) to enable this feature.</p>
+<hr />
+<h4 id="view-ethernet-connection-status">View Ethernet connection status</h4>
+<p><strong>Usage:</strong>
+- <code>eth.status</code></p>
+<p><strong>Output:</strong>
+- <code>ETH: &lt;ip&gt;:&lt;port&gt;</code> when connected (e.g. <code>ETH: 192.168.1.50:23</code>)
+- <code>ETH: not connected</code> when Ethernet is not active</p>
+<p><strong>Notes:</strong>
+- Available on repeater and room server firmware only. Companion radio ethernet firmware does not expose a CLI.
+- The Ethernet interface obtains an IP address via DHCP automatically on boot.
+- A TCP server listens on port 23 (default) for CLI connections.
+- Connect with any TCP client (e.g. <code>nc</code>, PuTTY) to access the same CLI available over serial.</p>
+<hr />