Skip to main content

Electrodes API

The Systems Engine provides endpoints for controlling and monitoring electrodes, including EEG data streaming and impedance checking. This page documents the request and response formats for electrode operations.

EEG Configuration​

Configures specific EEG electrode sensors.

Endpoint​

PUT /system/sensors/eeg

Query Parameters​

ParameterTypeDescription
channelsArrayList of electrode channels to configure (e.g., CZ)

Request Parameters​

The following parameters can be provided as form data:

ParameterTypeDescription
gainNumberGain setting for the channels
samplingFrequencyNumberSampling frequency in Hz

Response​

The response returns confirmation of the configuration update.

Start EEG Stream​

Starts streaming EEG data from the configured channels.

Endpoint​

POST /system/sensors/eeg/stream

Response​

The response returns confirmation that the stream has started.

Stop EEG Stream​

Stops the ongoing EEG data streaming.

Endpoint​

DELETE /system/sensors/eeg/stream

Response​

The response returns confirmation that the stream has been stopped.

Reset EEG Sensors​

Resets all EEG sensors to their default states.

Endpoint​

DELETE /system/sensors/eeg

Response​

The response returns confirmation that all sensors have been reset.

Get Impedance Measurements​

Retrieves impedance measurements for specified electrodes.

Endpoint​

GET /system/sensors/impedance

Query Parameters​

ParameterTypeDescription
channelsArrayList of electrode channels to measure impedance for (e.g., CMS, DRL)

Response​

{
  "CMS": 107391312,
  "DRL": 107390736
}

Get All Impedance Measurements​

Retrieves impedance measurements for all electrodes.

Endpoint​

GET /system/sensors/impedance/all

Response​

{
  "PZ": 58420392,
  "O1": 302095520,
  "O2": 106804768,
  "P3": 39218432,
  "P4": 52093784,
  "T5": 37412905,
  "T6": 42109387,
  "C3": 59128394,
  "C4": 61109385,
  "T3": 39041285,
  "T4": 41012985,
  "CMS": 213612624,
  "DRL": 106806312,
  "CZ": 47178704,
  "F7": 31209564,
  "F8": 30194856,
  "F3": 38412096,
  "F4": 40581972,
  "FP1": 38512904,
  "FP2": 39501284,
  "FZ": 47179396
}

These endpoints allow for precise control and monitoring of electrode functions, optimizing EEG data collection and quality.