NeuroPlayPro API reference 1.13.0

1. Intro

NeuroPlayPro software works as a server and is available for HTTP requests and WebSockets connection.

This page provides live data requests - press Run near each command.

HTTP interaction parts are marked with blue outlines.
NeuroPlayPro is available across your local network as HTTP server at "http://127.0.0.1:2336"

WebSockets interaction parts are marked with green outlines.
WebSocket server is available on port "1336"
The server works in two modes:
- JSON (e.g. '{"command":"meditation"}')
- simple text (e.g. "meditation"), which corresponds to HTTP commands

All commands are case insensitive (e.g. "RAWDATA", "rawData", "RawData").

NeuroPlayPro server's output will be in JSON format, which will always have "result" and "time", where "result" will be true if the command was performed successfully.
{ "result": true, "time": "2020-10-25 10:20:30" }

NeuroPlayPro supports multiple devices connected at the same time. All commands marked with the Device indexed indicator accept a hidden argument node=X - an index of the device the command is applied to. Device indexing starts from 0, node=0 is used by default, so by default all commands work with the first started device.

For example, use meditation?node=1 (HTTP) or {"command":"meditation","node":1} (WebSockets) to get 'meditation' of the second device.

2. Device

StartSearch StopSearch ListDevices DeviceCount GetDeviceInfo StartDevice CurrentDeviceInfo CurrentDevicesInfo MakeFavorite GetFavoriteDeviceName SetMontage

3. Data and filtering

Filters

Original data from the device is processing by several filters:If a filter value is "0" - it is turned off.

GetFilters SetFilters SetLPF SetBSF SetHPF

Data samples

FilteredData GrabFilteredData RawData GrabRawData AddEDFAnnotation

Spectrum

Spectrum is calculated via FFT of the filtered data. The dimension is in uV

LastSpectrum LastSpectrums GrabSpectrum GetSpectrum

Rhythms

By default the software calculated standard rhythms (alpha, beta, delta, gamma, theta) and outputs their respective percentage (of overall spectrum) values.

Rhythms RhythmsHistory

Recording

The software starts recording filtered data to EDF and other data (rhythms, meditation/concentration) to NPD file (stands for "NeuroPlayData", really just a "CSV")

StartRecord StopRecord PauseRecord ContinueRecord AddFileToRecord GetUserRecords Records

All data comes channel-wise. To get channel names use the "CurrentDeviceInfo" command. Data samples are stored for 'StorageTime' seconds, 10 seconds by default.'Grab...' commands get data and clear the queue, so the next time it is called - it returns only newly added samples.

SetDataStorageTime GetDataStorageTime

4. BCI: meditation, concentration, biosignal states

Standard BCI modes in NeuroPlayPro are:

Meditation

Percentage of how much the user is relaxed, meditated (high alpha)

Meditation MeditationHistory

Concentration

Percentage of how much the user is focused

Concentration ConcentrationHistory

Biosignal states

Discrete brain state recognition (states are recorded for every user and every session separately)

BiosignalStateStatus RecordBiosignalState EraseBiosignalState StartBiosignalStateRecognition StopBiosignalStateRecognition GetBiosignalStateFile

Shorthand

BCI ListBCI BCIs

5. Miscellaneous

Help Version ControlOptions Close AddLogItem ScreenInfo GetAllSettings GetSettings SetSettings Subscribe
РУEN