Scene support for Zooz Z-Wave Switches (#10067)

Added instructions on how to update the switch and openzwave config file to add scene support for Zooz Zen26 & Zen27 switches.
This commit is contained in:
David 2019-08-08 11:34:29 -07:00 committed by Franck Nijhof
parent fefb36c058
commit af7b284906

View File

@ -191,6 +191,161 @@ Triple tap on|2|4
5x tap off|1|6
5x tap on|2|6
### Zooz Scene Capable On/Off and Dimmer Wall Switches (Zen26 & Zen27 - Firmware 2.0+)
Many Zooz Zen26/27 switches that have been sold do not have firmware 2.0+. Contact Zooz to obtain the over the air firmware update instructions and new user manual for the switches.
Once the firmware is updated, the the new configuration paramters will have to be added to the `zwcfg` file. Replace the existing `COMMAND_CLASS_CONFIGURATION` with the one of the following options (depending on your model of switch):
Zen26 (On/Off Switch):
```xml
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1" request_flags="4" innif="true">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse will reverse those functions. Any will toggle the light regardless of which button is pushed.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Any" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="0" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable the auto turn-off timer function.</Help>
<Item label="Disabled (Default)" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="1">
<Help>Time, in seconds, for auto-off timer delay. 60 (default).</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable the auto turn-on timer function.</Help>
<Item label="Disabled (Default)" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="55">
<Help>Time, in minutes, for auto-on timer delay. 60 (default).</Help>
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="2" size="1">
<Help>Status after power on after power failure. OFF will always turn light off. ON will always turn light on. Restore will remember the latest state and restore that state.</Help>
<Item label="OFF" value="0" />
<Item label="ON" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="10" label="Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable scene control functionality for quick double tap triggers.</Help>
<Item label="Disabled (Default)" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="11" label="Enable/Disable Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or disable local on/off control. If enabled, you&apos;ll only be able to control the connected light via Z-Wave.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled (Default)" value="1" />
</Value>
</CommandClass>
```
Zen27 (Dimmer):
```xml
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1" request_flags="4" innif="true">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse will reverse those functions. Any will toggle the light regardless of which button is pushed.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Any" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="0" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Auto Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Auto Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Auto Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Auto Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="2" size="1">
<Help>Status after power on after power failure. OFF will always turn light off. ON will always turn light on. Restore will remember the latest state and restore that state.</Help>
<Item label="OFF" value="0" />
<Item label="ON" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="byte" genre="config" instance="1" index="9" label="Ramp Rate Control" units="seconds" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="3">
<Help>Adjust the ramp rate for your dimmer (fade-in / fade-out effect for on / off operation). Values correspond to the number of seconds it take for the dimmer to reach full brightness or turn off when operated manually.</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="10" label="Minimum Brightness" units="%" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="99">
<Help>Set the minimum brightness level for your dimmer. You won&apos;t be able to dim the light below the set value.</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="11" label="Maximum Brightness" units="%" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="99">
<Help>Set the maximum brightness level for your dimmer. You won&apos;t be able to add brightness to the light beyond the set value. Note: if Parameter 12 is set to value &quot;Full&quot;, Parameter 11 is automatically disabled.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="12" label="Double Tap Function Brightness" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Double Tap action. When set to Full, turns light on to 100%. If set to Maximum Level, turns light on to % set in Parameter 11.</Help>
<Item label="Full" value="0" />
<Item label="Maximum Level" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="13" label="Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable scene control functionality for quick double tap triggers.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="14" label="Enable Double Tap Function" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Enable the double tap or disable the double tap function and assign brightness level to single tap.</Help>
<Item label="Enabled" value="0" />
<Item label="Disabled - Single Tap To Last Brightness" value="1" />
<Item label="Disabled - Single Tap To Max Brightness" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="15" label="Enable/Disable Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or disable local on/off control. If enabled, light will only be able to be controlled via Z-Wave.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
</CommandClass>
```
For Zooz switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
```xml
<CommandClass id="91" name="COMMAND_CLASS_CENTRAL_SCENE" version="1" request_flags="4" innif="true" scenecount="0">
<Instance index="1" />
<Value type="int" genre="system" instance="1" index="0" label="Scene Count" units="" read_only="true" write_only="false" verify_changes="false" poll_intensity="0" min="-2147483648" max="2147483647" value="2" />
<Value type="int" genre="user" instance="1" index="1" label="Bottom Button Scene" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="-2147483648" max="2147483647" value="3" />
<Value type="int" genre="user" instance="1" index="2" label="Top Button Scene" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="-2147483648" max="2147483647" value="3" />
</CommandClass>
```
Go to the Z-Wave Network Management section in the Home Assistant Configuration, select the node which has just been updated and enable the scene support configuration paramter.
Once this is complete, you should see the following `zwave.scene_activated` events:
**Action**|**scene\_id**|**scene\_data**
:-----:|:-----:|:-----:
Single tap off|1|7680
Single tap on|2|7680
Double tap off|1|7860
Double tap on|2|7860
Triple tap off|1|7920
Triple tap on|2|7920
4x tap off|1|7980
4x tap on|2|7980
5x tap off|1|8040
5x tap on|2|8040
### HomeSeer Switches
For the HomeSeer devices specifically, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following: