Repository navigation
docs: bring README, changelog and CAD docs in line with the new boards - #19
Merged
Merged
Conversation
disable_debug_flags() passed -UCFG_DEBUG. The Adafruit nRF52 core reads CFG_DEBUG unconditionally (cores/nRF5/rtos.cpp), and the platform builder only adds its CFG_DEBUG=0 default when the flags don't mention the macro, so every nRF52 build with DISABLE_DEBUG=1 failed with "'CFG_DEBUG' was not declared". Pass -DCFG_DEBUG=0 instead, which is the quiet setting the builder would have used. Built with DISABLE_DEBUG=1: LilyGo_T-Echo_companion_radio_ble, WioTrackerL1_companion_radio_usb (both failed before) and heltec_v4_companion_radio_usb_tcp (same size as before).
The C6 envs use pioarduino (Arduino core 3.x) through esp32c6_base but
inherited h2zero/NimBLE-Arduino 1.4.3 from esp32_base, which only builds
against core 2.x ("syscfg/syscfg.h: No such file"). Every C6 companion
failed to compile.
esp32c6_base now pulls NimBLE-Arduino 2.3.9. SerialBLEInterface keeps
its behaviour but implements both callback APIs: the bodies move into
shared helpers and thin overrides match each version's signatures
(NimBLEConnInfo, onPassKeyDisplay, onConfirmPassKey with
injectConfirmPasskey, enableScanResponse). The version is picked with
__has_include(<NimBLEAdvertisementData.h>), which only 2.x ships. Core
3.x moved esp_efuse_mac_get_default to esp_mac.h, so include it when
present.
Built: Xiao_C6, Meshimi, WHY2025_badge and LilyGo_Tlora_C6 BLE
companions, M5Stack_Unit_C6L BLE and USB, Xiao_C6_repeater_ (all failed
or untested before). The S3 boards stay on 1.4.3:
heltec_v4_companion_radio_ble and _usb_tcp build, the latter +136 B
from the helper indirection. Not tested on hardware.
After #16, #17 and #18: - README: the multi-transport claim only holds for the Wi-Fi boards; add how to flash the nRF52 boards (.uf2, DFU .zip); describe nRF52 build outputs and warn that DISABLE_DEBUG=1 breaks nRF52 builds. - CAD toggle doc: the per-UI board examples now name the released boards (ui-new on the display usb_tcp boards, Wio Tracker L1 and T-Echo; ui-tiny on the T-Echo Card; ui-orig on the ThinkNode M7). - Changelog: tag the Unreleased entries with the PR that landed them.
Elektr0Vodka
force-pushed
the
Docs/sync-after-board-prs
branch
from
October 18, 2026 17:49
1fb28b1 to
56de25f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Docs follow-up to #16, #17 and #18. No firmware changes.
_usb_tcp) boards. The nRF52 boards are single-transport..uf2onto the bootloader drive, or use the DFU.zipover BLE. The web flasher's merged-bin path does not apply to them..uf2+.zip).docs/companion_cad_toggle.md: the per-UI board examples now name the released boards: ui-new on the displayusb_tcpboards plus Wio Tracker L1 and T-Echo, ui-tiny on the T-Echo Card, ui-orig on the ThinkNode M7.changelog_ev.md: the Unreleased entries are tagged with the PR that landed them (fix(docs): deploy the docs site for this fork, not upstream's domain #12, feat(build): release Wio Tracker L1 BLE and USB companions #14, feat(companion): add experimental usb_tcp envs for six more boards #15, feat(companion): add experimental usb_tcp envs for eight 16 MB S3 boards #18), as the file's own rules ask.Why
These went stale when the T-Echo family and the new S3 boards were added.
Testing
Docs only. Checked the rendered tables and that every board named matches
MESHCOMOD_COMPANION_ENVSand the env's UI invariants/*/platformio.ini.Firmware or build impact
None.