docs: clarify Cyton marker AUX1 wire format - #337
Open
KrisITB wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation now accurately aligns AUX1 storage with the existing packet format.
Pull request overview
Clarifies Cyton marker-mode AUX serialization without changing firmware behavior.
Changes:
- Identifies markers as
auxData[0]. - Documents MSB-first packet bytes 27–28 with an example.
File summaries
| File | Description |
|---|---|
website/docs/Cyton/04-OpenBCI_Cyton_SDK.md |
Clarifies marker-mode wire representation. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
The Cyton SDK currently describes marker mode as adding the marker character to the "first AUX byte." In the Cyton library, however, the marker is stored in
auxData[0], which is a signed 16-bitshort, and raw-AUX serialization writes each AUX value MSB first.For a positive marker value such as
0x28, AUX1 is0x0028, so packet bytes 27–28 are serialized as00 28.This PR updates only the marker-mode description to distinguish AUX1 (
auxData[0]) from the first physical AUX wire byte and to state the packet positions and byte order explicitly. No firmware behavior is changed.This is intentionally separate from #334, which addresses board-mode response examples rather than AUX1 wire representation.