docs: document role feature switches and audit 1.17.1.5 guidance

This commit is contained in:
mikecarper committed 2026-09-05 23:01:58 -07:00
1 parent d6e61e0f33
commit e4b4eed066
31 files changed
+2037 -99

No files matched your search

+122
View File
@@ -0,0 +1,122 @@
# Markdown audit — 1.17.1.5 USA Cascade
Audited on 2026-09-05 against firmware source `26303793`, the resolved build
configuration, and the qualified 1.17.1.5 staging manifests. The scope was all
**71 tracked Markdown files** present at the start, including root documents,
docs, examples, tools, tests, variants, and vendored library documentation.
Generated/ignored build directories and external repositories were outside that scope.
## Corrections
- Added [role-specific feature switches](../role_feature_switches.md), exact
Companion/infrastructure MQTT and logging controls, board exceptions, SNMP,
and the [USB web console](https://flasher.meshcore.io/console).
- Added an [exact-name variant map](1.17.1.5-variant-map.tsv); every one of its
1,325 covered entries resolves to a staged firmware file. The 36 excluded
entries are identified rather than linked to substitute hardware.
- Corrected universal 254-neighbor claims, Full Companion MQTT filename/CLI
assumptions, TLora Full WebConfig availability, and partition/NVS guidance.
- Distinguished infrastructure bare `powersaving on` guards from the separate
`set powersaving on` form; corrected the RS232 baud range and SNMP environment list.
- Linked OTAFIX 2.4.6 and its board/storage requirements from operator guides;
aligned the two manual USA OTA quickstarts with 910.525 MHz.
- Marked old provider catalogs and dated hardware results as historical;
documented the legacy tag workflow that also matches `repeater-room-*`.
- Fixed the vendored MQTT documentation link and documentation-site links
that incorrectly treated repository source files as generated site pages.
## Verification and limits
All original Markdown files were scanned for relative links, section anchors,
source-path references, version/default claims, and role/OTA terminology.
Flagged operator instructions were checked against CommonCLI, its observer
extension, Companion command handlers, board configuration, and release manifests.
Brace-expanded source references and SDK-relative paths were retained as such.
Historical measurements, changelogs, upstream findings, contribution/security
policies, and licenses were not rewritten as new validation results.
The documentation site passed a strict MkDocs Material build. Relative repository
links and section anchors were checked separately, including documents outside
the MkDocs source directory. Console and current bootloader links were checked
on their primary sites. This was not a crawl of every third-party URL or a
new hardware/firmware qualification; no claim is made that every board was
physically tested or every protocol statement independently re-proved.
## Original file coverage
“Retained” means no correction was identified by this documentation audit;
it does not certify all historical statements as current hardware behavior.
| File | Disposition |
| --- | --- |
| [AGENTS.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/AGENTS.md) | Scanned; retained |
| [ALERTS.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/ALERTS.md) | Scanned; retained |
| [CHANGELOG.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/CHANGELOG.md) | Historical record retained |
| [CONTRIBUTING.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/CONTRIBUTING.md) | Scanned; retained |
| [MEMORY_MONITORING.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MEMORY_MONITORING.md) | Scanned; retained |
| [MQTT_IMPLEMENTATION.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_IMPLEMENTATION.md) | Corrected or clarified |
| [MQTT_INTERNALS.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_INTERNALS.md) | Corrected or clarified |
| [MQTT_OWNERSHIP.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_OWNERSHIP.md) | Historical record retained |
| [MQTT_SNMP.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/MQTT_SNMP.md) | Corrected or clarified |
| [README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/README.md) | Corrected or clarified |
| [RELEASE.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/RELEASE.md) | Corrected or clarified |
| [RESTORE_UPSTREAM_NOTES.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/RESTORE_UPSTREAM_NOTES.md) | Historical record retained |
| [SECURITY.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/SECURITY.md) | Scanned; retained |
| [STABILITY_TESTABILITY_HANDOFF.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/STABILITY_TESTABILITY_HANDOFF.md) | Historical record retained |
| [UPSTREAM_BUGS.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/UPSTREAM_BUGS.md) | Scanned; retained |
| [WEB_CONFIG_REVIEW.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/WEB_CONFIG_REVIEW.md) | Corrected or clarified |
| [arch/stm32/Adafruit_LittleFS_stm32/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/arch/stm32/Adafruit_LittleFS_stm32/README.md) | Vendored documentation/license retained |
| [arch/stm32/Adafruit_LittleFS_stm32/src/littlefs/LICENSE.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/arch/stm32/Adafruit_LittleFS_stm32/src/littlefs/LICENSE.md) | Vendored documentation/license retained |
| [arch/stm32/Adafruit_LittleFS_stm32/src/littlefs/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/arch/stm32/Adafruit_LittleFS_stm32/src/littlefs/README.md) | Vendored documentation/license retained |
| [docs/WiFi.md](../WiFi.md) | Corrected or clarified |
| [docs/cli_build_matrix.md](../cli_build_matrix.md) | Corrected or clarified |
| [docs/cli_command_availability.md](../cli_command_availability.md) | Corrected or clarified |
| [docs/cli_commands.md](../cli_commands.md) | Corrected or clarified |
| [docs/companion_offline_queue.md](../companion_offline_queue.md) | Scanned; retained |
| [docs/companion_protocol.md](../companion_protocol.md) | Scanned; retained |
| [docs/companion_radio_full.md](../companion_radio_full.md) | Corrected or clarified |
| [docs/docs.md](../docs.md) | Scanned; retained |
| [docs/esp32_memory_budget.md](../esp32_memory_budget.md) | Scanned; retained |
| [docs/faq.md](../faq.md) | Corrected or clarified |
| [docs/filter_tool.md](../filter_tool.md) | Scanned; retained |
| [docs/firmware_picker.md](../firmware_picker.md) | Corrected or clarified |
| [docs/flood_filtering.md](../flood_filtering.md) | Scanned; retained |
| [docs/full_companion_features.md](../full_companion_features.md) | Corrected or clarified |
| [docs/full_companion_usb_switcher.md](../full_companion_usb_switcher.md) | Corrected or clarified |
| [docs/gps_tracking.md](../gps_tracking.md) | Scanned; retained |
| [docs/halo_keymind_settings.md](../halo_keymind_settings.md) | Corrected or clarified |
| [docs/hardware_validation_checklist.md](../hardware_validation_checklist.md) | Corrected or clarified |
| [docs/host_cli_service.md](../host_cli_service.md) | Scanned; retained |
| [docs/index.md](../index.md) | Corrected or clarified |
| [docs/kiss_modem_protocol.md](../kiss_modem_protocol.md) | Scanned; retained |
| [docs/lora_ota_automation.md](../lora_ota_automation.md) | Corrected or clarified |
| [docs/mbedtls-tls-footprint.md](../mbedtls-tls-footprint.md) | Scanned; retained |
| [docs/nrf52_companion_storage_recovery.md](../nrf52_companion_storage_recovery.md) | Scanned; retained |
| [docs/nrf52_power_management.md](../nrf52_power_management.md) | Scanned; retained |
| [docs/number_allocations.md](../number_allocations.md) | Scanned; retained |
| [docs/ota_easy.md](../ota_easy.md) | Corrected or clarified |
| [docs/ota_meshtower_v2_sdcard.md](../ota_meshtower_v2_sdcard.md) | Corrected or clarified |
| [docs/ota_nrf52_bootloader_update.md](../ota_nrf52_bootloader_update.md) | Corrected or clarified |
| [docs/ota_nrf52_qspi.md](../ota_nrf52_qspi.md) | Corrected or clarified |
| [docs/ota_protocol.md](../ota_protocol.md) | Corrected or clarified |
| [docs/ota_user_guide.md](../ota_user_guide.md) | Corrected or clarified |
| [docs/packet_format.md](../packet_format.md) | Scanned; retained |
| [docs/payloads.md](../payloads.md) | Scanned; retained |
| [docs/qr_codes.md](../qr_codes.md) | Scanned; retained |
| [docs/rak3401_mota_chain.md](../rak3401_mota_chain.md) | Historical record retained |
| [docs/releases/1.17.1.5.md](../releases/1.17.1.5.md) | Corrected or clarified |
| [docs/spiffs_regular_file_reads.md](../spiffs_regular_file_reads.md) | Scanned; retained |
| [docs/stats_binary_frames.md](../stats_binary_frames.md) | Scanned; retained |
| [docs/telemetry_decoder.md](../telemetry_decoder.md) | Scanned; retained |
| [docs/terminal_chat_cli.md](../terminal_chat_cli.md) | Scanned; retained |
| [docs/usb_serial_backpressure.md](../usb_serial_backpressure.md) | Scanned; retained |
| [examples/host_cli_service/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/examples/host_cli_service/README.md) | Scanned; retained |
| [lib/PsychicMqttClient/CHANGELOG.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/lib/PsychicMqttClient/CHANGELOG.md) | Vendored documentation/license retained |
| [lib/PsychicMqttClient/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/lib/PsychicMqttClient/README.md) | Corrected or clarified |
| [mesh-america/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/mesh-america/README.md) | Corrected or clarified |
| [test/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/test/README.md) | Scanned; retained |
| [test/test_mqtt_prefs_codec/FIXTURES.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/test/test_mqtt_prefs_codec/FIXTURES.md) | Historical record retained |
| [tools/mota/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/tools/mota/README.md) | Scanned; retained |
| [tools/sensecap_indicator_font/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/tools/sensecap_indicator_font/README.md) | Scanned; retained |
| [tools/sensecap_indicator_rp2040/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/tools/sensecap_indicator_rp2040/README.md) | Scanned; retained |
| [variants/sensecap_indicator-espnow/README.md](https://github.com/mikecarper/MeshCore/blob/keymindCascade/variants/sensecap_indicator-espnow/README.md) | Scanned; retained |
File diff suppressed because it is too large. Load diff
+30
View File
@@ -1,5 +1,11 @@
# MeshCore 1.17.1.5 Dev — USA Cascade
Use [feature switches by role](../role_feature_switches.md) for exact on/off
commands for Companion, Repeater, Room Server, and Sensor, including MQTT,
logging, power saving, GPS, and board exceptions. Open the
[USB web console](https://flasher.meshcore.io/console) for the default ASCII
terminal on Full Companion and infrastructure images.
The firmware identifier and main release tag follow
`v1.17.1.5-halo-keymind-cascade-dev-<commit>`, matching the 1.17.1.4 naming
convention. Supplemental pages retain the `repeater-room-`, `utility-`,
@@ -94,3 +100,27 @@ checksums, build notes, and Full Companion directions. The staging directory's
root `FIRMWARE-PICKER-1.17.1.5.html` opens the local downloads; the copies inside
each release group use the planned GitHub download URLs. Staging does not
push commits, create remote tags, or publish a GitHub release.
## Published release set and small-slot Heltec V4 updates
Published firmware tags remain at source commit `26303793`. Documentation can
advance independently. The original matrix qualified 540 profiles (1,080
firmware files) from 551 attempts; 11 oversized portable attempts have expanded
Full replacements. The [variant map](1.17.1.5-variant-map.tsv) maps all 1,361
previous-release choices to 1,325 covered choices and 36 excluded entries.
Multiple old choices map to the same current artifact.
For Heltec V4 with an existing compatible **1.25 MiB OTA application slot**, the
standard `heltec_v4_repeater` application is **1,179,200 bytes** and the lean
`heltec_v4_repeater_lora_ota_no_external_sensors` application is **1,232,024 bytes**.
Both fit that slot. Start the WiFi uploader with `start ota ap`, join
`MeshCore-OTA`, and open `http://192.168.4.1/update`. Upload the application
`.bin`; use `stop ota` to close an unused uploader. Their merged USB installers
write two 6.25 MiB application slots. Expanded Full V4 applications require
the larger layout and do not fit a 1.25 MiB slot.
- [Companion firmware](https://github.com/mikecarper/MeshCore/releases/tag/v1.17.1.5-halo-keymind-cascade-dev-26303793)
- [Repeater and Room Server firmware](https://github.com/mikecarper/MeshCore/releases/tag/repeater-room-v1.17.1.5-halo-keymind-cascade-dev-26303793)
- [Sensor firmware](https://github.com/mikecarper/MeshCore/releases/tag/utility-v1.17.1.5-halo-keymind-cascade-dev-26303793)
- [LoRa OTA repeater firmware](https://github.com/mikecarper/MeshCore/releases/tag/lora-ota-v1.17.1.5-halo-keymind-cascade-dev-26303793)
- [Expanded Full infrastructure](https://github.com/mikecarper/MeshCore/releases/tag/full-profiles-v1.17.1.5-halo-keymind-cascade-dev-26303793)