Registering a Device

Once a device is implemented and running, it must be registered in the webapp before it shows up and can be controlled.

Note

Registering and managing devices requires the manager or admin role, see Users & Roles.

Add a Device

In the webapp, navigate to the device management section and add a new device. The following fields are available:

Name

The name under which the device will be displayed in the app.

IP/Domain

The IP address (IPv4 or IPv6) or domain name (FQDN) under which the device can be reached.

Port

The port under which the device server is listening.

Description

An optional description of the device.

Dashboard Supported

Enable this if the device implements the dashboard. If enabled, the device must actually report dashboard_supported: true in its device.json, otherwise the device cannot be added.

Validation

Before a device can be added or edited, the webapp validates it by calling its ping and info methods, to make sure it is reachable and, if Dashboard Supported is checked, that the device actually reports dashboard support in its device.json. An error is shown if validation fails.

Managing Devices

In the device list, each device also shows a live-fetched badge of its API version. Existing devices can be edited or removed from the same view.