dandri/HaloKeymind
1
0
Fork 0
mirror of https://github.com/mikecarper/MeshCore.git synced 2026-09-16 14:42:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 2143d3e04b

Browse Source
This commit is contained in:
mikecarper
2026-08-29 00:31:54 +00:00
parent d1523a1042
commit f18fc614cd
6 changed files with 93 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli_commands/index.html
+1 -1
View File
@@ -5334,7 +5334,7 @@ role-specific terminal on TCP port 5002. Credential writes reply before
restarting the WiFi station, so a TCP client should expect to reconnect at the
new address; USB password input is masked. Binary
Companion clients can use command bytes
<code>0x46</code> and <code>0x47</code> over USB, BLE, or TCP port 5000 without the terminal-start
<code>0x7C</code> and <code>0x7D</code> over USB, BLE, or TCP port 5000 without the terminal-start
token. WiFi-only Companions accept all three modes. Full Companion rejects
<code>none</code> because its simultaneous BLE transport requires modem sleep. Companion
device <code>powersaving</code> and LoRa <code>radio.rxps</code> remain independent. On an ESP32 Full
companion_protocol/index.html
+49 -21
View File
@@ -2863,24 +2863,9 @@ catalog; bytes <code>0x2C</code>-<code>0x31</code> are parked and <code>0x35</co
<td>Queue a fully encoded raw mesh packet.</td>
</tr>
<tr>
<td><code>0x42</code> / <code>0x43</code></td>
<td><code>CMD_GET_RADIO_FEM_RXGAIN</code> / <code>CMD_SET_RADIO_FEM_RXGAIN</code></td>
<td>Read or set FEM receive gain.</td>
</tr>
<tr>
<td><code>0x44</code> / <code>0x45</code></td>
<td><code>CMD_GET_RADIO_RXGAIN</code> / <code>CMD_SET_RADIO_RXGAIN</code></td>
<td>Read or set the radio chip's boosted receive-gain mode.</td>
</tr>
<tr>
<td><code>0x46</code> / <code>0x47</code></td>
<td><code>CMD_GET_WIFI_POWER_SAVE</code> / <code>CMD_SET_WIFI_POWER_SAVE</code></td>
<td>Read or set ESP32 Companion WiFi modem sleep.</td>
</tr>
<tr>
<td><code>0x48</code> / <code>0x49</code></td>
<td><code>CMD_GET_BLUETOOTH_NAME</code> / <code>CMD_SET_BLUETOOTH_NAME</code></td>
<td>Read or set the independent Bluetooth device name.</td>
<td><code>0x42</code></td>
<td><code>CMD_RUN_CLI_COMMAND</code></td>
<td>Run a local CLI command (protocol v14+).</td>
</tr>
<tr>
<td><code>0x4A</code></td>
@@ -2892,13 +2877,49 @@ catalog; bytes <code>0x2C</code>-<code>0x31</code> are parked and <code>0x35</co
<td><code>CMD_BLE_MOTA_SOURCE</code></td>
<td>Query, start, or stop an nRF52 Full Companion's Bluetooth-backed LoRa mOTA source.</td>
</tr>
<tr>
<td><code>0x78</code> / <code>0x79</code></td>
<td><code>CMD_GET_RADIO_FEM_RXGAIN</code> / <code>CMD_SET_RADIO_FEM_RXGAIN</code></td>
<td>Fork extension: read or set FEM receive gain.</td>
</tr>
<tr>
<td><code>0x7A</code> / <code>0x7B</code></td>
<td><code>CMD_GET_RADIO_RXGAIN</code> / <code>CMD_SET_RADIO_RXGAIN</code></td>
<td>Fork extension: read or set the radio chip's boosted receive-gain mode.</td>
</tr>
<tr>
<td><code>0x7C</code> / <code>0x7D</code></td>
<td><code>CMD_GET_WIFI_POWER_SAVE</code> / <code>CMD_SET_WIFI_POWER_SAVE</code></td>
<td>Fork extension: read or set ESP32 Companion WiFi modem sleep.</td>
</tr>
<tr>
<td><code>0x7E</code> / <code>0x7F</code></td>
<td><code>CMD_GET_BLUETOOTH_NAME</code> / <code>CMD_SET_BLUETOOTH_NAME</code></td>
<td>Fork extension: read or set the independent Bluetooth device name.</td>
</tr>
</tbody>
</table>
<p>The sections below detail the most common frames. Refer to the source named
above for command bodies that are not expanded here.</p>
<p>The additive hardware-setting commands <code>0x42</code>-<code>0x47</code> do not change any existing
legacy frame layout. Clients should probe the command they need and treat
<p><code>CMD_RUN_CLI_COMMAND</code> is followed by the local CLI text without a terminating
NUL. The device returns <code>RESP_CODE_CLI_REPLY</code> (<code>0x1D</code>) followed by the reply
text. This is separate from sending a remote on-air CLI command with
<code>CMD_SEND_TXT_MSG</code> and <code>TXT_TYPE_CLI_COMMAND</code>. The body must contain at least
one byte and must not contain an embedded NUL. An unknown command is returned
as the normal CLI reply text <code>Unknown command</code>, not as an error frame.</p>
<p>The fork-specific hardware-setting commands occupy the host-to-device range
<code>0x78</code>-<code>0x7F</code>, the highest currently unused block below the push-frame bit.
Command IDs must stay below <code>0x80</code>; IDs with bit 7 set identify asynchronous
device-to-host push frames. These commands do not change any existing frame
layout. Clients should probe the command they need and treat
<code>ERR_CODE_UNSUPPORTED_CMD</code> as feature absence.</p>
<p>Firmware from this fork predating the upstream <code>0x42</code> allocation used
<code>0x42</code>-<code>0x49</code> for these eight settings. This firmware accepts those values as
deprecated aliases so existing clients continue to work. A one-byte <code>0x42</code>
frame is the legacy FEM-gain GET; <code>0x42</code> followed by text is the official
<code>CMD_RUN_CLI_COMMAND</code>. New clients should use <code>0x78</code>-<code>0x7F</code> (or send the
equivalent text through <code>0x42</code>) because future upstream commands may reuse the
remaining legacy IDs.</p>
<p>Both gain-command pairs can be used over the normal binary Companion
connection; USB does not need to enter terminal mode. Inside the transport's
normal Companion frame, send a GET command as its single command byte. Send a
@@ -2908,7 +2929,9 @@ SET command followed by one byte (<code>0</code> for off, <code>1</code> for on)
busy radio returns <code>ERR_CODE_BAD_STATE</code>; unsupported boosted gain returns
<code>ERR_CODE_UNSUPPORTED_CMD</code>. The FEM pair also returns
<code>ERR_CODE_UNSUPPORTED_CMD</code> when the board cannot control its external LNA. Raw
text such as <code>set radio.rxgain off</code> still requires the USB terminal start token.</p>
unframed text such as <code>set radio.rxgain off</code> still requires the USB terminal
start token; the same text may instead be carried as a framed <code>0x42</code> command
over USB, BLE, or TCP.</p>
<p>The WiFi power-save pair is available on ESP32 WiFi Companion builds over the
normal binary USB, BLE, or TCP port 5000 transport. <code>CMD_GET_WIFI_POWER_SAVE</code>
has no body and replies with <code>RESP_CODE_OK</code> followed by the effective mode byte.
@@ -3589,6 +3612,11 @@ Bytes 11+: Message Text (UTF-8)
<td><code>RESP_CODE_DEFAULT_FLOOD_SCOPE</code></td>
<td>Default flood-scope data.</td>
</tr>
<tr>
<td><code>0x1D</code></td>
<td><code>RESP_CODE_CLI_REPLY</code></td>
<td>Text returned by <code>CMD_RUN_CLI_COMMAND</code>.</td>
</tr>
</tbody>
</table>
<h3 id="asynchronous-push-types">Asynchronous push types</h3>
payloads/index.html
+7 -2
View File
@@ -2352,14 +2352,19 @@ silent.</p>
</tr>
<tr>
<td><code>0x01</code></td>
<td>CLI command</td>
<td>the command text of the message</td>
<td>CLI data</td>
<td>CLI command OR reply text</td>
</tr>
<tr>
<td><code>0x02</code></td>
<td>signed plain text message</td>
<td>first four bytes is sender pubkey prefix, followed by plain text message</td>
</tr>
<tr>
<td><code>0x03</code></td>
<td>CLI command</td>
<td>(since v1.18+) CLI command text (explicit)</td>
</tr>
</tbody>
</table>
<p>For a room post, companion firmware uses its own monotonic clock for the
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+35 -35
View File
@@ -2,142 +2,142 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://mikecarper.github.io/MeshCore/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/WiFi/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/cli_build_matrix/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/cli_command_availability/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/cli_commands/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/companion_offline_queue/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/companion_protocol/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/companion_radio_full/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/docs/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/faq/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/filter_tool/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/firmware_picker/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/flood_filtering/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/full_companion_usb_switcher/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/gps_tracking/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/halo_keymind_settings/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/host_cli_service/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/kiss_modem_protocol/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/lora_ota_automation/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/mbedtls-tls-footprint/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/nrf52_power_management/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/number_allocations/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/ota_easy/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/ota_meshtower_v2_sdcard/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/ota_nrf52_bootloader_update/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/ota_nrf52_qspi/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/ota_protocol/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/ota_user_guide/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/packet_format/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/payloads/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/qr_codes/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/rak3401_mota_chain/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/stats_binary_frames/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/telemetry_decoder/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
<url>
<loc>https://mikecarper.github.io/MeshCore/terminal_chat_cli/</loc>
<lastmod>2026-08-28</lastmod>
<lastmod>2026-08-29</lastmod>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.