Skip to content

Commit

Permalink
Updating MQTT docs about the newly added topic (#2762)
Browse files Browse the repository at this point in the history
* Updating MQTT docs about the newly added topic

- New topic: `bridge/definitions`
- Related to Koenkk/zigbee2mqtt#22583

* Update mqtt_topics_and_messages.md

---------

Co-authored-by: Koen Kanters <[email protected]>
  • Loading branch information
LaurentChardin and Koenkk authored May 21, 2024
1 parent b3affc6 commit 717568e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/guide/usage/mqtt_topics_and_messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,27 @@ A device definition will always have an `exposes` and `options` property which a
- `exposes` This contains all the device capabilities (e.g. switch, light, occupancy)
- `options` Contains all the device options (e.g. `temperature_precision`) which can be set through `zigbee2mqtt/bridge/request/device/options`

## zigbee2mqtt/bridge/definitions
Contains the zigbee clusters definitions of the devices, this message is published as retained and is structured with 2 parts:
* `clusters`: contains the official cluster definition from the `zigbee-herdsman` package, organized by cluster name
* `custom_clusters`: contains the custom cluster definitions from the `zigbee-herdsman-converts` package, of devices currently used

Example payload:
```json
{
"clusters": {
"genBasic": {ID: 0, ...},
"genPowerCfg" : {ID: 1, ...},
},
"custom_clusters": {
"0x12345678": {
"myManuspecificCluster": {"ID": 0xFC01, ...},
}
}
}
```

The message is updated at startup and when a device is joining/leaving/reconfiguring.

## zigbee2mqtt/bridge/groups
Contains the groups, this message is published as retained.
Expand Down

0 comments on commit 717568e

Please sign in to comment.