Run recalibration

📘
Only HDL310 and HDL410 devices support this command.

Runs the recalibration for the connected Nureva® audio device. The device will emit a loud static-like sound for approximately 20 seconds. Ensure the room is quiet when running recalibration. We do not recommend recalibrating when the device is in a call. The speaker bars must be connected to the CM2 for the recalibration to start.

Request

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": string,
  "clientId": string
}

The response below is returned on a successful request to run recalibration. The content of the response is an echo of the original response.

Response

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": string,
  "clientId": string
}

Errors

Status code	Description
10000 – Bad request	Request does not conform to the specification. The message field will include detailed information about which part of the request is incorrect.
12000 – Speaker bar disconnected	No speaker bars are connected to the CM2.

Sample requests

1. Valid request/response

Request

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a195",
  "clientId": "Extron"
}

Response

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a195",
  "clientId": "Extron"
}

2. Bad request - no requestId or clientId

Request

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": "",
  "clientId": ""
}

Response

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": "",
  "clientId": "",
  "errors": [
    {
      "statusCode": 10000,
      "message": "clientId: String can't be empty or whitespace"
    },
    {
      "statusCode": 10000,
      "message": "requestId: String can't be empty or whitespace"
    }
  ]
}

3. Speaker bar disconnected

This is a valid request, but returns an error because the speaker bars have been disconnected.

Request

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a195",
  "clientId": "Extron"
}

Response

{
  "request": "v1/devices/commands/runRecalibration",
  "requestId": "",
  "clientId": "",
  "errors": [
    {
      "statusCode": 12000,
      "message": "Speaker bar disconnected"
    }
  ]
}