> ## Documentation Index > Fetch the complete documentation index at: https://docs.getmelody.io/llms.txt > Use this file to discover all available pages before exploring further. # Send Maintenance Command > Send a maintenance command to the device. ## OpenAPI ````yaml /api-reference/openapi_sdk.yaml post /device/maintenance/command openapi: 3.1.0 info: title: Haptics SDK API contact: name: Haptics API Support email: support@getmelody.io url: https://docs.getmelody.io/spec description: > # Introduction Welcome to the Haptics Docs API! You can use our API to access Haptics SDK endpoints. All API requests must contain header `Content-Type: application/json` by default. If not explicitly specified otherwise. Haptics Prod: [api.getmelody.io](https://api.getmelody.io) Haptics Stage: [api.haptics.devlikereal.com](https://api.haptics.devlikereal.com) # Authentication Access is scoped to your **organization**. Your **Organization ID** and **Developer Key** (Melody Key) are issued to you by Melody — contact [support@getmelody.io](mailto:support@getmelody.io) to request them. To call device endpoints: 1. Link a device to your organization with `POST /device/otp/confirm/v2` (send your Developer Key in the `X-Org-Key` header) to obtain its **Device Key**. 2. Exchange your Developer Key for a short-lived **session token** with `POST /api/sessions/v2`. 3. Call any `/device/*` endpoint with `Authorization: Bearer ` and the `X-Device-Key: ` header. version: v4 servers: - url: https://api.getmelody.io description: Production - url: https://api.haptics.devlikereal.com description: Staging security: [] tags: - name: Authentication description: > Obtain and use organization-scoped access tokens. Your Organization ID and Developer Key (Melody Key) are issued to you by Melody — contact support@getmelody.io to request them. - name: Device Information description: | The Device Information API encompasses two primary functionalities: This section includes endpoints that enable you to: - Retrieve detailed information about the device. - Access information related to the current session. - Update device settings efficiently. - Set required device mode. - name: Haptic Direct Control description: > Section convers Direct Control mode. User is able to set position & time to get the receiver there. - name: Haptic Points Stream description: > Section covers Points Stream mode. Mode for streaming arrays of signal with device position & signal time in the original sender’s timescale. The stroker movement velocity is calculated on device and is based on time difference between signals. At least two signals needed to calculate stroker velocity & move the stroker. - name: Haptic Script Control description: > Section covers Script Playback. The script is sent to device by passing the link. After script downloaded by device, server controls device with start, stop, pause commands. - name: Haptic Loop Control description: > Section covers Loop Playback. Mode for simple up/down stroking without the need for data points. It only needs stroker velocity percentage and min/max positions for stroking range to create a loop and move according provided range. - name: One-Time Password description: > Section covers One-Time Password. The one-time password is valid for 10-15 minutes, required for device bootstrapping with 3rd party services. - name: Maintenance description: > This section provides APIs dedicated to the upkeep and troubleshooting of the device. Key functionalities include: - Firmware Updates: APIs to check for, download, and apply firmware updates, ensuring the device is running the latest software version with improved features and fixes. - Debug Information: Access detailed diagnostic data and logs to facilitate troubleshooting and performance analysis. - Debug Logging: Enable or disable real-time debug log emission from the device. When enabled, the device sends unsolicited `DEBUG_LOG` frames (frame type `21`) over the WebSocket. Each frame carries a `DebugLogMessage` protobuf payload with a single `message` string field. Logs are stored server-side per device (up to 1000 entries) and can be viewed in the CMS device detail page. paths: /device/maintenance/command: post: tags: - Maintenance summary: Send Maintenance Command description: Send a maintenance command to the device. operationId: post-device-maintenance-command parameters: - $ref: '#/components/parameters/XDeviceKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeviceMaintenanceCommand' responses: '200': description: OK security: - SessionToken: [] components: parameters: XDeviceKey: name: X-Device-Key in: header required: true description: | Device Key (4 BIP39 words) identifying the target device. Obtain it from `POST /device/otp/confirm/v2`. schema: type: string pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$ example: alpha-bravo-charlie-delta schemas: DeviceMaintenanceCommand: type: object description: | The maintenance command of the device. properties: command: type: string description: > The maintenance command to be sent to the device. **START_CALIBRATION**: Start calibration of the device. Receiver finds lowest & highest mechanical positions & lowest & highest hall sensor positions. Can be entered from device menu or by WiFi mode service command. **START_OTA**: Start OTA update of the device. Device checks lates available firmware from haptics-connect server & prompts user to confirm update if it`s available. Can be entered from WiFi mode with service command, or by initiating update from device menu while being connected to WiFi. **SET_CURRENT_SCREEN**: Navigate the device display to a specific screen. Requires `screen_id` field in the request body. example: START_CALIBRATION enum: - START_CALIBRATION - START_OTA - SET_CURRENT_SCREEN screen_id: type: integer description: > 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). example: 6 minimum: 2 maximum: 15 securitySchemes: SessionToken: type: http scheme: bearer description: > Short-lived session token obtained from POST /api/sessions/v2. Send it as `Authorization: Bearer ` together with the `X-Device-Key: ` header identifying the target device. ````