New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →

Book a Demo Sign in

react-native-neurosdk2

Package Overview

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-native-neurosdk2

ReactNative NeuroSDK2 is a set of libraries for iOS and Android operating systems providing tools needed for configuring and receiving raw data from neuro sensors.

Source

npm

Version: 1.0.11

Version published: 3 years ago

Maintainers: 2

Created: 3 years ago

Source

Documentation

Overview

Neurosdk is a powerful tool for working with neuro-sensors BrainBit, BrainBitBlack, Callibri and Kolibri. All these devices work with BLE 4.0+ technology. SDK allows you to connect, read the parameters of devices, as well as receive signals of various types from the selected device.

Getting Started

Firstly, you need to install package.

ReactNative

Available for iOS and Android platforms

Installation

By npm:

$ npm install react-native-neurosdk2 --save

Mostly automatic installation:

$ react-native link react-native-neurosdk2

After installation

Because sdk uses the bluetooth api you need to set up the project.

For Android you need to request runtime permission:

export async function requestPermissionAndroid() {
  try {
    const granted = await PermissionsAndroid.requestMultiple([
      PermissionsAndroid.PERMISSIONS.ACCESS_FINE_LOCATION,
      PermissionsAndroid.PERMISSIONS.BLUETOOTH_CONNECT,
    ]);
    if (
      granted[PermissionsAndroid.PERMISSIONS.ACCESS_FINE_LOCATION] ===
      PermissionsAndroid.RESULTS.GRANTED
    ) {
      ...
    }
    if (
      granted[PermissionsAndroid.PERMISSIONS.BLUETOOTH_CONNECT] ===
      PermissionsAndroid.RESULTS.GRANTED
    ) {
      ...
    }
  } catch (err) { }
}

For iOS you need to add a key to Info.plist because it uses bluetooth too:

<key>NSBluetoothAlwaysUsageDescription</key>
<string>Explanation to using bluetooth</string>

Usage

SDK can be conditionally divided into two parts: device search (Scanner object) and the device itself (Sensor object).

The scanner allows you to find devices nearby, it is also responsible for the first creation of the device. When created, the device is automatically connected. In the future, the connection state can be controlled through the sensor object. Whatever type of device you work with, the use of the scanner will be the same.

The sensor allows you to monitor the status of the device, set parameters, receive a signal of various types.

It is recommended to work with both parts in a separate thread. During the connection, the SDK also reads the main characteristics of the device, which significantly increases the time of the connection method, which will cause the application to freeze.

If an error occurs while working with the library, you will receive an exception for any of the methods.

Description

Package contains tree main modules:

Scanner - to search for devices

import { Scanner } from 'react-native-neurosdk2'

Sensor - methods of interaction with the device

import { Sensor, BrainBitSensor, CallibriSensor } from 'react-native-neurosdk2'

Types - implementation of all types of the library, you can either connect everything or only those necessary for a specific task

import {SensorSamplingFrequency, 
   SensorGain,
   SensorDataOffset,
   SensorExternalSwitchInput,
   SensorADCInput,
   SensorAccelerometerSensitivity,
   SensorGyroscopeSensitivity,
   SensorFirmwareMode,
   IrAmplitude,
   RedAmplitude,
   FPGData,
   SensorAmpMode,
   SensorCommand,
   SensorParamAccess,
   SensorParameter,
   SensorFeature,
   SensorFilter,
   SensorFamily,
   SensorInfo,
   SensorVersion,
   MEMSData,
   Point3D,
   BrainBitSignalData,
   BrainBitResistData,
   CallibriSignalData,
   CallibriEnvelopeData,
   CallibriRespirationData,
   CallibriColorType,
   CallibriSignalType,
   CallibriStimulatorMAState,
   CallibriStimulationParams,
   CallibriMotionAssistantParams,
   CallibriMotionCounterParam,
   QuaternionData,
   CallibriElectrodeState,
   CallibriMotionAssistantLimb,
   CallibriStimulatorState,
   SensorState} from 'react-native-neurosdk2'

Errors

Here is a list of exceptions that occur when working with SDK. You need to be guided by this list in order to understand what happened in the process of executing a particular method.

Code	Description
100	Invalid scan parameters are specified
101	Invalid sensor types are specified for the search
102	Failed to create sensor scanner
103	Failed to started sensor scanner
104	Failed to stopped sensor scanner
105	Failed to get a list of sensors
106	Failed to get a list of sensors
107	Invalid parameters for creating a sensor
108	Failed to create sensor
109	Sensor not founded
110	Failed to connect the sensor
111	Failed to disconnect the sensor
112	Failed to get a list of sensor features
113	Invalid parameters for get a list features of the sensor
114	Invalid parameters for get a list commands of the sensor
115	Failed to get a list of sensor commands
116	Invalid parameters for get a list parameters of the sensor
117	Failed to get a list of sensor parameters
118	Failed to execute the sensor command
119	Failed read the sensor parameter
120	Failed read the sensor parameter
121	Failed write the sensor parameter
122	Failed write the sensor parameter
123	Failed add callback the sensor
124	Failed add callback the sensor

Scanner

The scanner works like this:

Create scanner. When creating a scanner, you need to specify the type of device to search. It can be either one device or several. Here is example for two type of devices - BrainBit and Callibri.

import {Scanner} from 'react-native-neurosdk2'

...

var scanner = new Scanner()
await scanner.init([SensorFamily.LECallibri, SensorFamily.LEBrainBit])

During the search, you can get a list of found devices using a callback. To do this, you need to subscribe to receive the event, and unsubscribe after the search is completed:

scanner.AddSensorListChanged(sensors => {
	console.log(sensors)
});
...
scanner.RemoveSensorListChanged();

Start search

scanner.start()

Stop search

scanner.stop()

Additionally, a list of found devices can be obtained using a separate method.

var sensors = await scanner.sensors()

SensorInfo contains information about device:

Name - the name of device
Address - MAC address of device (UUID for iOS/MacOS)
Serial number - device's serial number
Sensor family - type of device
Sensor model - numerical value of the device model
Pairing requared - whether the device needs to be paired or not

After you finish working with the scanner, you need to clean up the resources used.

scanner.close();

Important! When restarting the search, the callback will only be called when a new device is found. If you need to get all devices found by the current scanner instance, call the appropriate method.

Sensor

Creating

You need to create a device using a scanner. All manipulations with the device will be performed without errors only if the device is connected.

import { CallibriSensor, BrainBitSensor, Sensor,  } from "react-native-neurosdk2";

// BrainBit
var sensor: BrainBitSensor = await scanner.createSensor(sensorInfo) as BrainBitSensor;

// Callibri
var sensor: CallibriSensor = await scanner.createSensor(deviceInfo) as CallibriSensor

Device creation is a blocking method, so it must be called from separate thread.

For all types of devices, you can use the same methods to control the device's connection status, invoke commands, and check for functionality.

Manage connection state

Connection status can be obtained in two ways. The first one is using the sensor property State.

The second way is in real time using a callback:

sensor.AddConnectionChanged((state)=>{           
    console.log(SensorState[state])
})
...
sensor.RemoveConnectionChanged()

A connection can be in two states: connected (InRange) and disconnected (OutOfRange).

Important! The state change callback will not come after the device is created, only after disconnecting (device lost from the scope or using a method) and then connected. The device does not automatically reconnect.

You can connect and disconnect from device manually by methods Connect() and Disconnect(). To receive connection state in real time you need to subscribe to stateChanged event. Also you can get connection state by sensor's property.

await sensor.disconnect()
...
await sensor.connect()

Method Connect is blocking too, so it need to be call from separate thread.

Manage device parameters

Battery

Also, you can get power value from each device by sensor property BattPower or by callback in real time:

sensor.AddBatteryChanged((power)=>{
    console.log(power)
})
...
sensor.RemoveBatteryChanged()

Parameters

Each device has its own settings, and some of them can be configured as you need. Not all settings can be changed and not every device supports all settings.

First you need to find out what parameters the device supports and whether they can be changed:

console.log(sensor.getParameters().map(parameter => SensorParameter[parameter.Param] + ": " + SensorParamAccess[parameter.ParamAccess]))

// Output:
//
// ["Name: Read", 
// "FirmwareMode: Read", 
// "FirmwareVersion: Read", 
// "State: ReadNotify", ... ]

Info about parameter includes two fields:

the name of the parameter, represented by an enumeration
parameter availability for manipulation. Can be one of three values:
- read - read-only
- read and write - parameter can be changed
- read and notify - parameter is updated over time

You can also check if the parameter is supported, for example Gain:

if(sensor.isSupportedParameter(SensorParameter.Gain)){
    ...
}

Parameter description

Name

Name of device. String value.

var name: string = sensor.getName()
...
sensor.setName('new_name') // <- this is throw an exeption, you cannot set device name

State

Information about the connection status of a device. Может принимать два значения:

InRange - Device connected
OutOfRange - The device is turned off or out of range

var state: SensorState = sensor.getState()

Address

MAC-address of device. For iOS/MacOS represents by UUID. String value.

var address: string = sensor.getAddress()

SerialNumber

Serial number of device. String value.

For callibri device families, this field is empty in SensorInfo when searching, and you can get it immediately after connecting using this property.

var sn: string = sensor.getSerialNumber()

HardwareFilterState

Only to Callibri MF sensor!

Device signal filter activity states. If the parameter is supported by the device, it becomes possible to set the desired filters using the HardwareFilters property. The next filters are available:

HPFBwhLvl1CutoffFreq1Hz
HPFBwhLvl1CutoffFreq5Hz
BSFBwhLvl2CutoffFreq45_55Hz
BSFBwhLvl2CutoffFreq55_65Hz
HPFBwhLvl2CutoffFreq10Hz
LPFBwhLvl2CutoffFreq400Hz

If sensor does not support filter in input list the method throw an exception

var filters: Array<SensorFilter> = sensor.getHardwareFilters()
...
sensor.getHardwareFilters([SensorFilter.FilterBSFBwhLvl2CutoffFreq55_65Hz, SensorFilter.FilterHPFBwhLvl2CutoffFreq10Hz])

FirmwareMode

Information about the current mode of operation of the device firmware. It can be in two states:

ModeBootloader - the device is in bootloader mode
ModeApplication - normal operation

var mode: SensorFirmwareMode = sensor.getFirmwareMode()
...
// Setter supports only with Callibri MF
sensor.setFirmwareMode(SensorFirmwareMode.ModeApplication)

SamplingFrequency

An property that is used to set or get the sample rate of a physiological signal. The higher the value, the more data flow from the device to the application, which means the higher the power consumption, but also the higher the range of measured frequencies. And there are also limitations on the physical communication channel (BLE) in terms of bandwidth.

Recommendations for choosing a value:

For EEG signals not less than 250 Hz;
For ECG signals 125 Hz;
For EMG not less than 1000 Hz. When working with several devices at the same time, it is not recommended to increase the frequency above 1000 Hz;
The breath channel has a fixed sampling rate of 20 Hertz. MEMS channels have a fixed sampling rate of 100 Hertz.

It is unchanged for BrainBit and BrainBitBlack and is 250 Hz. Can be changed for Signal Callibri/Kolibri and can take on the following values:

125 Hz
250 Hz
500 Hz
1000 Hz
2000 Hz

Not available for Callibi EMS. If you try to set an unsupported value to the device, an exception will be thrown.

var sf: SensorSamplingFrequency = sensor.getSamplingFrequency()
...
// Setter supports only with Callibri MF
sensor.setSamplingFrequency(SensorSamplingFrequency.FrequencyHz1000)

Gain

Gain of an ADC signal. The higher the gain of the input signal, the less noise in the signal, but also the lower the maximum amplitude of the input signal. It is unchanged for BrainBit and BrainBitBlack and is 6. For Callibi/Kolibri MF you can set the desired value. Not available for Callibi/Kolibri EMS.

var gain: SensorGain = sensor.getGain()
...
// Setter supports only with Callibri MF
sensor.setGain(SensorGain.Gain3)