Get device information

This tutorial shows how to get device information from Nureva® audio devices over the local network.

What device information is available?

• hardwareId: The unique hardware identifier of the audio device
• model: The model of the audio device. Possible values are:
  • hdx
  • hdl410
  • hdl310
  • dual-hdl
  • hdl300
  • hdl200
• firmwareVersion: The firmware version of the device
• deviceStatus: The status of the device. Possible values are:
  • Ok
  • CableUnplugged
  • Disconnected
• hardwareComponents: The various hardware components of the device
• ipAddress: The IP address of the device
• mac_address: The MAC address of the device
• enrollmentStatus: The enrollment status of the device. Possible values are:
  • enrolled
  • unEnrolled
• enrollmentCode: The enrollment code of the device

Minimum role required: general

The Get Device Information endpoint 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 Device Information endpoint to retrieve the audio device information.
2. Check that the request was successful.

Instructions

Step 1 - Send a request to retrieve the audio device information

Use the Get Device Information endpoint to a make a request to get information about the device:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/audio/hardware.
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 get the device information of the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/audio/hardware \
     --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 will be returned.

Step 2 - Parse the response

The example response below indicates that:

1. The device hardware ID is XF714R57B319605
2. The device is an HDL410
3. The firmware version of the device is 1.9.278056
4. The hardware components list includes: ConnectModule2 and two bars with hardware ID AAC277A0D026 on port 1 and hardware ID AAC277A0D027 on port 2
5. The IP address is 10.0.0.1
6. The MAC address is cd:ba:ea:fb:a9:b8
7. The device is currently enrolled in Nureva Console cloud
8. The enrollment code of the device is G85-SVN-KMJ

{
  "hardwareId": "XF714R57B319605",
  "model": "hdl410",
  "firmwareVersion": "1.9.278056-0",
  "deviceStatus": "Ok",
  "hardwareComponents": [
    {
      "model": "ConnectModule2",
      "hardwareId": "XF714R57B319605"
    },
    {
      "model": "Bar",
      "hardwareId": "AAC277A0D026",
      "portNumber": 1
    },
    {
      "model": "Bar",
      "hardwareId": "AAC277A0D027",
      "portNumber": 2
    }
  ],
  "ipAddress": "10.0.0.1",
  "mac_address": "cd:ba:ea:fb:a9:b8",
  "enrollmentStatus": "enrolled",
  "enrollmentCode": "G85-SVN-KMJ"
}

✅

Tutorial complete!

You now know how to get device information.