[RELEASE] Zooz ZEN Switches Advanced Drivers

jtp10181 · February 1, 2021, 3:02pm

I found this really well made driver for ST (some appear to be official Zooz driver) and decided to port it over to Hubitat. The original ST driver(s) are linked in the source code. The other community advanced drivers for the ZEN switches do not appear to be getting updates anymore.

Reporting Issues
Please use GitHub to report any issues so each one can have its own conversation and tracking. Please provide as much info as you can including model, firmware and the "configVals" data string. Issues · jtp10181/Hubitat · GitHub

If you are using this driver PLEASE like this post so I can get an idea of how many people are using it. It will motivate me to make more/better contributions as well.

Supported Models [v1.4.2]:

ZEN21 Switch - Min Firmware 3.04
ZEN22 Dimmer - Min Firmware 3.07
ZEN23 Toggle Switch - Min Firmware 3.05
ZEN24 Toggle Dimmer - Min Firmware 3.08
ZEN26 Switch - Min Firmware 2.03
ZEN27 Dimmer - Min Firmware 2.08
ZEN71 Switch (700 Series) - All Firmware
ZEN72 Dimmer (700 Series) - All Firmware
ZEN76 Switch (700 Series) - All Firmware
ZEN77 Dimmer (700 Series) - All Firmware
ZEN30 Double Switch - All Firmware

Minimum Firmware
The driver should still work if you are below the min firmware but you may have a permanent "Pending Changes" status message due to new parameters that your older firmware does not support. Use Param Commands > Test All to test and hide the unsupported parameters.

Features:

Supports all security up to S2
All configuration variables available with designated defaults per Zooz docs
All Association Group settings are available - check Zooz docs for specifics
Scene Functions matching Zooz docs (10 unique actions) - MUST Enable Scene Control parameter on some models
Will be posting how to use the Scene Functions with RM in the GitHub Docs (stay tuned)
Brightness Correction - allows you to set min/max brightness but it will display as 1-100% on your dashboard!

For more info on the advanced settings and button mapping check the Zooz Support Documentation. Select your switch model > Z-Wave Questions > Advanced Settings (bottom right corner)

IF YOU SWITCH FROM ANOTHER DRIVER check your Auto-On/Off parameters as they may be shown and saved incorrectly after switching. Recommended to PRESS CONFIGURE and check all your parameters after any driver changes.

You can find all the drivers on the Hubitat Package Manager or at the below link

General Changelog:
Check driver source for more specific driver info

github.com

jtp10181/Hubitat/blob/main/Drivers/zooz/CHANGELOG.md

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.4.2] - 2021-01-31 (@jtp10181)
  ### Added
  - Command to change indicator color (can be used from Rule Machine!)
  - New method to test the params and find the ones that dont actually work
  - Command button to remove invalid parameters
  ### Changed
  - More cleanup and adding some comments
  - Consolidated parameters related commands
  - Changed ZEN30 from Multi Channel V3 to V4
  - Send events to child as parse so it can handle its own logging (ZEN30)
  - Moved Refresh Params to its own command
  ### Fixed
  - Scene reverse setting was reset to default after running configure

This file has been truncated. show original

Donations: Since it has been asked more than once, here is a link for donations

eppower · December 11, 2020, 9:57pm

Will you be adding this to Hubitat Package Manager? Super-excited to try an up-to-date driver for all my Zen27s. Thanks for posting this work @jtp10181!

jtp10181 · December 11, 2020, 10:00pm

Yes as soon as I figure out how! I just was excited to finally be happy with this to post it. Now I will see about the package manager later, and also my next will be the ZEN21 since I have a couple of those. I don't have any of the other switches but I should be able to use this as a base and figure the others out. If anyone has requests for other Zooz switch models let me know so I can prioritize.

eppower · December 11, 2020, 10:32pm

Zen26, please! This should be simpler, since it's not a dimmer. Once you have Zen26/27, I'm assuming those will likely be easily converted to the Zen23/24 models, which I think are only cosmetically different (toggle switch design vs the paddle used for the 26/27s).

eppower · December 11, 2020, 10:44pm

Doesn't seem to register button 1 or button 2 events for me in smart bulb mode...

jtp10181 · December 12, 2020, 1:35am

Buttons 1 and 2 are the same as on/off. If you want it actually trigger the 1/2 button pushes the "Scene Control" needs to be enabled. Otherwise it only will send the on/off events.

You should be able to make a rule like this without the scene control

steve.maddigan · December 12, 2020, 6:06pm

Hi. Just curious why you decided not to implement parameter 7.

Why I ask is I am now using @bcopeland drivers and i do have two different associations set up (on two pairs of zen26’s, not zen27s) but I limit the association to paddle press only.

In my case this was the only way to get the second zen26 to turn on 100% of the time with the first being pressed. If I use a button controller to turn on the second it operated 75% at best. The other 25% it would flash on and then go back off.

jtp10181 · December 12, 2020, 8:40pm

Hi. Just curious why you decided not to implement parameter 7.

It was not in the original ST driver and it has a mile long list of options, I just didn't know if it was worth adding. I was thinking about just maybe adding it with just the setting numbers in the dropdown with a note to see the Zooz docs for starters. I will try and add it later today for you. I know the bcopeland driver had multiple associations boxes also, do you use those also or does just the one work? I am new to ZWave so I am not totally sure how all that works yet.

steve.maddigan · December 12, 2020, 8:48pm

Wow. Thanks for the reply. I first tried associations about two months ago so I am brand new to that topic. There are multiple association groups which I will not pretend to understand. I am using the simplest association and had to enter the DNI of the other switch under Group Two Association.
I will have to do more reading of the Zooz doc to understand more about it.

Again, I am only using this on my zen26s. Sorry to hijack your Zen27 driver thread. For instance this switch I have listed the device 3C as the association device but it doesn’t not show up under the settings.

jtp10181 · December 13, 2020, 2:53pm

Just an update, I am trying to work out a combo ZEN21/26 driver right now, they are nearly identical except for a few of the parameters. I have a ZEN21 to test on. Also added in Parameter 7 and also will be coming to ZEN27. I plan on using this one post for all the Zooz switches, will all be one "package" in the Package Manager once my repo gets merged in (would be already if I didn't mess up my pull request).

steve.maddigan · December 13, 2020, 7:07pm

Just to throw it out there. Is the Zen22 similar to the Zen27 from a driver perspective?

I have all four types and using Brian’s drivers for all of them.

jtp10181 · December 15, 2020, 2:54am

Going to work on the ZEN22 now, if it is similar to the 27 should have it posted tonight or tomorrow AM.

UPDATES: Updated ZEN27, added ZEN21 and ZEN26. Because Zooz had the version starting with the current hardware version I decided to just reset them all back to a base of 1.0.0 and start clean, so now they will all be in sync and are at 1.1.0. If you had ZEN27 installed already you might have to run a "Repair" in the package manager to force the current version, should not be an issue going forward. ZEN26 is untested as I don't have one, let me know if any issues. It is nearly identical to the ZEN21 which I did test so I suspect it will work fine.

@steve.maddigan Added ZEN22 just now, if you run an update on package manager it should pick it up, it did for me anyway.

jtp10181 · December 19, 2020, 1:36am

UPDATE for all drivers:
Added Group 3 Associations
Added support for ZEN23 and ZEN24

dsegall · December 20, 2020, 12:49am

I installed these, and I noticed that the Zen27 driver corrects for a firmware bug in version 3.01. The problem is that this bug exists in all versions after 3.01 as well, so line 649 should be:

if (Float.parseFloat(device.getDataValue("firmwareVersion")) >= 3.01) {

The same change should be made to line 628 of the Zen22 driver.

jtp10181 · December 20, 2020, 2:25pm

They have their original switches one major version ahead of the S2 switches, so on the ZEN22 it probably only effects 4.01. I dont have one of those to test on. They sent me a pre-release 3.03 for the Zen27 and I confirmed that it is switched back (fixed). You should be able to just copy that code into the ZEN22 for now and change the version number check. I will add it on my next version.

dsegall · December 20, 2020, 2:57pm

I've been back and forth with them on this topic for a while. I've played around with various firmwares that either do or do not fix it on different hardware (I have Zen21, 22, and 27 in various locations).

They told me that they are not sure which way they are going to go in the future because they are afraid of breaking existing integrations that rely on the buggy behavior, but they plan to add a config parameter to the firmware in the February release to tell the switch which scene number to send for each paddle.

jtp10181 · December 23, 2020, 4:50pm

UPDATE
Posted version 1.3.0, changelog in first post.

A little extra info on the new Brightness Correction setting (defaults to off, enable the setting to try it). The LED bulbs I have the useable dimming range is between about 20-70%, anything below is off and above is full bright (to my eyes). It was annoying me that when maxed out to my max setting it would show 70% on the dashboard. So I worked out a little formula to convert back and forth between the set level and the displayed level. If you enable to the new setting and have a min/max set it will do the conversion automatically. Example, min=20 and max=60: normally if you set 50%, the dimmer gets set to 50%, which is very close to the max, so probably almost fully bright. With this new setting the formula converts your setting of 50%, and actually sets the dimmer to 40% which is halfway between the min and max.

//This converts what the user selected into a physical level within the min/max range
level_dimmer = ((brightmax - brightmin) * (level_displayed/100)) + brightmin

//This takes the true physical level and converts to what we want to show to the user
level_displayed = ((level_dimmer - brightmin) / (brightmax - brightmin)) * 100

You can check the event logs to see the displayed level vs the actual level being set

chrismccracken · December 23, 2020, 5:27pm

Hey Jeff, thanks a lot for building and sharing this! I installed it yesterday for 2 ZEN21 and 2 ZEN22 switches and it solved a lot of problems for me. I'd love to help out and cover your cost for a ZEN30 double switch if you're interested in adding that to the library, do you have donations set up anywhere?

jtp10181 · December 23, 2020, 5:42pm

Great to hear it helped solve some issues, I love coding and I love sharing my work.

I was actually thinking about possibly getting a ZEN30, I just got done installing my first round of stuff and I have to plan out my next batch and what I can afford. Started out with 7 switches which covered almost the whole first floor.

I see the same person who I ported the drivers from for these other switches also has the ZEN30 and lots of other Zooz stuff in another folder on his GitHub. So I should be able to port that over and merge in all my changes as well.

Here is a PayPal link if desired: http://paypal.me/JPage81

KvTobola · December 23, 2020, 7:52pm

Are there any plans to implement driver support for the Zooz Zen25?