NeuroPlayPro API reference 1.9.18
1. Вступление
Программное обеспечение NeuroPlayPro работает как сервер и доступно для HTTP запросов и WebSocket соединений
Эта страница предоставляет выполнение запросов на лету. Просто нажмите на кнопку
Run рядом с любой командой.
HTTP запросы отмечены
синим подчеркиванием.
NeuroPlayPro доступен в вашей локальной сети, как HTTP-сервер по адресу "
http://127.0.0.1:2336"
WebSockets запросы отмечены
зеленым подчеркиванием.
WebSocket-сервер доступен на порту "
1336"
Сервер работает в двух режимах:
-
JSON (например, '{"command":"meditation"}')
-
simple text (например, "meditation") которые
соответствуют HTTP-командам
Все команды нечувствительны к регистру (записи "RAWDATA", "rawData", "RawData" считаются эквивалентными).
Сервер NeuroPlayPro выводит ответы в JSON формате, которые всегда имеют поля
"result" и
"time" где
"result" будет равен
true если команда была выполнена успешно.
{
"result": true,
"time": "2020-10-25 10:20:30"
}
2. Устройство
Частота получения данных зависит от количества выбранных каналов. Для устройств с более высоким количеством поддерживаемых каналов возможно выбрать меньше каналов для увеличения частоты получения данных.
| Каналы | Частота | Имена |
|---|
| 8 каналов | 125 Hz | O1, P3, C3, F3, F4, C4, P4, O2 |
| 6 каналов | 125 Hz | O1, T3, Fp1, Fp2, T4, O2 |
| 1 канал | 1000 Hz | O1 |
StartSearch
StopSearch
ListDevices
DeviceCount
GetDeviceInfo
StartDevice
CurrentDeviceInfo
CurrentDevicesInfo
MakeFavorite
GetFavoriteDeviceName
SetMontage
3. Время хранения и Режим Захвата Данных
Все данные поступают поканально. Чтобы получить имена каналов используйте команду "
CurrentDeviceInfo".Сэмплы данных хранятся в течении "StorageTime" секунд (10 секунд по умолчанию). "Grab..." команда забирают данные из очереди о очищают ее. При следующем вызове возвращаются только новые добавленные сэмплы. Некоторые команды(такие как
RawData и '...
History') требуют включения режима "DataGrabMode", в котором приложение хранит данные в течении нескольких секунд. По умолчанию эта опция выключена для разгрузки памяти/процессора.
EnableDataGrabMode
DisableDataGrabMode
SetDataStorageTime
GetDataStorageTime
Фильтры
Первичные данных от устройства проходят через несколько фильтров:
- Низкочастотный фильтр - пропускает частотный спектр ниже указанной частоты в герцах. По умолчанию имеет значение в 40Гц.
- Высокочастотный фильтр - пропускает частотный спектр выше указанной частоты в герцах. По умолчанию имеет значение в 2Гц.
- Полосный фильтр - строго отсекает значения которые равны указанному значению в герцах. По умолчанию 50Гц.
Если значние фильра равно "0" - он будет отключен.
GetFilters
SetFilters
SetLPF
SetBSF
SetHPF
Сэмплы данных
FilteredData
GrabFilteredData
RawData
GrabRawData
AddEDFAnnotation
Спектр
Спектр получается путём применения быстрого преобразования Фурье (FFT) к фильтрованному сигналу
LastSpectrum
GrabSpectrum
GetSpectrum
Ритмы
По умолчанию, приложение рассчитывает стандартные ритмы (альфа, бета, дельта, гамма, тета) и выводит их соответствующие проценты (от общего спектра).
Rhythms
RhythmsHistory
Запись
Приложение начинает запись фильтрованных данных в EDF и других данных (ритмы, медитация/концентрация) в NPD файл (сокращение означает "NeuroPlayData", в действительности представляет собой табличный CSV-файл)
StartRecord
StopRecord
PauseRecord
ContinueRecord
AddFileToRecord
GetUserRecords
Records
4. BCI: медитация, концентрация, ментальные состояния
Стандартные BCI режимы в NeuroPlayPro:
Медитация
Процент отражающий расслабление пользователя (высокая альфа)
Meditation
MeditationHistory
Концентрация
Процент отражающий насколько пользователь сосредоточен
Concentration
ConcentrationHistory
Ментальные состояния
Дискретные состояния мозга (состояния записываются для каждого пользователя и каждой сессии отдельно)
MentalStateStatus
RecordMentalState
EraseMentalState
StartMentalStateRecognition
StopMentalStateRecognition
GetMentalStateFile
Быстрый доступ
BCI
BCIs
5. Прочее
Help
Version
ControlOptions
Close
AddLogItem
ScreenInfo
GetAllSettings
GetSettings
SetSettings