@openbci/wifi
Advanced tools
Readme
Make programming with OpenBCI reliable, easy, research grade and fun!
First and foremost, Welcome! :tada: Willkommen! :confetti_ball: Bienvenue! :balloon::balloon::balloon:
Thank you for visiting the OpenBCI WiFi Shield NodeJS SDK 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.
So, if even the very best developers integrate the current easy to use Cyton and Ganglion NodeJS drivers, they are still burdened by the limitations of the physical hardware on the OpenBCI system.
The OpenBCI WiFi Shield NodeJS SDK will:
Using WiFi physically solves limitations with the current state-of-the-art open source bio sensor. The goal for the WiFi Shield firmware was to create a one up data pipeline, where scientific data in JSON is sent instead of raw/compressed ADC counts (yuk!) to make programming with OpenBCI reliable, easy, research grade and fun!
The founder of the OpenBCI WiFi Shield NodeJS SDK is AJ Keller.
AJ is an invited member of the 4th cohort Open Leaders Cohort of the Mozilla Science Lab who brought together open science advocates from around the world to participate in the first Working Open Workshop in Berlin in February 2016. The training exercises (which are free and easy to reuse) focused on how to build and effectively engage communities so they can work together to develop tools and resources for the greater good.
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 make programming with OpenBCI reliable, easy, research grade and fun, 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.
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.
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.
You might be interested in:
And of course, you'll want to know our:
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.
We assume you have NodeJS installed already, if you don't please download the latest stable version from NodeJS.
Then simply using the node package manager command line tool, enter:
npm install @openbci/wifi
Get connected and start streaming right now with the example code.
const Wifi = require('@openbci/wifi');
let wifi = new Wifi({
debug: false,
verbose: true,
latency: 10000
});
wifi.on(k.OBCIEmitterSample, (sample) => {
for (let i = 0; i < wifi.getNumberOfChannels(); i++) {
console.log("Channel " + (i + 1) + ": " + sample.channelData[i].toFixed(8) + " Volts.");
// prints to the console
// "Channel 1: 0.00001987 Volts."
// "Channel 2: 0.00002255 Volts."
// ...
// "Channel 8: -0.00001875 Volts."
}
});
wifi.searchToStream({
sampleRate: 1000 // Custom sample rate
shieldName: 'OpenBCI-2C34', // Enter the unique name for your wifi shield
streamStart: true // Call to start streaming in this function
}).catch(console.log);
npm install
npm test
development: git checkout developmentgit checkout -b my-new-featurenpm test)git commit -m 'Add some feature'git push origin my-new-featuredevelopment branch when submitting! :DMIT
Initializing the board:
const Wifi = require('../../openBCIWifi');
const ourBoard = new Wifi();
Go checkout out the get streaming example!
For initializing with options, such as verbose print outs:
const Wifi = require('../../openBCIWifi');
const wifi = new Wifi({
verbose: true
});
or if you are using ES6:
import Wifi from '../../openBCIWifi';
import { constants } from '@openbci/utilities';
const wifi = new Wifi();
wifi.connect("OpenBCI-2114");
To debug, it's amazing, do:
const Wifi = require('../../openBCIWifi');
const wifi = new Wifi({
debug: true
});
startByte (Number should be 0xA0)sampleNumber (a Number between 0-255)channelData (channel data indexed at 0 filled with floating point Numbers in Volts) if sendCounts is falsechannelDataCounts (channel data indexed at 0 filled with floating point Numbers in Volts) if sendCounts is trueaccelData (Array with X, Y, Z accelerometer values when new data available) if sendCounts is falseaccelDataCounts (Array with X, Y, Z accelerometer values when new data available) Only present if sendCounts is trueauxData (Buffer filled with either 2 bytes (if time synced) or 6 bytes (not time synced))stopByte (Number should be 0xCx where x is 0-15 in hex)boardTime (Number the raw board time)timeStamp (Number the boardTime plus the NTP calculated offset)The power of this module is in using the sample emitter, to be provided with samples to do with as you wish.
.searchToStream(_options_)const Wifi = require('../../openBCIWifi');
let wifi = new Wifi({
debug: false,
verbose: true,
latency: 10000
});
wifi.on(k.OBCIEmitterSample, (sample) => {
for (let i = 0; i < wifi.getNumberOfChannels(); i++) {
console.log("Channel " + (i + 1) + ": " + sample.channelData[i].toFixed(8) + " Volts.");
// prints to the console
// "Channel 1: 0.00001987 Volts."
// "Channel 2: 0.00002255 Volts."
// ...
// "Channel 8: -0.00001875 Volts."
}
});
wifi.searchToStream({
sampleRate: 1000 // Custom sample rate
shieldName: 'OpenBCI-2C34', // Enter the unique name for your wifi shield
streamStart: true // Call to start streaming in this function
}).catch(console.log);
Close the connection with .streamStop() and disconnect with .disconnect()
const Wifi = require('../../openBCIWifi');
const wifi = new Wifi();
wifi.streamStop().then(wifi.disconnect());
ObjectKind: global class Author: AJ Keller (@aj-ptw)
InitializationObjectArrayPromise.<T>Promise.<T> | *PromisePromisePromisePromisebooleanbooleanboolean*Stringnull | StringNumbernull | StringNumberNumbernull | Stringglobal.Promise | Promiseglobal.Promise | PromisePromisePromisePromisePromiseglobal.Promise | PromisePromisePromise.<T> | *PromisePromisePromisePromisePromise.<TResult>PromisenumbernumbernumberPromisePromisePromiseThe initialization method to call first, before any other method.
| Param | Type | Description |
|---|---|---|
| options | InitializationObject | (optional) - Board optional configurations. |
InitializationObjectKind: instance property of Wifi
Private Properties (keep alphabetical)
Kind: instance property of Wifi
Public Properties (keep alphabetical)
Kind: instance property of Wifi
ArrayThis function is for redundancy after a long packet send, the wifi firmware can resend the same packet again, using this till add redundancy on poor networks.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
| Param | Description |
|---|---|
| rawDataPackets | - |
Promise.<T>Send a command to the board to turn a specified channel off
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
| Param |
|---|
| channelNumber |
Promise.<T> | *Send a command to the board to turn a specified channel on
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
| Param |
|---|
| channelNumber |
PromiseTo send a channel setting command to the board
Kind: instance method of Wifi
Returns: Promise - resolves if sent, rejects on bad input or no board
Author: AJ Keller (@aj-ptw)
| Param | Description |
|---|---|
| channelNumber | Number (1-16) |
| powerDown | Bool (true -> OFF, false -> ON (default)) turns the channel on or off |
| gain | Number (1,2,4,6,8,12,24(default)) sets the gain for the channel |
| inputType | String (normal,shorted,biasMethod,mvdd,temp,testsig,biasDrp,biasDrn) selects the ADC channel input source |
| bias | Bool (true -> Include in bias (default), false -> remove from bias) selects to include the channel input in bias generation |
| srb2 | Bool (true -> Connect this input to SRB2 (default), false -> Disconnect this input from SRB2) Select to connect (true) this channel's P input to the SRB2 pin. This closes a switch between P input and SRB2 for the given channel, and allows the P input to also remain connected to the ADC. |
| srb1 | Bool (true -> connect all N inputs to SRB1, false -> Disconnect all N inputs from SRB1 (default)) Select to connect (true) all channels' N inputs to SRB1. This effects all pins, and disconnects all N inputs from the ADC. |
PromiseTo send an impedance setting command to the board
Kind: instance method of Wifi
Returns: Promise - resolves if sent, rejects on bad input or no board
Author: AJ Keller (@aj-ptw)
| Param | Type | Description |
|---|---|---|
| channelNumber | Number | (1-16) |
| pInputApplied | Boolean | (true -> ON, false -> OFF (default)) |
| nInputApplied | Boolean | (true -> ON, false -> OFF (default)) |
PromiseThe essential precursor method to be called initially to establish a ble connection to the OpenBCI ganglion board.
Kind: instance method of Wifi
Returns: Promise - If the board was able to connect.
Author: AJ Keller (@aj-ptw)
| Param | Type | Description |
|---|---|---|
| o | Object | |
| o.burst | Boolean | Set this option true to have UDP do burst mode 3x |
| o.examineMode | Boolean | Set this option true to connect to the WiFi Shield even if there is no board attached. |
| o.ipAddress | String | The ip address of the shield if you know it |
| o.latency | Number | If you want to set the latency of the system you can here too. |
| o.protocol | String | Either send the data over TCP or UDP. UDP seems better for either a bad router or slow router. Default is TCP |
| o.sampleRate | The sample rate to set the board connected to the wifi shield | |
| o.shieldName | String | If supplied, will search for a shield by this name, if not supplied, will connect to the first shield found. |
| o.streamStart | Boolean | Set true if you want the board to start streaming. |
PromiseCloses the connection to the board. Waits for stop streaming command to be sent if currently streaming.
Kind: instance method of Wifi
Returns: Promise - - fulfilled by a successful close, rejected otherwise.
Author: AJ Keller (@aj-ptw)
booleanChecks if the driver is connected to a board.
Kind: instance method of Wifi
Returns: boolean - - True if connected.
Author: AJ Keller (@aj-ptw)
booleanChecks if noble is currently scanning.
Kind: instance method of Wifi
Returns: boolean - - True if streaming.
Author: AJ Keller (@aj-ptw)
booleanChecks if the board is currently sending samples.
Kind: instance method of Wifi
Returns: boolean - - True if streaming.
Author: AJ Keller (@aj-ptw)
*Get the current board type
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
StringGet the firmware version of connected and synced wifi shield.
Kind: instance method of Wifi
Returns: String - The version number
Note: This is dependent on if you called connect
Author: AJ Keller (@aj-ptw)
null | StringReturn the ip address of the attached WiFi Shield device.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
NumberReturn the latency to be set on the WiFi Shield.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
null | StringReturn the MAC address of the attached WiFi Shield device.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
NumberThis function is used as a convenience method to determine how many channels the current board is using. Note: This is dependent on if your wifi shield is attached to another board and how many channels are there.
Kind: instance method of Wifi
Returns: Number - A number
Author: AJ Keller (@aj-ptw)
NumberGet the the current sample rate is. Note: This is dependent on if you configured the board correctly on setup options
Kind: instance method of Wifi
Returns: Number - The sample rate
Author: AJ Keller (@aj-ptw)
null | StringReturn the shield name of the attached WiFi Shield device.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
global.Promise | PromiseCall to start testing impedance.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
global.Promise | PromiseCall to stop testing impedance.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
PromiseUsed to search for an OpenBCI WiFi Shield. Will connect to the first one if no shieldName is supplied.
Kind: instance method of Wifi
Returns: Promise - - Resolves after successful connection, rejects otherwise with Error.
Author: AJ Keller (@aj-ptw)
| Param | Type | Description |
|---|---|---|
| o | Object | (optional) |
| o.sampleRate | The sample rate to set the board connected to the wifi shield | |
| o.shieldName | String | If supplied, will search for a shield by this name, if not supplied, will connect to the first shield found. |
| o.streamStart | Boolean | Set true if you want the board to start streaming. |
| o.timeout | Number | The time in milli seconds to wait for the system to try and auto find and connect to the shield. |
PromiseSet the sample rate of the remote OpenBCI shield
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
| Param | Type | Description |
|---|---|---|
| sampleRate | Number | the sample rate you want to set to. |
PromiseReturns the sample rate from the board
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
PromiseList available peripherals so the user can choose a device when not automatically found.
Kind: instance method of Wifi
Returns: Promise - - If scan was started
Author: AJ Keller (@aj-ptw)
global.Promise | PromiseCalled to end a search.
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
PromiseSends the stop SD logging command to the board. If not streaming then eot event will be emitted
with request response from the board.
Kind: instance method of Wifi
Returns: Promise - - Resolves when written
Author: AJ Keller (@aj-ptw)
Promise.<T> | *Syncs the internal channel settings object with a cyton, this will take about over a second because there are delays between the register reads in the firmware.
Kind: instance method of Wifi
Returns: Promise.<T> | * - Resolved once synced, rejects on error or 2 second timeout
Author: AJ Keller (@aj-ptw)
PromiseSends a soft reset command to the board
Kind: instance method of Wifi
Returns: Promise - - Fulfilled if the command was sent to board.
Author: AJ Keller (@aj-ptw)
PromiseTells the WiFi Shield to forget it's network credentials. This will cause the board to drop all connections.
Kind: instance method of Wifi
Returns: Promise - Resolves when WiFi Shield has been reset and the module disconnects.
Author: AJ Keller (@aj-ptw)
PromiseSends a start streaming command to the board.
Kind: instance method of Wifi
Returns: Promise - indicating if the signal was able to be sent.
Note: You must have successfully connected to an OpenBCI board using the connect
method. Just because the signal was able to be sent to the board, does not
mean the board will start streaming.
Author: AJ Keller (@aj-ptw)
PromiseSends a stop streaming command to the board.
Kind: instance method of Wifi
Returns: Promise - indicating if the signal was able to be sent.
Note: You must have successfully connected to an OpenBCI board using the connect
method. Just because the signal was able to be sent to the board, does not
mean the board stopped streaming.
Author: AJ Keller (@aj-ptw)
Promise.<TResult>Sync the info of this wifi module
Kind: instance method of Wifi
Author: AJ Keller (@aj-ptw)
| Param | Type | Description |
|---|---|---|
| o | Object | |
| o.examineMode | Boolean | Set this option true to connect to the WiFi Shield even if there is no board attached. |
PromiseUsed to send data to the board.
Kind: instance method of Wifi
Returns: Promise - - fulfilled if command was able to be sent
Author: AJ Keller (@aj-ptw)
| Param | Type | Description |
|---|---|---|
| data | Array | Buffer | Number | String | The data to write out |
Call this to shut down the servers.
Kind: instance method of Wifi
numberGet the local port number of either the TCP or UDP server. Based on options.protocol being set to
either udp or tcp.
Kind: instance method of Wifi
Returns: number - The port number that was dynamically assigned to this module on startup.
numberGet the local port number of the UDP server.
Kind: instance method of Wifi
Returns: number - The port number that was dynamically assigned to this module on startup.
numberGet the local port number of the UDP server.
Kind: instance method of Wifi
Returns: number - The port number that was dynamically assigned to this module on startup.
Initialization function that will start the TCP server and bind the UDP port.
Kind: instance method of Wifi
PromiseSend a delete message to the connected wifi shield.
Kind: instance method of Wifi
Returns: Promise - - Resolves if gets a response from the client/server, rejects with error
| Param | Type | Description |
|---|---|---|
| path | String | the path/route to send the delete message to |
PromiseSend a GET message to the connected wifi shield.
Kind: instance method of Wifi
Returns: Promise - - Resolves if gets/with a response from the client/server, rejects with error
| Param | Type | Description |
|---|---|---|
| path | String | the path/route to send the GET message to |
PromiseSend a POST message to the connected wifi shield.
Kind: instance method of Wifi
Returns: Promise - - Resolves if gets a response from the client/server, rejects with error
| Param | Type | Description |
|---|---|---|
| path | String | the path/route to send the POST message to |
| payload | * | can really be anything but should be a JSON object. |
Configuring Options
Kind: inner property of Wifi
ObjectKind: global typedef Properties
| Name | Type | Description |
|---|---|---|
| attempts | Number | The number of times to try and perform an SSDP search before quitting. (Default 10) |
| burst | Boolean | Only applies for UDP, but the wifi shield will send 3 of the same packets on UDP to increase the chance packets arrive to this module (Default false) |
| debug | Boolean | Print out a raw dump of bytes sent and received. (Default false) |
| latency | Number | The latency, or amount of time between packet sends, of the WiFi shield. The time is in micro seconds! |
| protocol | String | Either send the data over TCP or UDP. UDP seems better for either a bad router or slow router. Default is TCP |
| sampleRate | Number | The sample rate to set the board to. (Default is zero) |
| sendCounts | Boolean | Send integer raw counts instead of scaled floats. (Default false) |
| verbose | Boolean | Print out useful debugging events. (Default false) |
FAQs
The official SDK for the OpenBCI/Push The World Wifi Shield connected to either OpenBCI Cytons or Ganglions.
The npm package @openbci/wifi receives a total of 6 weekly downloads. As such, @openbci/wifi popularity was classified as not popular.
We found that @openbci/wifi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.