pushtheworld / openbci_rfduino_ble

OpenBCI RFDuino BLE code to send two channels

OpenBCI Cyton BLE RFDuino Firmware

Drive BLE communications over the RFDuino on the OpenBCI Cyton

Welcome!

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

Thank you for visiting the OpenBCI Cyton BLE RFDuino Firmware 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
• Understand the jargon

What are we doing?

The problem

• People have to use a dongle to get data from the Cyton
• People can't send data from the Cyton to the web browser :sad_face:
• There is a BLE switch on the Cyton that is doing nothing!

So, these problems add up to limit the amount of devices the cyton can stream it's high quality data to, and that's sad.

The solution

The OpenBCI Cyton BLE RFDuino Firmware SDK will:

• Advertise a device id as a ble device
• Take data from the Pic32 and send it over BLE
• Prove that BLE is a stable option for the Cyton platform

Using BLE allows for every modern day computer to get data from the Cyton, so let's get this firmware stable!

Who are we?

The author of the OpenBCI Cyton BLE RFDuino Firmware is AJ Keller and he was sponsored by NEBA Health, LLC.

We are the OpenBCI community at large though, sourcing our work from dozens of different minds for years. We love brains, we love computers, and we know a bright future is upon us then when we can stream Cyton data into our web browsers and phones.

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 drive BLE communications over the RFDuino on the OpenBCI Cyton 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.

You can also hang out, ask questions and share stories in the OpenBCI NodeJS room on Gitter.

Find out more

You might be interested in:

• Check out NEBA Health, LLC
• An example: RadioDevice32bit.ino

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 make programming with OpenBCI fun and easy.

Documentation

Table of Contents:

---

1. Installation
2. TL;DR
3. WiFi
4. General Overview
5. Classes
6. Developing
7. Testing
8. Contribute
9. License

Developing:

Running:

npm install

Testing:

npm test

Contribute:

1. Fork it!
2. Branch off of development: git checkout development
3. Create your feature branch: git checkout -b my-new-feature
4. Make changes
5. If adding a feature, please add test coverage.
6. Ensure tests all pass. (npm test)
7. Commit your changes: git commit -m 'Add some feature'
8. Push to the branch: git push origin my-new-feature
9. Submit a pull request. Make sure it is based off of the development branch when submitting! :D

License:

MIT

openbci_rfduino_ble's Issues

Missing packets

Looks like packets coming into the RFduino are being jumbled on writes. If the packets get distorted on their way into the RFduino from the pic, we could see the issues we're seeing.

Right now packets can come into the driver missing only a packet of two. Which indicates that the packet is not dropped, it's missing from the data stream!