https://github.com/joelwetzel/Hubitat-Cooper-Aspire-Scene-Controller
Cooper Eaton Aspire RFWC5 RFWC5D Keypad driver for Hubitat
This is a Hubitat driver for the Cooper Eaton Aspire RFWC5 and RFWC5D 5-button keypads. These are in-wall z-wave scene controllers, but this driver allows them to be used as keypads for a variety of purposes.
Supported Devices
- RFWC5 - This is the easiest to find. It can easily be purchased online. However, its design has wavy curves that you may or may not like. https://www.amazon.com/Eaton-RFWC5AW-ASPIRE-5-Scene-120-volt/dp/B0053ZIRWK
- RFWC5D - This is my favorite. It's the Decorator Series model. It looks rectangular and subtle, and matches Decora switches nicely. However, it is difficult (but not impossible) to find or order without being an electrical contractor. http://www.cooperindustries.com/content/public/en/wiring_devices/products/lighting_controls/aspire_rf_wireless/aspire_rf_5_button_scene_control_keypad_rfwdc_rfwc5.html
Physical Device Behavior
The physical keypad has 5 main buttons with indicators. Pressing a button causes its indicator to toggle, and a z-wave message is sent to the hub, which can then determine what all the indicator states are.
There is also a 6th button. If held for a few seconds, all the lights will flash and then every button will turn off. This also sends a z-wave message to the hub, indicating that all buttons are off.
(The keypad is also capable of being associated to other z-wave devices. However, I do not find this useful, since then the hub is unaware of what is happening. So my driver disables that, and all messages go through the hub.)
Behavior Virtualization
This is where the magic happens. To a passer-by, the keypad looks and behaves like 5 toggle switches. They are toggled by pressing the buttons, and the lights indicate if each of the switches is on. So we can use child virtual devices in the Hubitat hub to make it look like 5 switches to other apps and automations. It becomes easy to use Rule Machine, Switch Bindings, or other automation apps to drive behavior based on keypad presses.
In fact, because the hub can also control the indicator states, we can give the keypad even more complex behaviors than just "5 switches", and expose those behaviors as child virtual devices that match common capabilities.
Currently, this driver has 3 modes:
- Configure Children as Virtual Switches (This creates 5 virtual switches as child devices.)
- Configure Children as Virtual Fan Controller (This creates a virtual fan controller and one virtual switch as child devices. Then the keypad can be used to control a Hampton Bay Zigbee Fan Controller with Light, or control a GE Fan Controller and a GE Light Switch, or other smart devices that implement the "Fan Control" and "Switch" capabilities.)
- Configure Children as Virtual Button (This creates a Virtual Button - with 5 buttons - as the child device.)
General Installation
The following steps should be followed, no matter which mode you are going to use.
The best way to install this code is by using Hubitat Package Manager. If you use HPM, you can skip down to step 6 after installing the package.
- On the Hubitat hub, go to the "Drivers Code" page
- Click "+New Driver"
- Copy in the code from RFWC5-Keypad.groovy
- Click "Save"
- Repeat these first 4 steps for the files RFWC5-VirtualSwitch.groovy and RFWC5D-VirtualFanControllery.groovy. When you are done, you should have a total of 3 new drivers in your "Drivers Code" page.
- Wire up your RFWC5 keypad in the wall.
- Perform a factory reset on the keypad. Do this by pressing and holding buttons 1, 3, and 5 for 5 seconds at the same time. Release the buttons. Then press and release the ALL OFF button. If successful, all 5 LEDs should blink.
- Join the keypad to your z-wave network. On the "Devices" page of Hubitat, click the Discover button, then press the ALL OFF button on the keypad.
- On the device page in Hubitat, change the device's Type to "Cooper RFWC5 Keypad" and click "Save Device".
- Refresh the page.
- Click the "Save Preferences" button and then click the "Configure" command button. This will send a bunch of configuration commands to the keypad. It will take several minutes. You can watch the progress by going to Hubitat's "Logs" page.
- When it is finished, you can do some minimal testing. Press buttons on the keypad. On the device page in Hubitat, in the "Current States" section, you should see the value of "Indicators" update to show which lights are turned on. If this works, proceed to one of the next scenarios.
Configuration Scenario 1 - Virtual Switches Bound to Other Lights and Switches
This is my main use case. I have three smart lamps in my living room, and they didn't have switches on the wall. I could control them through an app, or through Alexa, but visitors to the house didn't know what to do with them. By installing an RFWC5D in the living room wall, there is now a simple and discoverable physical control for them.
- Open the Hubitat device page for the keypad.
- Click the command "Configure Child Devices As Virtual Switches" It will take 3-5 seconds, and then you should see that the value of VirtualDeviceMode is "virtualSwitches".
- Refresh the page.
- Now if you scroll down, you should see 5 component devices. They are virtual switches, and the driver will keep them exactly in sync with the lights on the keypad. (It is a bi-directional sync too, which will be important in a moment.)
- Now, we want to make those virtual switches control some real devices. You could do this with Rule Machine, but my Switch Bindings app was made specially for doing this in a fast, simple, and reliable way. If you haven't already, install the Switch Bindings app from here: https://github.com/joelwetzel/Hubitat-Switch-Bindings
- In Switch Bindings, create up to 5 bindings. In each one, bind one virtual switch from the keypad to the real smart device you want it to control. In my case, I bound each of the first three virtual switches to one of my smart lamps.
Result: You should now be able to press the buttons on the keypad to toggle your bound switches/lamps on and off. Also, because Switch Bindings app is bi-directional, and the virtual switches are bi-directionally synced with the keypad indicators, if you use another means (such as Alexa or scheduled Scenes) to turn the lights on and off, the keypad indicators will stay in sync with what the devices are doing. All the binding is fully bi-directional.
Configuration Scenario 2 - Virtual Fan Controller and One Virtual Light Switch
This is useful for 2 sub-scenarios:
- With the release of the Hampton Bay Zigbee Fan Controller (https://www.homedepot.com/p/Hampton-Bay-Universal-Wink-Enabled-White-Ceiling-Fan-Premier-Remote-Control-99432/206591100), there is now a smart device that control both a fan, as well as the light in the fan. However, it just has its own remote. What if you want to control it from a decora-style wall control?
- People have also done something similar by hiding a GE Fan Controller and GE Light Switch (or equivalent micro devices, such as the ones by AEOTEC) up in the fan shroud.
In either of these cases, you end up with two smart devices in Hubitat that we want to control: A Fan Controller, and a Switch. In Scenario 2, we are going to expose the functionality of the RFWC5 Keypad as a virtual fan controller and virtual switch, that can then be bound to the actual fan controller and switch.
- Open the Hubitat device page for the keypad.
- Click the command "Configure Child Devices as Virtual Fan Controller" It will take 3-5 seconds, and then you should see that the value of VirtualDeviceMode is "virtualSwitches".
- Refresh the page.
- Now if you scroll down, you should see 2 component devices. One is a virtual fan controller, and one is a virtual switch.
- Now, we want to make those virtual switches control the real devices. You could do this with Rule Machine, but my Switch Bindings app was made specially for doing this in a fast, simple, and reliable way. If you haven't already, install the Switch Bindings app from here: https://github.com/joelwetzel/Hubitat-Switch-Bindings
- In Switch Bindings, create 2 bindings. Bind the Virtual Fan Controller to the real fan controller. Bind the Virtual Switch to the real light switch for the fan.
Result: The bottom button (button 5) on the keypad behaves as a switch for the fan light. The next button up is Fan off. Then buttons 3, 2, and 1 are Low, Medium, and High respectively. You'll notice that only one of the fan lights will be on at a time. Also, this binding is also bi-directional. If you use Alexa or a scheduled routine to alter the fan light or the fan speed, these changes will be reflected in the keypad's indicator lights.
Configuration Scenario 3 - Virtual Buttons
Rather than exposing the keypad as 5 switches, this exposes it as 5 buttons. The default state of the keypad will be to have all the lights turned off. If you press buttons, the lights come on for just a second, and then turn off again, but virtual button presses happen in Hubitat.
- Open the Hubitat device page for the keypad.
- Click the command "Configure Child Devices as Virtual Button" It will take 3-5 seconds, and then you should see that the value of VirtualDeviceMode is "virtualButton".
- Refresh the page.
- Now if you scroll down, you should see 1 component device - a Virtual Button. (Hubitat allows more than one button inside a single "Virtual Button")
- Now I recommend using the built-in Button Controllers app in Hubitat. You tell it to watch the Virtual Button, and then assign actions for when buttons 1-5 are pressed. (Such as toggling lights or activating scenes.)
Acknowledgments
Many thanks to Scott Ainsworth for figuring out the z-wave configuration steps for the keypads. I borrowed the configuration code from his original driver for SmartThings: https://github.com/saains/SmartThingsPublic/blob/master/devicetypes/saains/cooper-aspire-scene-controller-rfwc5-rfwc5d.src/cooper-aspire-scene-controller-rfwc5-rfwc5d.groovy
