docs: fix companion protocol guide mismatches with current firmware#1813
Closed
robekl wants to merge 1 commit intomeshcore-dev:devfrom
Closed
docs: fix companion protocol guide mismatches with current firmware#1813robekl wants to merge 1 commit intomeshcore-dev:devfrom
robekl wants to merge 1 commit intomeshcore-dev:devfrom
Conversation
Member
|
A bunch of these changes will probably have merge conflicts when going into main branch, since some of these docs are already adjusted on main branch. Generally, docs changes are opened against main, and code changes opened against dev. Also, as far as I know, the original protocol guide doc was generated by AI and sent as a PR. So the majority of it was wrong. |
Author
|
@liamcottle Thanks for the info. I opened a PR against main branch for doc updates: #1823 When one of these is merged, I can close the other |
Member
|
Superseded by #1823 |
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.
Summary
Targeted accuracy fixes in
docs/protocol_guide.mdto match current companion firmware behavior and BLE transport.Changes
APP_STARTresponse expectation fromPACKET_OKtoPACKET_SELF_INFO.SET_CHANNELwire format to 16-byte secret payload (50-byte frame) and documented 66-byte/32-byte secret variant as unsupported.SET_CHANNEL.PACKET_OKsize assumption).Implementation References
examples/companion_radio/MyMesh.cppCMD_APP_START,RESP_CODE_SELF_INFO,CMD_SET_CHANNEL,CMD_GET_BATT_AND_STORAGEMyMesh::handleCmdFrameMyMesh::writeOKFrameMyMesh::writeErrFramesrc/helpers/esp32/SerialBLEInterface.cppSERVICE_UUID,CHARACTERISTIC_UUID_RX,CHARACTERISTIC_UUID_TXsrc/helpers/nrf52/SerialBLEInterface.cppBLEUarttransport usage