Device and Entity Structure

This article focuses on explaining how API IDs are generated, the different device types used in the Local API, and how devices are identified through Gateway IDs and Device IDs. It also covers the concept of entities within a device and how multiple entities can be linked to a single parent device.

<API id>/<type>/<gateway-id>/<device-id>

API ID

The API ID in Glamox Connect is automatically generated based on the name given to the API when it is created. Typically, it is a lowercase, condensed version of the name without spaces or special characters.

For example, if a site tenant is named "Tenant X", the API ID will be "tenantx". This makes it easier to reference and integrate the API within your system. You can find the assigned API ID in the list of created APIs within Glamox Connect.

Type

There are a few device types that we use in this Local API solution. They will determine what type of device you have and what data comes with this device.

We have three types of devices:

light - this is a lumianire
binary_sensor - a true/false sensor
sensor - other types of sensors

Each of these types will later come as a seperate entity on a device.

Gateway ID

Gateway ID indicates which gateway the device is on.

Device ID

Device ID identifies wach specific device.

Entity

A singular device can have one or more entities. This usualy means that the luminaire is integrated with sensors. Different entities for a device can be identified using config payload. As you can see in the table below - the device ID stays the same while the type of device changes.