Skip to content

docs: correct Cyton board-mode response examples #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KrisITB wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: correct Cyton board-mode response examples #334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions website/docs/Cyton/04-OpenBCI_Cyton_SDK.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,12 +500,16 @@ This works similarly to the sample rate. Power cycling the OpenBCI board will ca

First, the user sends **//**

**returns** `Board mode is default$$$`
**returns** `Success: default$$$`


Then, the user sends **/2**

**returns** `Board mode set to analog$$$`
**returns** `Success: analog$$$`

:::note
For tagged Cyton firmware `v3.0.0` and `v3.1.2`, successful board-mode queries and changes return `Success: <mode>$$$`. The current Cyton library implementation uses the same response format.
:::

NOTE: if not all commands are not received within 1 second, `Timeout processing multi byte message - please send all commands at once as of v2$$$`

Expand Down