Edit

Software Development

Overview

Welcome all Software Developers! In this document, we will go over the tools available to assist in integrating OpenBCI hardware with projects in multiple programming languages. Also, we will briefly look at how OpenBCI hardware is integrated into the OpenBCI GUI using Processing.

Introducing BrainFlow

Prior to version 5.0, the OpenBCI GUI relied on a Node.js Electron app to handle communications as middleware via TCP/IP on Mac, Linux, and Windows machines. This required users to allow a separate app to run in the background. At the same time, there are many users who just want to use OpenBCI hardware with Python, C++, or C#. The OpenBCI Community needed a solution, and we found one: BrainFlow!

BrainFlow is written in C++ and then exported to a handful of languages. This cuts down on development time, and provides a centralized repository for OpenBCI drivers that are more accessible and accommodating.

BrainFlow Documentation!

Initial Setups and Testing

GUI v5.0+ uses the BrainFlow-Java package. When starting a new project with OpenBCI hardware for the first time, it is important to check that you can connect the hardware properly, depending on your biosensing setup.

We recommend using the GUI to start your project and check signals before moving towards full integration. Furthermore, we recommend using the GUI's Networking Widget to stream data for proof-of-concept via UDP, LSL, OSC, or Serial. This allows you to visualize real-time and playback data in the GUI while modifying your application in a separate IDE.

Once proof-of-concept is achieved, it's appopriate to consider integrating the OpenBCI board directly into your project using one of the BrainFlow bindings, found below. The GUI can still be used at any time to check signals, make recordings, and stream live data.

Supported Boards

• Supported Boards and Parameters (important)

BrainFlow - C++

• Compilation of Core BrainFlow Module and C++ Binding
• C++ API Reference
• C++ Code Samples

BrainFlow - Python

• Install Python Binding
• Python API Reference
• Python Code Samples

BrainFlow - C#

• Install C# Binding
• C# API Reference
• C# Code Samples

BrainFlow - Java

• Install Java Binding
• Java API Reference
• Java Code Samples

BrainFlow - R

• Install R Binding
• R API Reference
• R Code Samples

Notebooks

• BrainFlow to MNE Python Notebook
• Denoising Notebook

---

OpenBCI GUI Overview

• GUI How-to and Installation
• The GUI Widget Guide provides details on each "widget" within the GUI, such as the Time Series Widget and the Networking Widget
• GUI Changelog

BrainFlow Java Binding and OpenBCI GUI

This project is currently in Alpha testing, more information will be available after the stable GUI version 5.0 has been released.