Repository navigation
feat(companion): add experimental usb_tcp envs for six more boards - #15
Merged
Merged
Conversation
Add the meshcomod multi-transport companion (USB + TCP + WebSocket + BLE, SNMP agent, manifest OTA) for the Heltec Wireless Tracker V2, Heltec Vision Master E213, Seeed Xiao S3, RAK3112, LilyGo T-ETH Elite and LilyGo T-Beam S3 Supreme, and add them to MESHCOMOD_COMPANION_ENVS so the matrix workflow builds and releases them. These were picked because nothing is lost by moving them onto the meshcomod stack: each is an ESP32-S3 (the internal RAM HTTPS OTA needs with BLE and Wi-Fi up), has at least 8 MB flash on its existing partition table (two app slots for the ~1.6 MB image), and reuses the display driver of the board's stock companion builds. RAK3112 and T-ETH Elite are headless, like the WSL3. The T-ETH Elite build runs over Wi-Fi; upstream has no Ethernet companion for it either. BLE_DEBUG_LOGGING is left out because Serial carries the companion protocol in these builds. Nobody working on the fork owns these boards, so the README marks them experimental and lists what has not been checked. README, changelog, CI releases and SNMP docs updated. All six build with pio run (flash 1.52 to 1.68 MB, static RAM 150 to 165 KB, sizes in docs/companion_snmp.md); not tested on hardware.
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
Adds the meshcomod multi-transport companion (
*_companion_radio_usb_tcp: USB + TCP + WebSocket + BLE, SNMP agent, manifest OTA) for six more boards and puts them inMESHCOMOD_COMPANION_ENVS, so the companion workflow builds and releases them:heltec_tracker_v2_companion_radio_usb_tcpHeltec_E213_companion_radio_usb_tcpXiao_S3_companion_radio_usb_tcpRAK_3112_companion_radio_usb_tcpLilyGo_TETH_Elite_sx1262_companion_radio_usb_tcpT_Beam_S3_Supreme_SX1262_companion_radio_usb_tcpAll six are marked experimental in the README, which explains what has not been checked on them.
Why
These are the boards that can take the meshcomod stack without losing anything:
docs/COMPANION_OTA_MEMORY_ROOT_CAUSE.md). Classic ESP32 and C3 have less; C6 needs Arduino core 3.x, which the pinned NimBLE 1.4.3 does not support.Each env is the board's stock BLE companion env plus the same meshcomod block as the V3 and Wireless Tracker
usb_tcpenvs.BLE_DEBUG_LOGGINGis left out because Serial carries the companion protocol in these builds. The T-ETH Elite build runs over Wi-Fi; upstream has no Ethernet companion for it either, so nothing is lost there.Not included, with reasons: the Station G2/G3 and T-Beam 1W need a
default_16MB.csvpartition change, the E290, W12 and RC32 use display drivers not yet used in ausb_tcpbuild, and the 4 MB boards (T3S3, EoRa-S3, ThinkNode M2/M5) would only fit withmin_spiffs.csvand a 128 KB filesystem.How it was tested
pio runfor all six envs: 6 succeeded, no warnings. Flash 1.52 to 1.68 MB, static RAM 150 to 165 KB; per-env sizes indocs/companion_snmp.md.bash build.sh get-meshcomod-companion-firmwares-to-buildlists all six, so the release matrix picks them up.Firmware and build impact
Docs: README device table and fork features row,
changelog_ev.md,docs/CI_RELEASES.md,docs/companion_snmp.md.