current device handler: 1.7.4, updated: 28/03/2017
current smartapp: 1.6, updated: 25/01/2016
What you can do with this
This allows you to correctly set up Z-Wave.me, Popp, & Devolo Wall controllers and Key Fobs. The Device type alone will mean that they work as you (& ST!) would expect and plays nice with other apps, and if dimming is important to you this accompanying app will allow you to have dim events performed whilst rocker switches are held down. Other actions (like double clicks and click-holds) can be used with the Smartapp as well as CoRE.
Some info on the Wall Controllers
These wall controllers are very cool. You can buy the inside part, cover plate, and rocker switches separately, so you have a hell of a lot of flexibility in terms of how they end up looking. For example, the ones I use around my house have a white glass cover plate and chrome buttons. It looks super modern and I haven’t seen any nicer solution than this for versatile wall controllers, other than some products from Aeotec that have been announced but are not available for purchase yet. Also you can buy one big rocker paddle, or two smaller rocker paddles and it will work with both styles.
Some info on the Key Fobs
These are small Z Wave plus key fobs with 4 buttons that are a great size - they have the exact same functionality as the wall controllers (same 4 buttons), except you can take them around with you in your pocket!
Set up
1. To get your controllers working with ST
- Read instructions! and put device into inclusion mode (slightly different for each of these otherwise I would put how here). ST should see the device and call it “Secure wall controller for…” etc [Device handlers 1.6.1 and below will see “Z-Wave Device” or something generic like that]
- [If you are on 1.6.2 device handler or above and the device was recognised correctly then you can skip this step] Go to IDE and assign the Device type below to the device
- Go into the device page on your app
- put the device back into inclusion mode
- hit the “configure” button in the app
- The light on the controller should go a bit nuts red/green flashing.
- Wait at least 30sec after the flashing stops, take battery out of the device and then put back in (no idea why this makes a difference but it seems to increase the chance that the configuration holds)
Now your device is set up. If you don’t care about dimming whilst you hold the buttons, then you can stop here. The device will register as a proper controller with the official Button Controller app, Smart Lighting, Rule Machine, CoRE and anything else that it should.
2. Getting dimming events to run
- Install the provided app
- For each switch that you would like to configure, open the app from marketplace (as it will save a new instance for each switch)
- On the first page name the configuration and apply your desired settings
- The next 4 pages allow you to decide what happens on: button press, button short hold (ST type holds), continuously (fired every 1s) whilst a button is held down - 1 page for each button.
- Actions that can fire on the above button trigger types are: set a switch to toggle on a button press, trigger a routine on a button press, trigger either a switch to toggle or a dim up or down event when you do a long hold [IMPORTANT NOTE: this is the Smartthings understanding of a long hold not a whilst held event - this will only trigger once], trigger a dim up or down event to repeatedly fire every second whilst a button is held [ This is the proper dimming function that I have only seen here so far on ST], Trigger an event to fire on hold release
The main reason to use the app is to get the dimming feature, but I have added in a few other actions as well. If you need more actions please use this app in conjunction with SmartLighting, Rule Machine or better yet CoRE as they can handle other actions for the button presses anyway
3. Double Clicks
From version 1.4 onwards, thanks to @Fuzzyligic we now have double clicks. These can be utilised using the Smartapp. Smartthings does not officially support Double Clicks yet - However, I have included a temporary work around to allow you to use double Clicks with other SmartApps using the mapping below in section 5. I have also made a special integration with CoRE so that you can select double clicks under attributes → Button Events.
4. Click - Holds
From version 1.5 onwards, thanks to @milesfrankland we now have click-holds. You can set actions for the click-hold start, and the click-hold release. I have not added the ability to perform dimming actions whilst the click hold is held because I couldn’t think of a use for it myself… but if anyone needs it, just let me know and I’ll add it. Click-Hold Start and Click-Hold stop events can be used with other SmartApps using the mapping and the CoRE integration same as (4.)
5. Mappings for use with other SmartApps
Mappings for other SmartApps work like this:
button pushed = button number pushed
button held = button number held
button double clicked = (real button number + 4) pushed
button hold stopped = (real button number + 8) pushed
button click-held start = (real button number + 4) held
button click-held stopped = (real button number + 8) held
This allows you to use this with Rule Machine properly (especially as Bruce just updated it to work with up to 20 buttons per device).
As an example for button 1 from a controller, used in a different SmartApp e.g. Rule Machine:
button 1 pushed = button 1 pushed
button 1 held = button 1 held
button 1 double clicked = button 5 pushed
button 1 hold stopped = button 9 pushed
button 1 click-held start = button 5 held
button 1 click-held stopped = button 9 held
6. CoRE Integration
From DTH version 1.7 onwards you can now directly use any type of button action (push, hold, double click, hold release, click hold, click hold release) straight from CoRE by using the attribute → Button Events whilst setting up a trigger / condition.
Important info if you still use version 1.0
If you are upgrading from version 1.0, you may find that you need to do a full delete and reinstall for each switch to upgrade.
Furthermore, if you were using the virtual device from version 1.0 as a grouping method, but still want to have groups after upgrading - I would suggest using this fantastic smartapp from @Kriskit here which is a much more robust grouping method anyway.
Device type:
SmartApp:
###Z-Wave.me Wall Controller v1 & v2:
###Z-Wave.me Key Fob:
###Various cover plates and rocker paddle options for wall controllers / switches:
if i had used your code first i would have saved me quite some time.