Skip to main content

systems engine

The Systems Engine is a REST API service that runs on top of the Instinct EEG headset. It provides comprehensive control over the headset hardware, allowing you to configure and operate various subsystems such as EEG streaming, electrode impedance checking, motor control, and recording management.

base url​

All Systems Engine API requests should be directed to:

http://localhost:42069/system

key concepts​

eeg headset​

The Instinct headset is an advanced EEG device that captures brain electrical activity through multiple electrodes. The Systems Engine provides a programmatic interface to control all aspects of the headset.

eeg streaming​

The primary function of the headset is to stream EEG data. The Systems Engine allows you to:

  • Configure streaming parameters
  • Start and stop data streaming
  • Process and record the incoming data

impedance checking​

Electrode impedance is critical for EEG data quality. The Systems Engine provides functions to:

  • Measure electrode impedances
  • Monitor contact quality
  • Optimize electrode placement

Note: Impedance checking and EEG streaming are mutually exclusive operations. You cannot perform both simultaneously.

hardware control​

The Systems Engine gives you control over the physical hardware components:

  • Motors for electrode positioning
  • LEDs for status indication
  • Electrodes for signal acquisition

recordings​

The Systems Engine allows you to:

  • Start and stop EEG recordings
  • Store recordings with metadata
  • Retrieve and manage saved recordings

device configuration​

The headset requires various configuration settings. The Systems Engine enables you to:

  • Set and retrieve device configurations
  • Save configuration presets
  • Apply different configurations for specific use cases

core capabilities​

The Systems Engine allows you to:

  1. Control the EEG headset

    • Configure and manage the hardware components
    • Monitor device status
    • Update device settings

  2. Acquire EEG data

    • Configure streaming parameters
    • Start and stop data acquisition
    • Check signal quality through impedance testing

  3. Manage recordings

    • Create and store EEG recordings
    • Retrieve and download recordings
    • Organize recordings with metadata

getting started​

To start using the Systems Engine:

  1. Ensure the service is running at http://localhost:42069/system
  2. Check the headset connection status
  3. Configure and start EEG streaming or impedance checking

For a step-by-step guide, see the Headset Setup Tutorial.

api structure​

The Systems Engine API is organized into these main categories:

  • System Operations - Basic device control and status
  • Stream Operations - EEG data streaming
  • Electrode Operations - Impedance checking and electrode control
  • Motor Operations - Control headset motors
  • LED Operations - Control status indicators
  • Recording Operations - Manage EEG recordings
  • Device Configuration - Manage device settings

For detailed information about available endpoints, parameters, and response formats, see the API Reference.