Group Info

Overview of all groups in a location.

Topics

Subscribe to: api_client/<client_name>/<location_id>/group

Response

retained
QoS: 1

{
  "id": "6ba3d60a-1593-4af8-82d2-8a87aca403ea",
  "name": "Apartment 101",

  "rooms": [
    {
      "id": "f5083bdd-039e-4c99-9620-f69d021bc7f8",
      "name": "Bedroom",

      "devices": [
        {
          "id": "abcd1234efgh5678ijkl9012mnop3456qrst7890uvwx5678yzab9012cdef3456",
          "serialNumber": "1111-0622-0006-0000",
          "name": "Livy Alive"
        }
      ]
    }
  ]
}

• id: Unique identifier of the group (UUID), to be used as <groupId> e.g. in the group state topic
• name: Name of the group, e.g., “Apartment 101”, “Household”
• rooms: List of all rooms inside this group
  • id: Unique identifier of the room (UUID), to be used as <roomId> e.g. in the room state topic
  • name: Name of the room, e.g., “Bedroom”, “Bathroom”
  • devices: List of all devices that are located in this room
    • id: Unique identifier of the device (UUID), to be used as <deviceId> e.g. in the alarm topics
    • name: Name of the device, e.g., “Livy Alive”
    • serialNumber: serial number of the device. The Serial number is printed on the back of the device