> ## 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. # Enable or Disable Debug Logging > Enables or disables debug logging on the device. When enabled, the device will emit unsolicited `DEBUG_LOG` frames (frame type `21`) over the WebSocket connection. Each frame contains a `DebugLogMessage` protobuf message with a `message` string field. **Important:** This setting is not persisted on the device. After a reconnect the device reverts to its firmware default (logging off). The server stores incoming `DEBUG_LOG` frames per device (up to 1000 entries). Stored logs are accessible via the CMS API: - `GET /api/cms/devices/{id}/debug-logs` — paginated log retrieval - `DELETE /api/cms/devices/{id}/debug-logs` — clear all logs Returns `404` if the device is not currently connected. ## OpenAPI ````yaml /api-reference/openapi_sdk.yaml post /device/debug/logging 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/debug/logging: post: tags: - Maintenance summary: Enable or Disable Debug Logging description: > Enables or disables debug logging on the device. When enabled, the device will emit unsolicited `DEBUG_LOG` frames (frame type `21`) over the WebSocket connection. Each frame contains a `DebugLogMessage` protobuf message with a `message` string field. **Important:** This setting is not persisted on the device. After a reconnect the device reverts to its firmware default (logging off). The server stores incoming `DEBUG_LOG` frames per device (up to 1000 entries). Stored logs are accessible via the CMS API: - `GET /api/cms/devices/{id}/debug-logs` — paginated log retrieval - `DELETE /api/cms/devices/{id}/debug-logs` — clear all logs Returns `404` if the device is not currently connected. operationId: set-device-debug-logging parameters: - $ref: '#/components/parameters/XDeviceKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetDebugLoggingRequest' responses: '200': description: OK — debug logging state applied on device. content: application/json: schema: $ref: '#/components/schemas/DeviceDebugInfo' '404': description: Device is not connected. 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: SetDebugLoggingRequest: type: object required: - enabled properties: enabled: type: boolean description: > Set to `true` to enable debug logging on the device, `false` to disable. example: true DeviceDebugInfo: type: object description: | The debug information of the device. properties: free_heap_size: type: number description: | The free heap size of the device in bytes. example: 100000 external_flash_size: type: number description: | The external flash size of the device in bytes. example: 100000 debug_logging_enabled: type: boolean description: > Whether debug logging is currently enabled on the device. When `true`, the device emits `DEBUG_LOG` frames (frame type `21`) over the WebSocket containing a `DebugLogMessage { message: string }` protobuf payload. example: false 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. ````