Managing Light Groups in Glamox Connect
- Joanna Kozakiewicz
Most local systems in Glamox Connect use light groups. If your local system supports light groups, you can access them through the API. This allows you to see which devices belong to a group and send commands to the group.
Group Discovery
Similar to device discovery, you can retrieve a list of all groups in your system by sending a message to the group discovery topic: <API ID>/groups/search
For example: connect/groups/search
The response will include a payload listing all groups on the following topic: <API ID>/group/<GROUP ID>/config
Group Discovery Payload
The group discovery payload contains a list of group objects, each with an ID and name. The name field depends on the local system configuration and is used to identify the group. The ID is an internal identifier used for commands and other operations.
Example Payload:
[
{"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": "Last group"}
]Sending Commands to Groups
To send commands to a group, use a group-specific topic and the standard payload format, similar to device commands.
Topic Format: <API ID>/group/<Group ID>/set
Example Command
If your API is "connect" and you want to turn on and set the brightness to 80% for "A group", send the following payload to: connect/group/ee87e78b-23a2-4b87-996f-9f2d10ea409e/set
Payload:
{
"brightness": 80,
"state": "ON"
}This structure ensures efficient control of light groups through the API.