Nureva audio device

This tutorial explains how to retrieve Nureva audio device information from a Nureva® audio system using the Local Control API.

Supported devices

• HDL200
• HDL300, Dual HDL300
• HDL310, HDL410
• HDX

What can you do with the API?

• Get information about Nureva audio devices.

Minimum role required: general

The Get devices and Get device endpoints require the general role (recommended) or a higher-level role. Follow the Authorization tutorial to authenticate with a general role and obtain YOUR_GENERAL_AUTHPARAMETERS which is required for the requests below.

Overview

1. Use Get devices to retrieve the configurations of all peripherals, including the Nureva audio device.

2. Use Get device to retrieve the configuration of a specific Nureva audio device.

Instructions

Step 1: Get all peripheral configurations

Use the Get devices endpoint to retrieve all peripheral configurations.

1. Set the path with the IP address of the Nureva device followed by /api/v1/room/devices. The port number is required for HDL200, HDL300 and Dual HDL300, it might be 8222, 8223, or whatever was defined during installation.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint using the general account.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Send the GET request. The code sample below is a request to retrieve the peripherals for the Nureva device with the IP address of 10.0.0.1.

Example of request

HDL200, HDL300, Dual HDL300:

curl --request GET \
    --url https://10.0.0.1:8222/api/v1/room/devices \
    --header 'Authorization: Nureva <YOUR_GENERAL_AUTHPARAMETERS>' \
    --header 'Nureva-Client-Id: integration_app_name' \
    --header 'Nureva-Client-Version: 0.0.1'

HDL310, HDL410, HDX:

curl --request GET \
    --url https://10.0.0.1/api/v1/room/devices \
    --header 'Authorization: Nureva <YOUR_GENERAL_AUTHPARAMETERS>' \
    --header 'Nureva-Client-Id: integration_app_name' \
    --header 'Nureva-Client-Version: 0.0.1'

If the request is successful, the API returns 200 OK with the Nureva device details and its peripherals.

Example of response

{
  "devices": [
    {
      "deviceId": "MK072S69M025060",
      "deviceType": "nu-audio-device",
      "audioDeviceType": "hdl300",
      "deviceStatusColor": "green",
      "hardwareComponents": [
        {
          "portNumber": 1,
          "hardwareId": "AAFDE9C1E2E7",
          "connectionStatus": "Connected",
          "model": "bar"
        }
      ]
    }
  ]
}

Step 2: Get the Nureva audio device configuration

To get the configuration of just the Nureva audio device, use the Get device endpoint.

1. Set the path with the IP address of the Nureva device followed by /api/v1/room/devices/<deviceId>, where deviceId is the serial number of your connect module or system hub, and the port number is required for HDL200, HDL300 and Dual HDL300, it might be 8222, 8223, or whatever was defined during installation.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint using the general account.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Send the GET request. The code sample below is a request to retrieve the Nureva audio device configuration with the IP address of 10.0.0.1 and device ID MK072S69M025060.

Example of request

HDL200, HDL300, Dual HDL300:

curl --request GET \
    --url https://10.0.0.1:8222/api/v1/room/devices/MK072S69M025060 \
    --header 'Authorization: Nureva <YOUR_GENERAL_AUTHPARAMETERS>' \
    --header 'Nureva-Client-Id: integration_app_name' \
    --header 'Nureva-Client-Version: 0.0.1'

HDL310, HDL410, HDX:

curl --request GET \
    --url https://10.0.0.1/api/v1/room/devices/MK072S69M025060 \
    --header 'Authorization: Nureva <YOUR_GENERAL_AUTHPARAMETERS>' \
    --header 'Nureva-Client-Id: integration_app_name' \
    --header 'Nureva-Client-Version: 0.0.1'

If the request is successful, the API returns 200 OK with the specified device configuration.

Example of response

{
  "deviceId": "MK072S69M025060",
  "deviceType": "nu-audio-device",
  "audioDeviceType": "hdl300",
  "deviceStatusColor": "green",
  "hardwareComponents": [
    {
      "portNumber": 1,
      "hardwareId": "AAFDE9C1E2E7",
      "connectionStatus": "Connected",
      "model": "bar"
    }
  ]
}

✅

Tutorial complete!

You now know how to retrieve Nureva audio device information.