docs: Add serial transport message framing documentation#544
docs: Add serial transport message framing documentation#544SiddhantOfficial wants to merge 1 commit intoZeroCM:masterfrom
Conversation
jbendes
left a comment
There was a problem hiding this comment.
Hey is there a reason you're deep in the inner workings of the generic serial transport? We actually made a decision to not document these details originally because we were hoping people wouldn't have to go that deep. Can you give us just a few sentences on how you found yourself here? I'm hoping you're not finding yourself coding a receiver for this (as generic serial transport is intended to be used on both ends)
|
Thanks for the context, that makes sense. |
|
Ahh understood. Yeah can you just clarify the use case? Essentially, "I'm a user who just showed up to this new 'doc' page. Why is this here and why do i care?" |
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.