You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/usage/binding.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,18 @@ To do this execute the following steps:
56
56
3. Bind the remote to the group by sending the following MQTT message.
57
57
-`zigbee2mqtt/bridge/request/device/bind` with payload `{"from": "my_remote", "to": "my_group"}`
58
58
59
+
### Clearing bindings
60
+
61
+
Using `zigbee2mqtt/bridge/request/device/binds/clear`, bindings can be all or selectively cleared.
62
+
63
+
To clear all bindings, just send the topic with the payload e.g. `{"target": "my_device"}`.
64
+
65
+
To selectively clear bindings by IEEE address, send the topic with the payload e.g. `{"target": "my_deivce", "ieeeList": ["0xa1a2a3a4a5a6a7a8", "0xb1b2b3b4b5b6b7b8"]}`.
66
+
67
+
::: tip
68
+
Clearing bindings will automatically adjust the cached data that Zigbee2MQTT uses internally based on the request/response. After successfully executing this requests, bindings in Zigbee2MQTT should reflect actual bindings on the device.
69
+
:::
70
+
59
71
## Devices
60
72
61
73
Not all devices support this, it basically comes down to the Zigbee implementation of the device itself. Check the device specific page for more info (can be reached via the supported devices page)
Allows to send a Zigbee configure reporting command to a device. Zigbee devices often have attributes that can report changes in their state, such as temperature, humidity, battery level, etc. Attribute reporting allows these devices to automatically send updates when there is a change in the values of these attributes.
548
554
One example is when you change brightness of a bulb with its remote instead of Zigbee2MQTT, the state becomes out of sync.
@@ -576,6 +582,21 @@ Notes:
576
582
- The `reportable_change` value depends on the unit of the attribute, e.g. for temperature 100 means in general 1°C of change.
577
583
- To specify options, e.g. the manufacturerCode use e.g. `{"id":"my_bulb","cluster":"genLevelCtrl","attribute":"currentLevel","minimum_report_interval":5,"maximum_report_interval":10,"reportable_change":10,"options":{"manufacturerCode":1234}}`
Allows to read the reporting configuration registered on a device.
588
+
Attributes must of course be reportable, an error status will be returned for any attribute in the request that is not.
589
+
590
+
Example payloads:
591
+
592
+
- For one attribute: `{"id":"my_bulb","endpoint":1,"cluster":"genLevelCtrl","configs":[{"attribute":"currentLevel"}]}`
593
+
- For multiple attributes: `{"id":"my_bulb","endpoint":1,"cluster":"genLevelCtrl","configs":[{"attribute":"currentLevel"},{"attribute":"currentFrequency"}]}`
594
+
- For manufacturer-specific attribute: `{"id":"my_bulb","endpoint":1,"cluster":"genLevelCtrl","configs":[{"attribute":"currentLevel"}], "manufacturerCode": 0x1234}`
595
+
596
+
::: tip
597
+
Reading reporting config will automatically adjust the cached data that Zigbee2MQTT uses internally based on the request/response. After successfully executing this requests, reporting config in Zigbee2MQTT should reflect the actual reporting config on the device.
598
+
:::
599
+
579
600
### Group
580
601
581
602
#### zigbee2mqtt/bridge/request/group/remove
@@ -629,3 +650,32 @@ See [Touchlink](./touchlink.md).
Allows to call specific pre-defined actions, usually manufacturer-specific.
659
+
All action names are published in `zigbee2mqtt/bridge/definitions` under `actions`.
660
+
661
+
::: tip
662
+
Specific up-to-date actions/parameters can be observed directly in the source code [https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/src/converters/actions.ts](https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/src/converters/actions.ts)
663
+
:::
664
+
665
+
##### Action: `hue_factory_reset`
666
+
667
+
Allows to reset Hue devices via a manufacturer-specific Touchlink request.
668
+
669
+
Parameters:
670
+
671
+
- `extended_pan_id` - Hex string in `0x{id}` format - the extended PAN ID of the network the device(s) should try to join after reset. E.g. `0xa1b2c3d4e5f60123`
672
+
- `serial_numbers` - Array of numbers - the serial numbers of the device(s) to reset. E.g. `[123456, 987654]`
673
+
674
+
##### Action: `raw`
675
+
676
+
::: warning
677
+
This allows sending requests that could negatively impact or even break your network. Use with caution!
678
+
:::
679
+
680
+
Special action that allows to send entirely custom payloads. The given payload is analyzed to chose the proper method of sending (ZCL, ZDO, etc.).
681
+
See link above for parameters details (beyond the scope of this documentation).
0 commit comments