docs: Add serial transport message framing documentation #544
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.
Fixes #502
Summary
This PR adds documentation for the serial transport's message framing protocol to help users understand how ZCM handles message identification and parsing when transmitting multiple message types over a serial link.
Changes
Added a new section 'Serial Transport Message Framing' to
docs/transports.mdthat documents:0xCC 0x00)This documentation was based on the existing implementation in
generic_serial_transport.{h,c}as referenced in issue #502.Why
Users needed clarity on how to identify which bytes correlate with which message types in a serial stream. This information was already implemented in the codebase but not documented, making it difficult for users to parse ZCM messages independently.