Skip to main content

LEDs API

The Systems Engine provides endpoints for controlling and monitoring the LEDs on the headset. This page documents the request and response formats for LED operations.

Get LED State

Retrieves the current state of the specified LED.

Endpoint

GET /system/led/state

Response

{
"color": "#fff",
"active": true,
"state": "STATIC"
}

Set LED State

Sets the state of a specified LED on the headset.

Endpoint

PUT /system/led/state

Request Parameters

The following parameters can be provided as form data:

ParameterTypeDescription
colorStringHex color value (e.g., "#0000FF")
blinksPerSecondNumberBlink rate (for blinking LEDs)
indexStringLED identifier ("USER" or "STATUS")

Response

{
"success": true,
"state": {
"color": "#0000FF",
"blinksPerSecond": 4,
"index": "STATUS"
}
}

These endpoints enable control of visual indicators on the headset, which can be useful for signaling device status and user feedback.