Note |
---|
This is only available as a beta release under our early-access program. Reach out your Glamox sales representant if this is interesting |
In Glamox Connect can communicate with your local system through our local API. Set up an API, provide connection to your system and you are set to receive all data from the lighting installation as well as the possibility to send commands to the installation.
...
unique ID’s
which device it is part of
the device_location with location information like floorplan, room and coordinates set in Connect (if present)
which state_topic it will use to send its state updates. The client will need to listen to this topic to get updates for the entity
which command_topic it will use to send its state updates, if the entity can be controlled. The client will need to send command messages to this topic to be able to change values for the entity
Friendly name
...
Code Block | ||
---|---|---|
| ||
state_topic: connect/light/001fee00000053a6/17880107102b0c/state schema: json unique_id: 17880107102b0c_light object_id: 17880107102b0c_light device_location: floorplan_name: Floor 3 floorplan_id: 2bbd26bc-c1cc-4c73-b6f0-84cb43b5f8c5 floorplan_point: - '0.7114518843852604' - '0.05005221590401024' room_id: b7d115c2-b910-40b8-93b7-99d6dc8b4535 room_name: LMS device: identifiers: - 17880107102b0c name: 17880107102b0c"Customers name/tag" manufacturer: Glamox Connect API model: Wireless Zigbee suggested_area: mysitename via_device: 001fee00000053a6 command_topic: connect/light/001fee00000053a6/17880107102b0c/set name: Light_17880107102b0c brightness_scale: 100 color_mode: 'true' brightness: 'true' supported_color_modes: - brightness effect: 'true' effect_list: - identify platform: mqtt |
...
Virtual sensor | Device class | Description |
---|---|---|
function_test_failure | problem | Indicates whether last function test failed or not “ON” means that function test has failed. |
duration_test_failure | problem | Indicates whether last duration test failed or not “ON” means that the duration test has failed. |
System groups
Most of the local systems in Glamox Connect make use of light groups. If this is set up in your local system you can also get this in your API, showing which devices are in the group and being able to send commands to the group
Group discovery
Similar to device discovery, to get a list of all the groups in your system you need to send a message to the group discovery topic <API ID>/groups/search
ex: connect/groups/search
You will then receive a payload containing a list of all groups on topic <API ID>/group/<GROUP ID>/config
Group discovery payload
In the group discovery payload you will get a list of all groups as objects containing id and name.
Name will depend on the local system and name given to the group and will be the field for you to identify which group you are looking at.
The ID is Connect internal and is to be used for commands and similar
Code Block | ||
---|---|---|
| ||
[
{"id": "ee87e78b-23a2-4b87-996f-9f2d10ea409e", "name": "A group"},
{"id": "85a168bb-aec2-42e7-acbc-a13d9ab2728c", "name": "Another group"},
{"id": "c509a026-7c6d-4e79-957a-fbab81b06e2a", "name": "Lsst group"},
] |
Group commands
To send commands to the groups you do this using a group specific topic, and the standard payload format in the same way as for devices.
To send commands to group, use the following topic
<API ID>/group/<Group ID>/set
As an example, if your API is “connect” and you want to turn on and set 80% brightness for group “A group
" in the list above, you send the following payload to connect/group/ee87e78b-23a2-4b87-996f-9f2d10ea409e/set
Code Block | ||
---|---|---|
| ||
{
"brightness": 80,
"state": "ON"
} |