COBS, SLIP, CmdResponse protocol docs #1206
Merged
Conversation
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
ryanmelt
requested changes
Apr 28, 2024
| @@ -21,10 +21,39 @@ UDP is an inherently packet based connection. If you read from a UDP socket, you | |||
|
|
|||
| ## Packet Delineation Protocols | |||
|
|
|||
| COSMOS provides the following packet delineation protocols: Burst, Fixed, Length, Template, Terminated and Preidentified. Each of these protocols has the primary purpose of separating out packets from a byte stream. | |||
| COSMOS provides the following packet delineation protocols: COBS, SLIP, CmdResponse, Burst, Fixed, Length, Template (deprecated), Terminated and Preidentified. Each of these protocols has the primary purpose of separating out packets from a byte stream. | |||
There was a problem hiding this comment.
CmdResponse isn't a packet delineation protocol.
|
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.
The CmdResponse protocol needs a lot more documentation but it probably involves more Accessor documentation. We can wait on that if you want as we already have #1162.