HTTP device connector

Use the HTTP device connector (Unity.Connector.Device.Http) when loading device definitions from an HTTP endpoint.

Behavior

When invoked, the HTTP device connector makes a GET request to the configured Endpoint. The connector appends the following query parameters:

• workspaceId: the workspace associated with this connector.
• facilityId: the facility associated with this connector.

The connector expects a list of Device models to be returned.

Prerequisites

Before you configure an HTTP device connector, host an endpoint that's accessible through HTTP or HTTPS. Note: Make sure the endpoint responds to a GET request to the configured endpoint and returns device definitions in the JSON format outlined in the Models section.

Configuration

You configure the HTTP device connector using the Live Systems Data API.

{
  "implementation": "Unity.Connector.Device.Http",
  "properties": {
    "Endpoint": "http://my-http-endpoint.com/devices"
  }
}

Properties

Property	Description
Endpoint	HTTP(S) URL that lists DeviceResource models in the JSON format.

Models

Device

{
  "deviceId": "string",
  "deviceType": "string",
  "telemetryNames": [
    "string",
    "string"
  ],
  "properties": {
    "prop1": "string",
    "prop2": "string",
    "prop3": "string"
  }
}

Property	Description	Sample value
deviceId	The ID or unique name of the device on the external system. This property matches incoming telemetry events with this registered device.	"turbine_1", "outlet_23", "fan_4"
deviceType	The type or category of the device.	"Wind Turbine", "Electrical Outlet", "Fan"
telemetryNames	Lists the telemetry keys that the device can send. This property matches incoming telemetry data with telemetry keys on this registered device.	"Power", "RPM", "Voltage"
properties	Dictionary of metadata associated with the device.	"Model Number: AB1234"