mirror of
https://github.com/mikecarper/MeshCore.git
synced 2026-10-22 16:31:15 +00:00
deploy: ccdc8ffe4e
This commit is contained in:
1 parent
7b8e57fae6
commit
5b772ee735
4 files changed
+173
-3
No files matched your search
@@ -1802,6 +1802,42 @@
|
||||
URL.revokeObjectURL(url);
|
||||
});
|
||||
|
||||
const policyPanel = root.querySelector(".filter-policy");
|
||||
const policyGrid = policyPanel ? policyPanel.parentElement : null;
|
||||
const policyMarker = document.createComment("policy-draft-home");
|
||||
const widePolicyLayout = global.matchMedia("(min-width: 90rem)");
|
||||
let policyRail = null;
|
||||
let policySidebar = null;
|
||||
|
||||
if (policyPanel && policyGrid) policyGrid.insertBefore(policyMarker, policyPanel);
|
||||
|
||||
function placePolicyDraft() {
|
||||
if (!policyPanel || !policyGrid) return;
|
||||
const sidebar = document.querySelector(".md-sidebar--secondary");
|
||||
const sidebarInner = sidebar ? sidebar.querySelector(".md-sidebar__inner") : null;
|
||||
if (widePolicyLayout.matches && sidebarInner) {
|
||||
if (!policyRail) {
|
||||
policyRail = document.createElement("div");
|
||||
policyRail.className = "filter-tool filter-policy-rail";
|
||||
policyRail.setAttribute("aria-label", "Policy draft");
|
||||
}
|
||||
policySidebar = sidebar;
|
||||
policySidebar.classList.add("filter-policy-sidebar");
|
||||
sidebarInner.appendChild(policyRail);
|
||||
policyRail.appendChild(policyPanel);
|
||||
root.classList.add("filter-policy-detached");
|
||||
return;
|
||||
}
|
||||
policyMarker.parentNode.insertBefore(policyPanel, policyMarker.nextSibling);
|
||||
root.classList.remove("filter-policy-detached");
|
||||
if (policySidebar) policySidebar.classList.remove("filter-policy-sidebar");
|
||||
if (policyRail) policyRail.remove();
|
||||
policySidebar = null;
|
||||
}
|
||||
|
||||
widePolicyLayout.addEventListener("change", placePolicyDraft);
|
||||
placePolicyDraft();
|
||||
|
||||
const requestedExample = new URLSearchParams(global.location.search).get("example");
|
||||
if (requestedExample && COMPLETE_EXAMPLES[requestedExample]) assignRules(clone(COMPLETE_EXAMPLES[requestedExample]));
|
||||
resetForm();
|
||||
|
||||
@@ -177,6 +177,24 @@
|
||||
align-items: start;
|
||||
}
|
||||
|
||||
.filter-tool.filter-policy-detached .filter-tool-grid {
|
||||
grid-template-columns: minmax(0, 1fr);
|
||||
}
|
||||
|
||||
.filter-policy-rail {
|
||||
margin: 1rem 0 2rem;
|
||||
}
|
||||
|
||||
.filter-policy-rail .filter-policy {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
@media (min-width: 90rem) {
|
||||
.md-sidebar--secondary.filter-policy-sidebar {
|
||||
width: 20rem;
|
||||
}
|
||||
}
|
||||
|
||||
.filter-panel {
|
||||
min-width: 0;
|
||||
padding: 1rem;
|
||||
|
||||
+118
-2
@@ -514,6 +514,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#payload-type-reference" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Payload type reference
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1002,6 +1013,17 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#payload-type-reference" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Payload type reference
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1087,11 +1109,11 @@ in the simulator below. The examples draw from
|
||||
<tr><th><code>type=</code> value</th><th>Matches</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>grp_data</code></td><td>Only the named payload type</td></tr>
|
||||
<tr><td><a href="#payload-type-reference"><code>grp_data</code></a></td><td>Only the named payload type; see every exact type below</td></tr>
|
||||
<tr><td><code>any</code></td><td>Every payload type</td></tr>
|
||||
<tr><td><code>class:group</code></td><td>GRP_TXT and GRP_DATA</td></tr>
|
||||
<tr><td><code>class:login</code></td><td>REQ, RESPONSE, TXT_MSG, ANON_REQ, and PATH</td></tr>
|
||||
<tr><td><code>class:other</code></td><td>Every remaining payload type</td></tr>
|
||||
<tr><td><code>class:other</code></td><td>Every remaining payload type that is not group or login</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="filter-primer-table">
|
||||
@@ -1616,6 +1638,100 @@ in the simulator below. The examples draw from
|
||||
</section>
|
||||
</div>
|
||||
|
||||
<h2 id="payload-type-reference">Payload type reference</h2>
|
||||
<p>Use an exact <code>type=</code> value when a rule should match only one payload type.
|
||||
The class column shows which broader selector also matches it.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th><code>type=</code> value</th>
|
||||
<th>Payload</th>
|
||||
<th>Class</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>req</code></td>
|
||||
<td>Request</td>
|
||||
<td><code>class:login</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>response</code></td>
|
||||
<td>Response</td>
|
||||
<td><code>class:login</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>txt_msg</code></td>
|
||||
<td>Peer text message</td>
|
||||
<td><code>class:login</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ack</code></td>
|
||||
<td>Acknowledgment</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>advert</code></td>
|
||||
<td>Node advertisement</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>grp_txt</code></td>
|
||||
<td>Group-channel text</td>
|
||||
<td><code>class:group</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>grp_data</code></td>
|
||||
<td>Group-channel datagram</td>
|
||||
<td><code>class:group</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>anon_req</code></td>
|
||||
<td>Anonymous request</td>
|
||||
<td><code>class:login</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>path</code></td>
|
||||
<td>Returned path</td>
|
||||
<td><code>class:login</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>trace</code></td>
|
||||
<td>Path trace</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>multipart</code></td>
|
||||
<td>One frame in a multipart sequence</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>control</code></td>
|
||||
<td>Control or discovery data</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ota</code></td>
|
||||
<td>OTA-over-LoRa data</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>13</code></td>
|
||||
<td>Reserved payload type 13</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>14</code></td>
|
||||
<td>Reserved payload type 14</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>raw_custom</code></td>
|
||||
<td>Application-defined raw data</td>
|
||||
<td><code>class:other</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="proposed-evaluation-contract">Proposed evaluation contract</h2>
|
||||
<p>The simulator uses these rules:</p>
|
||||
<ol>
|
||||
|
||||
@@ -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":"Introduction","text":"<p>Welcome to the MeshCore documentation.</p> <p>Below are a few quick start guides.</p> <ul> <li>Frequently Asked Questions</li> <li>CLI Commands</li> <li>Filter Policy Playground</li> <li>Telemetry History Decoder</li> <li>CLI Availability by Firmware Build</li> <li>Easy LoRa OTA: ESP32 full images and nRF52 deltas</li> <li>MeshTower V2 microSD self-updates</li> <li>GPS Tracking</li> <li>Companion Protocol</li> <li>Packet Format</li> <li>QR Codes</li> </ul> <p>If you find a mistake in any of our documentation, or find something is missing, please feel free to open a pull request for us to review.</p> <ul> <li>Documentation Source</li> </ul>"},{"location":"WiFi/","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. For example, a logging repeater is not an MQTT observer, and a WiFi companion does not publish to MQTT unless its target name also contains <code>mqtt</code>.</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 USB, BLE, or serial companion 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; 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-specific local interface <code>*_lora_ota_no_external_sensors</code> On demand on ESP32 No Lean LoRa-OTA repeater image; ESP32 builds retain the compact <code>start ota</code> browser uploader <p>Direct on-device WiFi and MQTT are currently ESP32 features. nRF52, STM32, and the currently enabled RP2040 targets do not run this MQTT bridge. An nRF52 connected to a Raspberry Pi can still be logged or uplinked by software on the Pi, but that is a separate host-side bridge rather than MQTT running in the radio firmware.</p>"},{"location":"WiFi/#how-the-mqtt-bridge-works","title":"How the MQTT bridge works","text":"<p>The MQTT bridge is an outbound observer. It does not subscribe to MQTT topics and does not inject broker messages into LoRa.</p> <p>For a received packet, the flow is:</p> <pre><code>LoRa radio -> successful packet parse -> MQTT capture queue -> broker slots\n \\----> normal MeshCore filtering/handling\n</code></pre> <p>Packets transmitted by the node can also be queued according to <code>mqtt.tx</code>. Receive capture happens before the packet is passed to the normal MeshCore flood filters and forwarding decision. A packet may therefore be observed on MQTT even when a later scope, path, region, duplicate, or repeat rule prevents the node from forwarding it over LoRa.</p> <p>MQTT publication and LoRa repetition are separate:</p> <ul> <li><code>set repeat on|off</code> controls whether an observer repeats eligible LoRa packets;</li> <li><code>set bridge.enabled on|off</code> starts or stops the MQTT bridge;</li> <li><code>set mqtt.rx on|off</code> controls uplinking of received packets;</li> <li><code>set mqtt.tx Line truncated
|
||||
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Introduction","text":"<p>Welcome to the MeshCore documentation.</p> <p>Below are a few quick start guides.</p> <ul> <li>Frequently Asked Questions</li> <li>CLI Commands</li> <li>Filter Policy Playground</li> <li>Telemetry History Decoder</li> <li>CLI Availability by Firmware Build</li> <li>Easy LoRa OTA: ESP32 full images and nRF52 deltas</li> <li>MeshTower V2 microSD self-updates</li> <li>GPS Tracking</li> <li>Companion Protocol</li> <li>Packet Format</li> <li>QR Codes</li> </ul> <p>If you find a mistake in any of our documentation, or find something is missing, please feel free to open a pull request for us to review.</p> <ul> <li>Documentation Source</li> </ul>"},{"location":"WiFi/","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. For example, a logging repeater is not an MQTT observer, and a WiFi companion does not publish to MQTT unless its target name also contains <code>mqtt</code>.</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 USB, BLE, or serial companion 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; 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-specific local interface <code>*_lora_ota_no_external_sensors</code> On demand on ESP32 No Lean LoRa-OTA repeater image; ESP32 builds retain the compact <code>start ota</code> browser uploader <p>Direct on-device WiFi and MQTT are currently ESP32 features. nRF52, STM32, and the currently enabled RP2040 targets do not run this MQTT bridge. An nRF52 connected to a Raspberry Pi can still be logged or uplinked by software on the Pi, but that is a separate host-side bridge rather than MQTT running in the radio firmware.</p>"},{"location":"WiFi/#how-the-mqtt-bridge-works","title":"How the MQTT bridge works","text":"<p>The MQTT bridge is an outbound observer. It does not subscribe to MQTT topics and does not inject broker messages into LoRa.</p> <p>For a received packet, the flow is:</p> <pre><code>LoRa radio -> successful packet parse -> MQTT capture queue -> broker slots\n \\----> normal MeshCore filtering/handling\n</code></pre> <p>Packets transmitted by the node can also be queued according to <code>mqtt.tx</code>. Receive capture happens before the packet is passed to the normal MeshCore flood filters and forwarding decision. A packet may therefore be observed on MQTT even when a later scope, path, region, duplicate, or repeat rule prevents the node from forwarding it over LoRa.</p> <p>MQTT publication and LoRa repetition are separate:</p> <ul> <li><code>set repeat on|off</code> controls whether an observer repeats eligible LoRa packets;</li> <li><code>set bridge.enabled on|off</code> starts or stops the MQTT bridge;</li> <li><code>set mqtt.rx on|off</code> controls uplinking of received packets;</li> <li><code>set mqtt.tx Line truncated
|
||||
Reference in new issue
Block a user