Skip to content

Conversation

tharun-OpenBCI
Copy link
Member

No description provided.

@tharun-OpenBCI tharun-OpenBCI requested a review from retiutut July 31, 2025 21:10
@tharun-OpenBCI tharun-OpenBCI linked an issue Jul 31, 2025 that may be closed by this pull request
3 tasks
@retiutut retiutut requested a review from Copilot October 17, 2025 21:24
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

The PR updates the Cyton Board Programming Tutorial to standardize on Arduino IDE v1.8.19, refine setup and upload instructions, and add clearer imagery for key steps.

  • Consolidates and clarifies required tool versions (replaces prior mixed 1.6.x / 1.8.x references with 1.8.19).
  • Reorganizes pre-upload and upload sections (switch heading changes, added verification and success steps, updated troubleshooting).
  • Adds or replaces images (bootloader LED animation and success confirmation screenshot).

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

**You will need:**

- Computer running [Arduino v1.8.0](https://www.arduino.cc/en/Main/Software) or later
- Arduino IDE v1.8.19. You can find this in the legacy page of the [Arduino Downloads section](https://www.arduino.cc/en/software/). Do not use Arduino v2 or later. Only v1.8.19 works with this tutorial
Copy link

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The hard requirement 'Only v1.8.19 works with this tutorial' is very restrictive without explaining why (e.g., driver, board package, or plugin incompatibility). Consider clarifying the constraint (reason + whether other 1.8.x builds are acceptable) or rephrasing to 'Use Arduino IDE 1.8.x (1.8.19 recommended); Arduino IDE 2.x is not supported for this tutorial.'

Suggested change
- Arduino IDE v1.8.19. You can find this in the legacy page of the [Arduino Downloads section](https://www.arduino.cc/en/software/). Do not use Arduino v2 or later. Only v1.8.19 works with this tutorial
- Arduino IDE 1.8.x (1.8.19 recommended). You can find this in the legacy page of the [Arduino Downloads section](https://www.arduino.cc/en/software/). Arduino IDE 2.x is not supported for this tutorial.

Copilot uses AI. Check for mistakes.

- Arduino IDE v1.8.19. You can find this in the legacy page of the [Arduino Downloads section](https://www.arduino.cc/en/software/)

**Note for Windows users:** While installing Arduino 1.8, if the installer instructs you to uninstall 1.5.8, move the Arduino folder containing 1.5.8 from `Program Files` to your desktop or another folder. Rename this folder to `Arduino_1.5.8`. Open the `Change or remove program` app in Control Panel and uninstall the Arduino application. There will be a popup indicating that the files do not exist and asking if you want to remove the program from the files list; select yes. Then install 1.8.0 as normal. Navigate back to your `Program Files` folder and locate the Arduino folder. Rename this folder to `Arduino_1.8.0`. Now drag and drop the `Arduino_1.5.8` folder back into the `Program Files` folder.
**Note for Windows users:** While installing Arduino 1.8, if the installer instructs you to uninstall 1.5.8, move the Arduino folder containing 1.5.8 from `Program Files` to your desktop or another folder. Rename this folder to `Arduino_1.5.8`. Open the `Change or remove program` app in Control Panel and uninstall the Arduino application. There will be a popup indicating that the files do not exist and asking if you want to remove the program from the files list; select yes. Then install `1.8.19` as normal. Navigate back to your `Program Files` folder and locate the Arduino folder. Rename this folder to `Arduino_1.8.19`. Now drag and drop the `Arduino_1.5.8` folder back into the `Program Files` folder.
Copy link

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The phrase 'While installing Arduino 1.8' plus later 'install 1.8.19' and mixed backtick usage introduces inconsistency. Suggest: 'While installing Arduino IDE 1.8.19...' and remove backticks around plain version numbers for consistency, or apply them uniformly.

Suggested change
**Note for Windows users:** While installing Arduino 1.8, if the installer instructs you to uninstall 1.5.8, move the Arduino folder containing 1.5.8 from `Program Files` to your desktop or another folder. Rename this folder to `Arduino_1.5.8`. Open the `Change or remove program` app in Control Panel and uninstall the Arduino application. There will be a popup indicating that the files do not exist and asking if you want to remove the program from the files list; select yes. Then install `1.8.19` as normal. Navigate back to your `Program Files` folder and locate the Arduino folder. Rename this folder to `Arduino_1.8.19`. Now drag and drop the `Arduino_1.5.8` folder back into the `Program Files` folder.
**Note for Windows users:** While installing Arduino IDE 1.8.19, if the installer instructs you to uninstall 1.5.8, move the Arduino folder containing 1.5.8 from `Program Files` to your desktop or another folder. Rename this folder to `Arduino_1.5.8`. Open the `Change or remove program` app in Control Panel and uninstall the Arduino application. There will be a popup indicating that the files do not exist and asking if you want to remove the program from the files list; select yes. Then install Arduino IDE 1.8.19 as normal. Navigate back to your `Program Files` folder and locate the Arduino folder. Rename this folder to `Arduino_1.8.19`. Now drag and drop the `Arduino_1.5.8` folder back into the `Program Files` folder.

Copilot uses AI. Check for mistakes.

- The Arduino IDE will first compile your code and then upload the compiled hex file.

- Once the upload is done and if successful, the Arduino IDE will display a success message as shown below,
![Cyton Programming Success](../assets/CytonImages/CytonProgrammingSuccess.png)
Copy link

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Alt text 'Cyton Programming Success' is vague; consider a more descriptive alt text like 'Screenshot of Arduino IDE showing successful upload message for Cyton board' to improve screen reader usefulness.

Suggested change
![Cyton Programming Success](../assets/CytonImages/CytonProgrammingSuccess.png)
![Screenshot of Arduino IDE showing successful upload message for Cyton board](../assets/CytonImages/CytonProgrammingSuccess.png)

Copilot uses AI. Check for mistakes.

- If all else fails, find a friend with a more powerful computer and do the uploading from their computer.

In extreme conditions, if you have tried all five of the above methods and still can't upload, then you can try to change the Device's polling time. The Poll Time can be adjusted using the OpenBCI Radio Config Utility software.
- If all else fails, try a different computer or Operating System.
Copy link

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Previous specific troubleshooting guidance about adjusting Radio Poll Time (using the Radio Config Utility) has been removed; if that remains a valid advanced remedy for persistent 'Program Flash Failed' errors, consider retaining it to preserve actionable recovery steps.

Suggested change
- If all else fails, try a different computer or Operating System.
- If all else fails, try a different computer or Operating System.
- **Advanced:** If you continue to experience persistent `Program Flash Failed` errors, you may try adjusting the Radio Poll Time using the Radio Config Utility. Increasing the poll time can sometimes help the Arduino IDE communicate more reliably with the Cyton board during programming. Refer to the [Cyton Radios Programming Tutorial](Cyton/06-Cyton_Radios_Programming_Tutorial.md) for instructions on using the Radio Config Utility to adjust Radio Poll Time. Only attempt this if you are comfortable with advanced configuration steps.

Copilot uses AI. Check for mistakes.


- The Arduino IDE will first compile your code and then upload the compiled hex file.

- Once the upload is done and if successful, the Arduino IDE will display a success message as shown below,
Copy link

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace the preceding sentence's trailing comma with a period and tighten wording for clarity.

Suggested change
- Once the upload is done and if successful, the Arduino IDE will display a success message as shown below,
- Once the upload is complete and successful, the Arduino IDE will display a success message as shown below.

Copilot uses AI. Check for mistakes.

- On Macs, this will be named **/dev/tty.usbserial-DN00nnnn**, where the nnnn is a combination of numbers and letters specific to your OpenBCI Dongle.
Plug in the Dongle to your computer and select the Serial port as shown below.

- On MacOS, this will be named **/dev/tty.usbserial-DN00nnnn**, where the nnnn is a combination of numbers and letters specific to your OpenBCI Dongle.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We filter out tty ports in the GUI as of 5.2.0 for both the Cyton dongle and Networking serial output (sending data to an arduino from the GUI).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update "Cyton Board Programming Tutorial" Doc

2 participants