Motors API

The Systems Engine provides endpoints for controlling and monitoring the motors used to position electrodes. This page documents the request and response formats for motor operations.

Get Motor Positions

Retrieves the current positions of specified electrode motors.

Endpoint

GET /system/motors/position

Query Parameters

Parameter	Type	Description
electrode	Array	List of electrode names to retrieve positions for (e.g., CMS, DRL, P4)

Response

{
  "CMS": 20,
  "DRL": 20,
  "P4": 24
}

Get Motor States

Retrieves the current states of specified electrode motors.

Endpoint

GET /system/motors/state

Query Parameters

Parameter	Type	Description
electrode	Array	List of electrode names to retrieve states for (e.g., CMS, DRL)

Response

{
  "CMS": 1,
  "DRL": 1
}

Control Motor Movements

Controls the movement of electrode motors with specific directions and displacements.

Endpoint

POST /system/motors/position

Request Body

{
  "configuration": [
    {
      "electrode": "CZ",
      "movement": "RETRACT",
      "displacement": 30
    }
  ]
}

Field	Type	Description
electrode	String	Electrode name (PZ, O1, O2, P3, P4, T5, T6, C3, C4, T3, T4, CMS, DRL, CZ, F7, F8, F3, F4, FP1, FP2, FZ)
movement	String	Movement type ("RETRACT", "RELEASE", "STOP", "BRAKE")
displacement	Number	Amount of displacement

Optional Query Parameters

Parameter	Type	Description
waitUntilComplete	Boolean	If TRUE, makes the call synchronous and waits for completion
getFinalPosition	Boolean	If TRUE, makes the call synchronous and returns final positions

Response

{
  "CZ": 1
}

Reset All Motors

Moves all motors to a specified extreme position.

Endpoint

POST /system/motors/position/reset

Request Body

{
  "position": "MAX"
}

Field	Type	Description
position	String	Position to move motors to ("MIN" or "MAX")

Response

{
  "PZ": 1,
  "O1": 1,
  "O2": 1,
  "P3": 1,
  "P4": 1,
  "T5": 1,
  "T6": 1,
  "C3": 1,
  "C4": 1,
  "T3": 1,
  "T4": 1,
  "CMS": 1,
  "DRL": 1,
  "CZ": 1,
  "F7": 1,
  "F8": 1,
  "F3": 1,
  "F4": 1,
  "FP1": 1,
  "FP2": 1,
  "FZ": 1
}

These endpoints enable precise control of electrode positions for optimal contact with the scalp.