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.

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

Add dimmer strategy configuration for ubisys D1(-R) #528

Merged
merged 4 commits into from
Jan 3, 2021
Merged
Changes from 1 commit
Commits
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
43 changes: 43 additions & 0 deletions docs/devices/D1.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,49 @@ By publishing to `zigbee2mqtt/FRIENDLY_NAME/get/ballast_config` the values of th
also be read back from the device and be printed to the normal Zigbee2MQTT log (flagged as warnings but only to make sure they do not get suppressed).
To account for errors due to missing optional attributes (since this is a general function), every cluster attribute will be queried separately and the complete process can therefore take a moment.

### Dimmer strategy configuration
By publishing to `zigbee2mqtt/FRIENDLY_NAME/set` the dimmer strategy configuration can be set. Supported values for the `mode` attibute are `automatic`, `forward` and `reverse`.
Example:
```json
{
"ubisys_dimmer_setup": {
"mode": "automatic"
}
}
```

By publishing to `zigbee2mqtt/FRIENDLY_NAME/get/ubisys_dimmer_setup` the values of the dimmer strategy configuration attributes can also be read back from the device and be printed to the normal Zigbee2MQTT log (flagged as warnings but only to make sure they do not get suppressed). More information about the meaning of the returned bitmaps can be found in the [ubisys D1 technical reference manual](https://www.smarthome-store.de/media/documents/ubisys-d1-technical-reference.pdf), chapter "7.2.8. Dimmer Setup Cluster (Server)".

* Capabilities Attribute

Bit(s) | Description
---|---
0 | When this bit is set, the dimmer supports AC forward phase control.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we translate this in the converters to something more user friendly?

1 | When this bit is set, the dimmer supports AC reverse phase control.
2..4 | These bits are reserved for future use and must be written as 0 and ignored when read.
5 | When this bit is set, the dimmer is capable of measuring the reactance of the attached ballast good enough to distinguish inductive and capacitive loads and select the appropriate dimming technique accordingly.
6 | When this bit is set, the dimmer is capable of replacing the built-in, default dimming curve, with a curve that better suits the attached ballast
7 | When this bit is set, the dimmer is capable of detecting an output overload and shutting the output off to prevent damage to the dimmer.

* Status Attribute

Bit(s) | Description
---|---
0 | When this bit is set, the dimmer is currently operating in AC forward phase control mode.
1 | When this bit is set, the dimmer is currently operating in AC reverse phase control.
2 | This bit is reserved for future use and must be written as 0 and ignored when read.
3 | The output is currently turned off, because the dimmer has detected an overload.
4..5 | Reserved for future use. Set to 0 when writing, ignore when reading.
6 | When this bit is set, the dimmer's reactance discriminator had detected a capacitive load
7 | When this bit is set, the dimmer's reactance discriminator had detected an inductive load

* Mode Attribute

Bit(s) | Description
---|---
0..1 | Specifies the mode of operation:<br>00b: Automatically select the appropriate dimming technique<br>01b: Always use forward phase control (leading edge, L)<br>10b: Always use reverse phase control (trailing edge, C/R)<br>11b: Reserved. Do not use.
2..7 | These bits are reserved for future use. Write as 0, ignore when reading.

### Device type specific configuration
*[How to use device type specific configuration](../information/configuration.md)*

Expand Down