NeuroplayPro API reference 1.2.6
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.
interaction parts are marked with blue outlines
NeuroplayPro is available across you local network.
In this example it will be referred as a server on "http://127.0.0.1:2336
interaction parts are marked with green outlines
The server works in two modes:
- 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"
, where "result"
will be true
if the command was performed successfully.
"time": "2020-10-25 10:20:30"
Data frequency depends on the number of selected channels. For devices with higher amount of supported channels it is possible to select less channels for greater data frequency.
||O1, P3, C3, F3, F4, C4, P4, O2
||O1, T3, F3, F4, T4, O2
||O1, F3, F4, O2
All data comes channel-wise. To get channel names use the "CurrentDeviceInfo
Storage time and 'Data grab mode'
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.
Some commands (e.g. "RawData
') require enabled 'Data Grab Mode' in which the software stores data for several seconds. By default this feature is off for memory/processor optimisations.
Original data from the device is processing by several filters:
- Low-pass filter (LPF) - minifies occurence of signals below it's value in Hz. Default is 40 Hz.
- Hi-pass filter (HPF) - minifies occurence of signals over it's value in Hz. Default is 2 Hz.
- Band stop filter (BSF) - strictly minifies signals equal to it's value in Hz. Default is 50 Hz.
If a filter value is "0" - it is turned off.
Spectrum depends on current data frequency and window size. To obtain spectrum frequencies use "SpectrumFrequencies
" command, for the actual valus use "spectrum" command.
By default the software calculated standard rhythms (alpha, beta, delta, gamma, theta) and outputs their respective percentage (of overall spectrum) values.
The software starts recording filtered data to EDF and other data (rhythms, meditation/concentration) to NPD file (stands for "NeuroPlayData", really just a "CSV")
4. BCI: meditation, concentration, mental states
Standard BCI modes in NeuroplayPro are:
Percentage of how much the user is relaxed, meditated (high alpha)
Percentage of how much the user is focused
Discrete brain state recognition (states are recorded for every user and every session separately)