mirror of
https://github.com/mikecarper/MeshCore.git
synced 2026-10-30 17:42:59 +00:00
deploy: af106a0ee9
This commit is contained in:
mikecarper committed
1 parent
4b1da44000
commit
2ddda64552
2 files changed
+120
-1
No files matched your search
@@ -2708,6 +2708,28 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#pause-forwarding-when-the-battery-is-low" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Pause forwarding when the battery is low
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#set-the-battery-percentage-voltage-range" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Set the battery percentage voltage range
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -5788,6 +5810,28 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#pause-forwarding-when-the-battery-is-low" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Pause forwarding when the battery is low
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#set-the-battery-percentage-voltage-range" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Set the battery percentage voltage range
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -9686,6 +9730,81 @@ board-specific multiplier behavior, or return unsupported.</p>
|
||||
- <code>battery.alert.critical</code>: <code>10</code></p>
|
||||
<p><strong>Note:</strong> The low threshold must be greater than the critical threshold. Alerts at or below the critical threshold use <code>CRITICAL BATTERY</code> in the message; both severities use the same 12-hour resend cooldown.</p>
|
||||
<hr />
|
||||
<h4 id="pause-forwarding-when-the-battery-is-low">Pause forwarding when the battery is low</h4>
|
||||
<p><strong>Search terms:</strong> low battery repeating, battery flood cutoff, save battery,
|
||||
automatic repeat off.</p>
|
||||
<p>Repeater, Room Server, and Sensor firmware can automatically pause forwarding
|
||||
below a configured battery percentage. Both controls default to <code>off</code>, including
|
||||
when upgrading. They are independent of battery alerts.</p>
|
||||
<p><strong>Usage:</strong></p>
|
||||
<ul>
|
||||
<li><code>get repeat.battery</code></li>
|
||||
<li><code>set repeat.battery <off|on|1-100></code></li>
|
||||
<li><code>get flood.battery</code></li>
|
||||
<li><code>set flood.battery <off|on|1-100></code></li>
|
||||
<li><code>get battery.forward</code></li>
|
||||
</ul>
|
||||
<p><code>set repeat.battery on</code> enables the saved repeat threshold, initially <strong>10%</strong>.
|
||||
<code>set flood.battery on</code> enables the saved flood threshold, initially <strong>20%</strong>.
|
||||
A number both enables the control and sets its threshold. <code>off</code> disables it
|
||||
while retaining that threshold for the next <code>on</code>. Changes are saved and take
|
||||
effect without a reboot.</p>
|
||||
<p>Below the repeat threshold, the node stops LoRa retransmissions of received
|
||||
traffic. Below the flood threshold, it stops LoRa retransmissions of received
|
||||
flood traffic but may still
|
||||
relay routed traffic if repeating is otherwise allowed. Neither control stops
|
||||
the node's own transmissions or replies to administration requests. The saved
|
||||
manual repeat flag, flood limits, and forwarding rules remain unchanged; a
|
||||
battery recovery does not override a manual restriction.</p>
|
||||
<p>Received packets entering from a bridge are subject to the same LoRa transmit
|
||||
limits. Exporting radio reception to WiFi, ESP-NOW, or RS232 is unchanged.</p>
|
||||
<p>Forwarding resumes automatically after the measured percentage reaches two
|
||||
percentage points above the applicable threshold, capped at 100%. With the
|
||||
initial thresholds, flood forwarding pauses below 20% and resumes at 22%; all
|
||||
relay forwarding pauses below 10% and resumes at 12%. This recovery margin
|
||||
avoids repeatedly switching forwarding on and off near a threshold.</p>
|
||||
<p>Battery voltage is sampled every 30 seconds while either control is enabled,
|
||||
and immediately when its configuration changes. <code>get battery.forward</code> reports
|
||||
the voltage, estimated percentage, whether the reading is valid, and which
|
||||
battery controls are currently suppressing forwarding. A missing or invalid
|
||||
reading does not suppress forwarding: accepted readings are 2000-20000 mV.
|
||||
Voltage alone does not establish that a battery is physically connected.</p>
|
||||
<p>To enable both default thresholds:</p>
|
||||
<pre><code class="language-text">set repeat.battery on
|
||||
set flood.battery on
|
||||
get battery.forward
|
||||
</code></pre>
|
||||
<p>To choose different thresholds and later disable the feature:</p>
|
||||
<pre><code class="language-text">set repeat.battery 15
|
||||
set flood.battery 25
|
||||
set repeat.battery off
|
||||
set flood.battery off
|
||||
</code></pre>
|
||||
<h4 id="set-the-battery-percentage-voltage-range">Set the battery percentage voltage range</h4>
|
||||
<p>The forwarding thresholds use a voltage-derived percentage. On infrastructure
|
||||
builds without the nRF52 voltage policy, the saved range is adjustable with:</p>
|
||||
<pre><code class="language-text">get battery.empty
|
||||
get battery.full
|
||||
set battery.empty 3000
|
||||
set battery.full 4200
|
||||
</code></pre>
|
||||
<p>Values are millivolts, from 2000 to 20000, with full at least 100 mV above empty.
|
||||
The default range comes from the board's compiled battery endpoints, normally
|
||||
3000 mV for 0% and 4200 mV for 100%; boards with a two-cell pack retain their
|
||||
compiled pack range. The percentage is interpolated between those endpoints
|
||||
and limited to 0-100%. These settings describe the battery
|
||||
range; they do not calibrate the voltage measurement or alter a charger.</p>
|
||||
<p>Supported nRF52 power-management builds use their existing saved
|
||||
<code>battery.profile</code>, <code>battery.empty</code>, and <code>battery.full</code> values instead. Their
|
||||
endpoint range remains 2000-4200 mV, with at least 100 mV between endpoints.
|
||||
See <a href="#configure-nrf52-battery-protection">nRF52 battery protection</a> for profiles
|
||||
and their separate boot-lock and cutoff effects. <code>set adc.multiplier</code> adjusts
|
||||
voltage calibration on boards that support it; see
|
||||
<a href="#fine-tune-the-battery-reading">battery reading calibration</a>.</p>
|
||||
<p>Percentage remains an estimate: a voltage reading under transmit load may
|
||||
differ from an idle reading. Check the reported voltage against a voltmeter
|
||||
before relying on automatic forwarding limits.</p>
|
||||
<hr />
|
||||
<h4 id="enable-or-disable-the-rx-inactivity-watchdog-repeater-only">Enable or disable the RX inactivity watchdog (Repeater Only)</h4>
|
||||
<p><strong>Usage:</strong>
|
||||
- <code>get rx.watchdog</code>
|
||||
|
||||
@@ -1 +1 @@
|
||||
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Home","text":"<p>View this page on MeshCore Docs.</p>"},{"location":"#meshcore-documentation","title":"MeshCore documentation","text":"<p>Choose firmware with the firmware picker. For help with a device already in service, start with the FAQ.</p>"},{"location":"#current-release","title":"Current release","text":"<ul> <li>1.17.1.8 USA Cascade release notes</li> <li>Test Results \u2014 validation archive and 1.17.1.8 Preview 1 qualification evidence</li> </ul>"},{"location":"#documentation","title":"Documentation","text":"<ul> <li> <p>SolarXiao Base/Advanced/MPPT detection and battery controls</p> </li> <li> <p>Feature switches by role and Full Companion features</p> </li> <li>Firmware update guide, easy LoRa OTA, and scripted LoRa OTA</li> <li>CLI commands, availability by build, and radio profiles</li> <li>Private fleet management: signed filtering and secondary-radio commands for a fleet or one node</li> <li>Room history, moderation, and information board: optional persistent chat and local Wi-Fi room access</li> <li>Companion protocol, packet format, and QR codes</li> </ul> <p>The navigation groups the remaining guides under Documentation, including board-specific updates, networking, power, and protocol references.</p>"},{"location":"#tools","title":"Tools","text":"<ul> <li>Firmware picker and USB web console</li> <li>Notification builder and temporary radio test builder</li> <li>Filter policy playground, telemetry decoder, and management report decoder</li> </ul>"},{"location":"#engineering-records","title":"Engineering records","text":"<ul> <li>Research \u2014 design notes, diagnostics, and historical update-chain studies</li> <li>Old Releases \u2014 historical release notes and supporting files</li> </ul> <p>Found a mistake or missing information? Edit the documentation.</p>"},{"location":"WiFi/","title":"WiFi","text":"<p>View this page on MeshCore Docs.</p>"},{"location":"WiFi/#wifi-and-mqtt-by-firmware-type","title":"WiFi and MQTT by Firmware Type","text":"<p>MeshCore itself does not require WiFi or the internet. LoRa packet exchange, repeating, room servers, companions, and sensors can all operate without either. WiFi is added by particular ESP32 firmware targets for one or more of these purposes:</p> <ul> <li>a TCP connection between a WiFi companion and a phone or computer;</li> <li>the WebConfig browser interface;</li> <li>MQTT uplinking from the radio to internet or LAN brokers;</li> <li>WiFi-assisted OTA services on builds that include them;</li> <li>ESP-NOW bridging, which uses the ESP32's 2.4 GHz radio but is not a connection to a WiFi access point.</li> </ul> <p>The firmware role and the build profile are separate choices. USB logging does not itself provide MQTT. MQTT-capable Full Companions include that feature without <code>mqtt</code> in their filename; check the artifact capability manifest. See feature switches by role for the different Companion and infrastructure controls and the USB web console.</p>"},{"location":"WiFi/#quick-reference","title":"Quick reference","text":"Firmware target or role Infrastructure WiFi MQTT What WiFi does <code>*_repeater</code> Build-dependent on ESP32 No FULL builds provide WebConfig, browser OTA, and the TCP 5001 LoRa-OTA seeder while WiFi is active <code>*_repeater_observer_mqtt</code> Yes Yes Uplinks heard and selected transmitted LoRa packets; repeating remains enabled by default <code>*_room_server</code> Build-dependent on ESP32 No FULL builds provide WebConfig, browser OTA, and the TCP 5001 LoRa-OTA seeder while WiFi is active <code>*_room_server_observer_mqtt</code> Yes Yes Runs the room server and uplinks radio traffic <code>*_companion_radio_wifi</code> Yes No Exposes the MeshCore companion protocol on TCP port 5000 <code>*_companion_radio_wifi_mqtt</code> Yes Yes Runs both the TCP companion interface and the MQTT uplink <code>*_companion_radio_full*</code> ESP32, subject to board/transport selection Where compiled on ESP32 Includes supported USB/wireless transports; configure MQTT through WebConfig Dedicated USB, BLE, or serial companion (not Full) No No Uses the transport named by the target instead <code>*_repeater_bridge_espnow</code> Build-dependent on ESP32 No Uses ESP-NOW for its bridge; <code>bridge.format wrapped|raw</code> selects legacy bridge framing or primary-ESP-NOW compatibility; a FULL build also exposes the TCP 5001 LoRa-OTA seeder whenever WiFi is usable RS232 bridge No No Bridges through a serial interface Ethernet repeater/room server No WiFi No Uses wired Ethernet for its role-specific network interface <code>*_sensor</code> Build-dependent on ESP32 No A FULL ESP32 sensor can expose the TCP 5001 LoRa-OTA seeder through its browser-OTA setup AP Terminal-chat or KISS modem No in current targets No Uses LoRa and its role-specifiLine truncated
|
||||
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Home","text":"<p>View this page on MeshCore Docs.</p>"},{"location":"#meshcore-documentation","title":"MeshCore documentation","text":"<p>Choose firmware with the firmware picker. For help with a device already in service, start with the FAQ.</p>"},{"location":"#current-release","title":"Current release","text":"<ul> <li>1.17.1.8 USA Cascade release notes</li> <li>Test Results \u2014 validation archive and 1.17.1.8 Preview 1 qualification evidence</li> </ul>"},{"location":"#documentation","title":"Documentation","text":"<ul> <li> <p>SolarXiao Base/Advanced/MPPT detection and battery controls</p> </li> <li> <p>Feature switches by role and Full Companion features</p> </li> <li>Firmware update guide, easy LoRa OTA, and scripted LoRa OTA</li> <li>CLI commands, availability by build, and radio profiles</li> <li>Private fleet management: signed filtering and secondary-radio commands for a fleet or one node</li> <li>Room history, moderation, and information board: optional persistent chat and local Wi-Fi room access</li> <li>Companion protocol, packet format, and QR codes</li> </ul> <p>The navigation groups the remaining guides under Documentation, including board-specific updates, networking, power, and protocol references.</p>"},{"location":"#tools","title":"Tools","text":"<ul> <li>Firmware picker and USB web console</li> <li>Notification builder and temporary radio test builder</li> <li>Filter policy playground, telemetry decoder, and management report decoder</li> </ul>"},{"location":"#engineering-records","title":"Engineering records","text":"<ul> <li>Research \u2014 design notes, diagnostics, and historical update-chain studies</li> <li>Old Releases \u2014 historical release notes and supporting files</li> </ul> <p>Found a mistake or missing information? Edit the documentation.</p>"},{"location":"WiFi/","title":"WiFi","text":"<p>View this page on MeshCore Docs.</p>"},{"location":"WiFi/#wifi-and-mqtt-by-firmware-type","title":"WiFi and MQTT by Firmware Type","text":"<p>MeshCore itself does not require WiFi or the internet. LoRa packet exchange, repeating, room servers, companions, and sensors can all operate without either. WiFi is added by particular ESP32 firmware targets for one or more of these purposes:</p> <ul> <li>a TCP connection between a WiFi companion and a phone or computer;</li> <li>the WebConfig browser interface;</li> <li>MQTT uplinking from the radio to internet or LAN brokers;</li> <li>WiFi-assisted OTA services on builds that include them;</li> <li>ESP-NOW bridging, which uses the ESP32's 2.4 GHz radio but is not a connection to a WiFi access point.</li> </ul> <p>The firmware role and the build profile are separate choices. USB logging does not itself provide MQTT. MQTT-capable Full Companions include that feature without <code>mqtt</code> in their filename; check the artifact capability manifest. See feature switches by role for the different Companion and infrastructure controls and the USB web console.</p>"},{"location":"WiFi/#quick-reference","title":"Quick reference","text":"Firmware target or role Infrastructure WiFi MQTT What WiFi does <code>*_repeater</code> Build-dependent on ESP32 No FULL builds provide WebConfig, browser OTA, and the TCP 5001 LoRa-OTA seeder while WiFi is active <code>*_repeater_observer_mqtt</code> Yes Yes Uplinks heard and selected transmitted LoRa packets; repeating remains enabled by default <code>*_room_server</code> Build-dependent on ESP32 No FULL builds provide WebConfig, browser OTA, and the TCP 5001 LoRa-OTA seeder while WiFi is active <code>*_room_server_observer_mqtt</code> Yes Yes Runs the room server and uplinks radio traffic <code>*_companion_radio_wifi</code> Yes No Exposes the MeshCore companion protocol on TCP port 5000 <code>*_companion_radio_wifi_mqtt</code> Yes Yes Runs both the TCP companion interface and the MQTT uplink <code>*_companion_radio_full*</code> ESP32, subject to board/transport selection Where compiled on ESP32 Includes supported USB/wireless transports; configure MQTT through WebConfig Dedicated USB, BLE, or serial companion (not Full) No No Uses the transport named by the target instead <code>*_repeater_bridge_espnow</code> Build-dependent on ESP32 No Uses ESP-NOW for its bridge; <code>bridge.format wrapped|raw</code> selects legacy bridge framing or primary-ESP-NOW compatibility; a FULL build also exposes the TCP 5001 LoRa-OTA seeder whenever WiFi is usable RS232 bridge No No Bridges through a serial interface Ethernet repeater/room server No WiFi No Uses wired Ethernet for its role-specific network interface <code>*_sensor</code> Build-dependent on ESP32 No A FULL ESP32 sensor can expose the TCP 5001 LoRa-OTA seeder through its browser-OTA setup AP Terminal-chat or KISS modem No in current targets No Uses LoRa and its role-specifiLine truncated
|
||||
Reference in new issue
Block a user