Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating MQTT docs about the newly added topic #2762

Merged
merged 2 commits into from
May 21, 2024
Merged

Updating MQTT docs about the newly added topic #2762

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c61f44
Updating MQTT docs about the newly added topic
LaurentChardin May 20, 2024
558f92c
Update mqtt_topics_and_messages.md
Koenkk May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/guide/usage/mqtt_topics_and_messages.md
View file
Open in desktop
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
Loading