docs: correct Cyton board-mode response examples - #334
Open
KrisITB wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Corrects Cyton SDK board-mode response examples to match firmware behavior and clarifies applicable versions.
Changes:
- Updates query and mode-change response examples.
- Adds firmware-version scope and library compatibility context.
💡 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 documentation currently shows // returning Board mode is default$$$ and /2 returning Board mode set to analog$$$.
In the tagged Cyton firmware v3.0.0 and v3.1.2 sources, processIncomingBoardMode() handles both successful queries and mode changes by calling printSuccess(), getBoardMode(), and sendEOT(). This produces responses such as Success: default$$$ and Success: analog$$$. The current Cyton library implementation uses the same response format.
This PR updates only those response examples and adds a version-scoped clarification. No firmware behavior is changed.