Cyton Board Programming Tutorial

caution

Note, you do not need to do any board programming if you want to use the Cyton out-of-the-box. All OpenBCI boards ship already programmed, i.e. with firmware uploaded. Email support@openbci.com before attempting to update or alter board firmware, or if you think there is an issue with your board. DO NOT attempt to upload firmware to your board unless specifically instructed to do so.

If you're curious about how we do it, keep reading! If you want to start streaming EEG/EMG/ECG data right away, head over to Getting Started. Happy bio-sensing!

Overview

The OpenBCI Cyton boards have powerful microcontrollers on them which ship with the latest OpenBCI firmware to interface with the on-board ADS1299, Accelerometer, and SD card. This tutorial explains how to program the firmware using the OpenBCI Dongle and you PC. If we come out with a firmware upgrade, or if your or someone comes up with a custom program that you want to implement, you should use the following method. We made major changes to the Cyton firmware in 2016 with v2.x and again in 2017 with v3.x. This tutorial covers the v2 and v3, as well as v1. If you have already mucked about in the code using the v1 firmware, and want to upgrade, check out the Notes at the end of this doc. Happy Hacking!

Firmware Versions 2.x.x & 3.x.x (Fall 2016 - present)

These instructions apply to programming the Cyton with firmware versions 2.x.x, 3.x.x, and onwards! The radio firmware (the firmware for the dongle and the radio module on your Cyton Board) has not been updated since prior to Fall 2016, so as long as you purchased your Cyton Board after that date, you do not need to worry about reprogramming your radios. For information about uploading the original OpenBCI Cyton firmware (1.x.x), see below.

You will need:

• Computer running Arduino v1.8.0 or later

• OpenBCI Dongle connected to USB port

• OpenBCI Cyton Board with battery power

• OpenBCI Cyton Firmware (follow guide below to download)

• OpenBCI Cyton SD Firmware (follow guide below to download)

• OpenBCI WiFi Master Firmware (follow guide below to download)

• If your computer does not have Arduino v1.8.0 (or later), install the latest Arduino IDE which can be found here: https:

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 to 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 back into Program Files folder.

Install Firmware From Arduino Library Manager (easiest!)

Don't know what the Library Manager is? Skim over the Official Arduino Guide.

Open the Library Manager and search for OpenBCI and install the latest version for OpenBCI_32bit_Library, OpenBCI_32bit_SD and OpenBCI_Wifi_Master.

Now jump down to the section install ChipKit Core

Manual Installation of Cyton Firmware

1. Download the latest OpenBCI_32bit_Library, it's the top most zip file.

2. Unzip the folder and change the name to OpenBCI_32bit_Library

3. Move OpenBCI_32bit_Library to:

   On Mac: /Documents/Arduino/libraries
   On Windows: C:\Users\username\Documents\Arduino\libraries

If you're have trouble or want to learn more checkout the Official Arduino Guide for manual installation.

Manual Installation of Cyton SD Library

1. Download the latest OpenBCI_32bit_SD, it's the top most zip file.

2. Unzip the folder and change the name to OpenBCI_32bit_SD

3. Move OpenBCI_32bit_SD to:

   On Mac: /Documents/Arduino/libraries
   On Windows: C:\Users\username\Documents\Arduino\libraries

If you're have trouble or want to learn more checkout the Official Arduino Guide for manual installation.

Manual Installation of WiFi Master Firmware

1. Download the latest WiFi Master Library, it's the top most zip file.

2. Unzip the folder and change the name to OpenBCI_Wifi_Master

3. Move OpenBCI_Wifi_Master to:

   On Mac: /Documents/Arduino/libraries
   On Windows: C:\Users\username\Documents\Arduino\libraries

If you're have trouble or want to learn more checkout the Official Arduino Guide for manual installation.

Clone The Repos From Github

Developers looking to contribute or write custom firmware can clone the firmware repositories directly to your libraries folder

On Mac: `/Documents/Arduino/libraries`  
On Windows: `C:\Users\username\Documents\Arduino\libraries`

• OpenBCI_32bit_Library
• OpenBCI_32bit_SD
• OpenBCI_Wifi_Master_Library

Install ChipKIT Core Firmware

• Before you can upload code correctly to the PIC32 with Arduino, you need to add the chipKIT-core board files to your Arduino IDE. The folks at chipKIT have put together instructions on how to Auto Install via URL from within Arduino.

NOTE Latest ChipKIT firmware may cause improper flashing of the device firmware. In such a case [No data stream from the board/No device ID and accelerometer ID after soft resetting the board] select the firmware version 1.3.1.

Select 'OpenBCI 32' as Board

If you followed the process in the previous link, and you will be able to select the OpenBCI 32 board from the Tools >> Board >> dropdown menu!

Select DefaultBoard.ino from Examples

• In the Arduino IDE go to File-->Examples-->OpenBCI_32bit_Library-->DefaultBoard which will launch the Cyton firmware. NOTE You must upload ONLY the DefaultBoard Sketch!

Pre-upload Hardware Setting

• Make sure that the slide switch on the OpenBCI Dongle is switched to the GPIO6 selection. If it's on the other side, it will try to program the Dongle-mounted RFduino!

Plug in Dongle and Select Serial Port

Now is a good time to plug your Dongle in and power down the Board.

• Select the correct serial port for your OpenBCI Dongle.

  • 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.

  • On Windows, the serial port will be listed as a numbered COM port.

  • On Linux, it will be different.

Put Cyton in Bootloaded Mode

• When you are happy with the code, you will have to put the 32bit board into bootloader mode. We don't have a way to remotely reset the chipKIT compatible IC, so you have to do it manually with the procedure that follows:

1. Power OFF the OpenBCI Board.
2. Press down both RST and PROG buttons at the same time.
3. Power ON the OpenBCI Board.
4. Release the RST button while still holding down the PROG button.
5. Release the PROG button.

• Verify that you see the blue LED on the 32bit board blinking pleasantly.

Upload the Firmware

• Press the upload button on the Arduino IDE.

That's it! You will see some blinky lights on the Dongle, and after a short while, the Arduino IDE will tell you that it's done. Happy Hacking!

Firmware Version 1.x.x (2014 - Fall 2016)

You will need:

• Computer running Arduino v1.8.0 or later
• OpenBCI Dongle connected to USB port
• OpenBCI Cyton Board with battery power

Note: Always plug the Dongle into the PC before powering the Board because the Host (RFduino on the Dongle) must be powered before the Device (RFduino on the Board).

First, install the Arduino IDE which can be found here:

https://www.arduino.cc/en/Main/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 (x86) to your downloads 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 to back to your Program Files (x86) folder and locate the Arduino folder. Rename this folder to Arduino_1.8.0. Now drag and drop the Arduino_1.5.8 back into Program Files folder.

You can find the previous OpenBCI firmware and libraries on our github repository.

https://github.com/OpenBCI/OpenBCI_32bit

https://github.com/OpenBCI/OpenBCI_32bit_Library/tree/maint/1.0.0

• OpenBCI_32bit
  • This is the firmware that runs on the OpenBCI 32bit Board
• OBCI_SD
  • Supports writing raw data to on-board SD card
• OpenBCI_32_Daisy
  • The OpenBCI 32bit Library

You will need to install the folders 'OpenBCI_32_Daisy' and 'OBCI_SD' from our Libraries repository into your Documents/Arduino/libraries folder. If there is no 'libraries' folder in the sketch folder, create one. Move the folder called 'OpenBCI_32bit' into your Documents/Arduino folder.

Before you can upload code correctly to the PIC32 with Arduino, you need to add the chipKIT-core board files to your Arduino IDE. The folks at chipKIT have put together instructions on how to Auto Install via URL from within Arduino. Follow the process in the previous link, and you will be able to select the OpenBCI board from the Tools >> Board >> dropdown menu!

Open the OpenBCI_32bit sketch from the File -> Sketchbook dropdown. Then select OpenBCI 32 from the Board drop-down menu.

Make sure that the slide switch on the OpenBCI Dongle is switched to the GPIO6 selection (towards your computer). If it's on the other side, it will try to program the Dongle-mounted RFduino! Now is a good time to plug your Dongle in and power down the Cyton Board.

Select the correct serial port for your OpenBCI Dongle.

• 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.

• On Windows, the serial port will be listed as a numbered COM port.

• On Linux, it will be different.

When you are happy with the code, you will have to put the 32bit board into bootloader mode. We don't have a way to remotely reset the chipKIT compatible IC, so you have to do it manually.

• If you're uploading firmware 3.x.x, you'll need to make sure you have the WiFi library installed before uploading the firmware. To do this, go to Sketch > Include Library > Manage Libraries.

• Then, in the search field in the upper right, type OpenBCI WiFi.

• Now, click OpenBCI_WiFi_Master and install v1.0.0 (or the latest version if there are newer versions).

Note: we suggest that for the five steps below you use one thumb to press down both the RST and PROG buttons, while using your other thumb to toggle the switch between OFF and PC.

• Power OFF the OpenBCI Board.
• Press down both RST and PROG buttons at the same time (with your left thumb).
• Power ON the OpenBCI Board (with your right thumb).
• Release the RST button while still holding down the PROG button.
• Release the PROG button.

Now you should see the blue LED on the Cyton Board blinking pleasantly. Your Cyton board is ready to be flashed!

• Press the upload button on the Arduino IDE (the circular button with the arrow pointing to the right). That's it! You will see some blinky lights on the Dongle, and after a short while, the Arduino IDE will tell you that it's done. Happy Hacking!

Note: occasionally, you may see the error message in the screenshot below. You can ignore this. As long as Program flash: ...................................#################################### done appears, 99 out of 100 times your firmware uploaded correctly. If your board doesn't appear to be working in the GUI (or other software), simply try re-uploading the firmware.

8bit Upload How-To

NOTE: The 8bit Hardware is no longer in production

You will need:

• Computer running Arduino IDE
• OpenBCI Dongle connected to USB port
• OpenBCI 8bit Board with battery power

Make sure that the slide switch on the OpenBCI Dongle is switched to the GPIO6 selection. That way the DTR reset signal will get passed over-air to the ATmega328. If it's on the other side, it will try to program the Dongle-mounted RFduino!
You can find the latest firmware and libraries on our github repository

• DEPRECATED

You will need to install these files from our repository into your Documents/arduino/libraries folder

• SdFat
  • Supports writing raw data to on-board SD card
• OpenBCI_8
  • The OpenBCI 8bit Library

Move the file OpenBCI_8bit_SD.ino into your Documents/arduino folder, and start up the Arduino IDE. you should then see the sketch in your Sketch folder.

Select Arduino UNO from the Board drop-down menu.

Select the correct serial port for your OpenBCI Dongle.

• 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.

• On Windows, the serial port will be listed as a COM port.

• On Linux, it will be different.

When you are happy with the code, simply press upload to program the OpenBCI 8bit target. That's it! You will see some blinky lights on the Dongle, and after a short while, the Arduino IDE will tell you that it's done.

Troubleshooting

If you're having an issue with Board_Defs.h and you're uploading using Linux, you must move ALL files located in: /Arduino/hardware/chipkit-core/pic32/variants/openbci/ to /Arduino/hardware/chipkit-core/pic32/cores/pic32/ This should fix any issues you're having compiling.

If the upload fails with No Target Found:

1. Unplug the Dongle and Device.
2. Plug the Dongle into your computer.
3. Plug the Device into your computer.
4. Put the device into bootloader mode.
5. Try upload again.

If the upload fails with Program Flash Failed it's due to the Arduino IDE not being able to read from the serial port fast enough possibly do to resource starvation or overall computer power. We recommend taking the following actions:

• Keep the Board and Dongle physically close to each other during the upload.
• Keep the Arduino IDE open, front and center and don't use any other programs during the upload.
• Close all open programs such as (Google Chrome, MS Word, etc...) and only have the Arduino 1.6.5 IDE open during upload.
• Restart your computer and don't open any other programs other than the Arduino IDE used for programming.
• 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.

Notes On Updating and Using v2.0.0 Cyton Firmware

Overview

The OpenBCI Cyton boards were updated with new firmware across all three main microcontrollers, the Pic 32 (Pic32) and both RFduinos on the Dongle (Host) and the Board (Device). This tutorial does not explain how to program the firmware using the OpenBCI Dongle and PC; you will want to refer to the tutorials Cyton Board Programming Tutorial and Cyton Radios Programming Tutorial. If you have spent a lot of time writing custom Arduino code to run on the OpenBCI, then you will find this tutorial helpful in upgrading to get the new stability and features of the 2.0.0 firmware.

Sending data packets from the Pic32 to the PC

At 250Hz, we are at the upper limit of the physical hardware. The Device RFduino must send data packets as soon as it gets them from the Pic32 because of the slow serial baud rate between Pic32 and Device (115200 baud, a faster baud rate messes up the radio on the Device). On the other hand, over the air programming must be able to combine multiple radio packets together into one page and write at one time, therefore, over the air programming must wait to see if it received all data over the serial port before sending. These two requirements led to the original firmware being stateful, where the Device and Host would be in either streaming or not streaming mode. This led to problems and could result in the PC not being able to contact the Cyton because the radios were stuck in streaming mode and the reset button on the Cyton is not tied to the Device so one would have to power cycle the entire Cyton.

An Example

Let's say you want to send custom data from the Cyton to the PC. In order to do that simply wrap the data with the correct start byte, 0x41, and stop byte, 0xCX (where X is 0-F in hex). In the OpenBCI_32bit_Library code base:

/*  
 * @description Writes channel data and axisData array to serial port in
 *  the correct stream packet format.
 *
 *  Adds stop byte OPENBCI_EOP_STND_ACCEL. See OpenBCI_32bit_Library_Definitions.h
 */
void OpenBCI_32bit_Library::sendChannelDataWithAccel(void)  {

    Serial0.write('A'); // 0x41 1 byte

    Serial0.write(sampleCounter); // 1 byte

    ADS_writeChannelData(); // 24 bytes

    accelWriteAxisData(); // 6 bytes

    Serial0.write(OPENBCI_EOP_STND_ACCEL); // 0xC0 1 byte

    sampleCounter++;

}

This code writes 33 bytes of data from the Pic32 to the Device in the correct format and therefore as soon as it arrives at the Device it will be sent to the Host and to the PC. New to firmware version 2 is the ability to have different stop bytes, in the original firmware, one could only send stop bytes of 0xC0 however now, we can send 0xCn where n is 0-F (hex).
Important if you want to only send 20 bytes of data per packet, you still must send this 33 bytes with the proper start and stop bytes. Sending data too fast will result in a buffer overflow on the Device and cause the system to restart and send an error message to the Host and PC.

Sending one byte of data every 10ms or 100Hz

Here is an example taken from the file called BoardWithCustomData.ino from the examples folder in the OpenBCI_32bit_Library repo.

void sendLEDStatus() {
  // Must have header byte
  Serial0.write('A'); // 0x41 1 byte
  // Write the LED state
  Serial0.write(LEDState); // 1 byte
  // Fill the rest with fake data
  for (int i = 0; i < 30; i++) {
    Serial0.write(0x00);
  }
  // Send a stop byte with an `B` or `1011` in the last nibble to indicate a
  //  different packet type.
  Serial0.write(0xCB); // 1 byte
}

As you can see above, we only really want to send 1 byte, but if we want to do it fast, at this 100Hz rate, we must wrap it in the start byte and stop byte to tell the Device to send the packet as soon as it get's the stop byte.

Adopting the new Pic32 code paradigm

We drastically reduced the complexity of the .ino files in order to make custom device programming more approachable for new programmers but also add a suite of features to give great power to great programmers. We have created an environment to drive contribution to the main project in the form of examples. If you want to contribute code the main library for others to use, now you can simply do a pull request. Joel was able to adapt his pulse sensor code to the new firmware in about 20 minutes! Now anyone who downloads the firmware, will get the pulse sensor code versus having to dig through all the OpenBCI repos to find an example of how to use a pulse sensor, have external triggers, read an analog input, etc...

Please dig through the examples folder on the OpenBCI_32bit_Library for a deep dive into all the possibilities with the new code. Remember if you have new code you want to share, please do!! Make a pull request!