CV30

This tutorial provides a step-by-step guide to retrieving CV30 information in a Nureva® audio system using the available API.

Supported devices

• HDL200
• HDL300, Dual HDL300

What can be controlled with the API?

• Get information about configured CV30 cameras

📘

For more information on how to set up the CV30 camera, see the CV30 Camera guide.

Minimum role required: general

The Get devices and Get device endpoints can be accessed with the general role (recommended) or any role of a higher level. 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 make a request to get all peripheral configurations.

2. Use Get device to get a specific peripheral configuration.

Instructions

Step 1 - Make a request to get all peripheral configurations

To get all peripheral configurations, use the Get devices endpoint.

1. Set the path with the IP address and port of the Nureva device followed by /api/v1/room/devices. The port 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

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' \

6. If the call is successful, an HTTP status code of 200 OK and the Nureva device details together with all its peripherals will be returned.

Example of response

{
  "devices": [
    {
      "deviceId": "MK072S69M025060",
      "deviceType": "nu-audio-device",
      "audioDeviceType": "hdl300",
      "deviceStatusColor": "green",
      "hardwareComponents": [
        {
          "portNumber": 1,
          "hardwareId": "AAFDE9C1E2E7",
          "connectionStatus": "Connected",
          "model": "bar"
        }
      ]
    },
    {
      "deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "deviceType": "cv30",
      "customName": "CV30",
      "firmwareVersion": "9.1.71",
      "serialNumber": "XXX0X0X0X1X9"
    }
  ]
}

Step 2 - Make a request to get CV30 configuration

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

1. Set the path with the IP address and port of the Nureva device followed by /api/v1/room/devices/<deviceId>, where deviceId is the ID of the peripheral, and the port 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 CV30 settings for the Nureva device with the IP address of 10.0.0.1 and device ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Example of request

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

6. If the call is successful, an HTTP status code of 200 OK and the specified peripheral configuration will be returned.

Example of response

{
  "deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "deviceType": "cv30",
  "customName": "CV30",
  "firmwareVersion": "9.1.71",
  "serialNumber": "XXX0X0X0X1X9"
}

✅

Tutorial complete!

You now understand how to retrieve CV30 information.