Skip to main content
POST
Send Maintenance Command

Authorizations

Authorization
string
header
required

Short-lived session token obtained from POST /api/sessions/v2. Send it as Authorization: Bearer <session_token> together with the X-Device-Key: <device-key> header identifying the target device.

Headers

X-Device-Key
string
required

Device Key (4 BIP39 words) identifying the target device. Obtain it from POST /device/otp/confirm/v2.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$
Example:

"orbit-ranch-silver-tomato"

Body

application/json

The maintenance command of the device.

command
enum<string>

The maintenance command to be sent to the device.

START_CALIBRATION: Start calibration. The device finds its lowest and highest mechanical positions and the matching hall sensor readings. It can also be started from the device menu.

START_OTA: Check for a firmware update. If one is available, the device asks the user to confirm before installing it. It can also be started from the device menu while the device is on WiFi.

SET_CURRENT_SCREEN: Navigate the device display to a specific screen. Requires screen_id field in the request body.

Available options:
START_CALIBRATION,
START_OTA,
SET_CURRENT_SCREEN
Example:

"START_CALIBRATION"

screen_id
integer

Screen to navigate to. Required when command is SET_CURRENT_SCREEN. Ignored for other commands.

Available values: 2 (Main), 3 (Manual), 5 (Settings), 6 (WiFi), 7 (BLE), 8 (Range Adjustment), 9 (Speed Adjustment), 10 (Brightness), 11 (Info), 12 (Calibration), 13 (Firmware Update), 14 (OTP), 15 (Reset Settings). 4 is not a screen. The server forwards the value unchecked, so an id outside this list reaches the device as-is.

Required range: 2 <= x <= 15
Example:

6

Response

200

OK