The OpenBCI Web Bluetooth Driver - !!WARNING!! STILL IN PRE-ALPHA PHASE

Provide a stable cross platform web bluetooth driver for the OpenBCI Ganglion

Welcome!

First and foremost, Welcome! 🎉 Willkommen! 🎊 Bienvenue! 🎈🎈🎈

Thank you for visiting the OpenBCI Ganglion Web Bluetooth repository.

This document (the README file) is a hub to give you some information about the project. Jump straight to one of the sections below, or just scroll down to find out more.

• What are we doing? (And why?)
• Who are we?
• What do we need?
• How can you get involved?
• Get in touch
• Find out more
• Installing

What are we doing?

The problem

• OpenBCI Ganglion NodeJS must rely on noble for bluetooth control.
• Some linux and macOS users drop a lot of packets using the current drivers
• There is no cross platform driver for Ganglion right now
• People must use NodeJS always
• Ganglion data is compressed and in a very raw form, takes programmers a while to understand

So, it's clear there are some issues that need to be fixed!

The solution

The OpenBCI Ganglion Web Bluetooth driver will:

• Will leverage web bluetooth which is supported by a massive community
• Hopfully solve the dropped packet problem on mac and linux
• Avoid windows users from having to use a dongle
• Be fun and easy to use
• Take the hard work of decompressing the raw data stream for programmers

Using the OpenBCI Ganglion Web Bluetooth driver allows you, the user, to quickly

Who are we?

Mainly, we are community of programmers who love brainwaves on the browser. The original code writer was Uri Shaked's and we hard forked his muse-js library. AJ Keller overhauled and applied his work from OpenBCI_Ganglion_NodeJS.

What do we need?

You! In whatever way you can help.

We need expertise in programming, user experience, software sustainability, documentation and technical writing and project management.

We'd love your feedback along the way.

Our primary goal is to brovide a stable cross platform web bluetooth driver for the OpenBCI Ganglion, and we're excited to support the professional development of any and all of our contributors. If you're looking to learn to code, try out working collaboratively, or translate you skills to the digital domain, we're here to help.

Get involved

If you think you can help in any of the areas listed above (and we bet you can) or in any of the many areas that we haven't yet thought of (and here we're sure you can) then please check out our contributors' guidelines and our roadmap.

Please note that it's very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our code of conduct in all interactions both on and offline.

Contact us

If you want to report a problem or suggest an enhancement we'd love for you to open an issue at this github repository because then we can get right on it. But you can also contact AJ by email (pushtheworldllc AT gmail DOT com) or on twitter.

Find out more

You might be interested in:

• Purchase a Cyton | Ganglion | WiFi Shield from OpenBCI

And of course, you'll want to know our:

• Contributors' guidelines
• Roadmap

Thank you

Thank you so much (Danke schön! Merci beaucoup!) for visiting the project and we do hope that you'll join us on this amazing journey to provide a stable cross platform web bluetooth driver for the OpenBCI Ganglion.

Running the demo app

yarn
yarn start

and then open http://localhost:4445/

Usage example

import { GanglionClient } from 'openbci-ganglion-js';

async function main() {
  let client = new GanglionClient();
  await client.connect();
  await client.start();
  client.eegReadings.subscribe(reading => {
    console.log(reading);
  });
  client.accelerometerData.subscribe(acceleration => {
    console.log(acceleration);
  });
}

main();

License:

MIT