Monitoring Dashboard

Overview

This tab allows OEMs to define the visual dashboard shown on the End Customer portal.

The dashboard is built of multiple "Sections". Each section can be static or conditionally shown based on device capabilities (e.g. only show "Noise Cancellation Widgets" if that feature is enabled on the device).

Sections

To add a section, click on the "Add section" button on the top right.

  • Section name - General section name.
  • Condition type
    • All devices - Show this section for all devices.
    • Configuration or Details - Define a path in the configuration or details (Data Types) where a boolean key is present. If the key is present in the specified path for a device, and the value is true, the section will be displayed.
      For example the path: config.settings.surroundSound.enabled will check a device's Configuration JSON for an object named settings, then inside for an object named surroundSound and inside for a key enabled. If the keys are found and value of the enabled key is true the section will be displayed, otherwise it will be hidden from the End Customer.

Widgets

Each Section may contain multiple Widgets of different types.

To add a Widget, click on the "Add widget" button.

The Widgets are separated into a number of families:

  • Monitoring - Widgets that display information only.
  • Commands - Widgets that tie into "Supported Commands".
  • UI - UI only Widgets, for structuring.

Clicking any Widget will open its configuration parameters. Each Widget has their own properties but (almost) all rely on a few basic concepts:

  • Title - Title and other text to be displayed.
  • Telemetry - The key of the Telemetry send by a device to use for the value of the widget.

What’s Next