Adjust display and brightness

📘

Only the HDX system supports this feature.

This tutorial shows you how to configure the display and brightness LED lights for the Nureva® HDX system over the local network.

What can be controlled with the API?

HDX audio devices have LED lights on the audio bars and microphone pods that can be configured using the local control API. The local control API provides the ability to adjust the style, brightness and in call colour.

The "lights" property consists of the 3 attributes:

• style: The shape of the LED lights. Possible values are:
  • "Dot"
  • "Eclipse"
• brightness: The level of brightness of the LED lights. Possible values are:
  • "High"
  • "Medium"
  • "Low"
  • "Off"
• inCallColour: The colour of the LED lights. Possible values are:
  • "Green"
  • "Blue"

admin role required

The Set device settings endpoint is restricted to the admin role. To access this endpoint, follow the Authorization tutorial to authenticate with an admin role and obtain YOUR_ADMIN_AUTHPARAMETERS which is required for the requests below.

Instructions

Step 1 - Make a request to get the current display and brightness settings

Use the Get device settings endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/settings.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
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 settings for the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/settings \
     --header 'Authorization: Nureva <YOUR_ADMIN_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.
7. Check the value of the "lights" attibute containing the "style", "inCallColour" and "brightness" attributes.

The example response below indicates that the style is currently set to "Dot".

{
  "lights": {
    "style": "Dot",
    "inCallColour": "Blue",
    "brightness": "Medium"
  }
}

Step 2 - Make a request to set the lights

Use the Set device settings endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/settings.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
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. Update the headers to include Content-type as key and application/json as value.
6. Add the property "lights" to the body property.
7. Add the properties "style","inCallColour","brightness" to the body property. In this example, we will adjust the style setting. Give "style" a value of "Eclipse" to change the LED light theme. The code sample below is a request.

curl --request PATCH \
  --url https://10.0.0.1/api/v1/settings \
  --header 'Authorization: Nureva <YOUR_ADMIN_AUTHPARAMETERS>' \
  --header 'Nureva-Client-Id: integration_app_name' \
  --header 'Nureva-Client-Version: 0.0.1'\
  --header 'Content-type: application/json' \
  --data '{"lights": {"style": "Eclipse"}}'

8. Send the PATCH request.
9. If the call is successful, an HTTP status code of 200 OK will be returned.

Step 3 - Check that the change has been applied successfully

Use the Get device settings endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/settings.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
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 settings for the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/settings \
     --header 'Authorization: Nureva <YOUR_ADMIN_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.
7. Check the value of the "lights" attribute containing "style" attritube

The example below indicates that the change (set style to "Eclipse") was successfully applied.

{
  "lights": {
    "style": "Eclipse",
    "inCallColour": "Blue",
    "brightness": "Medium"
  }
}

✅

Tutorial complete!

You now know how to view and make changes to the display and brightness settings.