Intermatic-PE653 SmartThings Z-Wave Device Type for the Intermatic PE653 Pool Controller

Overview: This is a Groovy "Device Type" for the SmartThings home automation platform which supports the Intermatic PE653 Z-Wave Pool Control system. This code is an enhancement on an original work by @bigpunk6. See below for features.

Current Author: @KeithR26

Original Author: @bigpunk6 Full credit goes to bigpunk6, without whom this derivation never would have come to light.

Release Notes, Version 3.00 07/05/2018:

1. Major update. In 2017 SmartThings withdrew the "Multi-channel SmartApp" which provided important functionality to the PE653 Device Type Handler (DTH). This is what allowed each of the 5 switches, Pool/Spa mode and VSP Speeds to be represented as simple individual switches in the "Things" page of the ST mobile App. SmartThings now recommends the "Composite Device Type" model which implements the "Child" switches as part of the DTH without requiring a separate SmartApp. It does however require configuring a second Device Handler to support the Child switches. This however is a simple one-time setup that is covered in the Installation Instructions (https://raw.githubusercontent.com/KeithR26/Intermatic-PE653/master/Installation.txt)

The DTH will create at least 5 Child devices corresponding to the 5 switches. If your device is named "Pool Controller" then the Child devics will be named: Pool Controller - Switch 1 Pool Controller - Switch 2 Pool Controller - Switch 3 Pool Controller - Switch 4 Pool Controller - Switch 5

If you have both Pool and Spa, then you will also get a Child Device: Pool Controller - Spa Mode

If you have a Variable Speed Pump (VSP) then you will also get: Pool Controller - Speed 1 Pool Controller - Speed 2 Pool Controller - Speed 3 Pool Controller - Speed 4

You are free to rename these Child Devices. Then yiou can use these Child Devices in ST SmartApps and in Alexa integration.

2. The VSP and Pool/Spa mode implementation was kludgy because the means of setting these modes is undocumented by Intermatic. The initial implementation turned VSP and Pool/Spa schedules on and off to control those modes, but this was incompatible with the PE953 remote which caused unexpected behavior and meant the ST App could not override settings made by the remote. As a result of implementing a Z-Wave sniffer I was able to trace the actual messages the remote sends to the controller to reverse engineer the undocumented commands. As a result I was able to scrap the schedule based implementation and directly control the modes in the same way as the remote does it. This means the ST app can read the current speed and Pool/Spa settings even if they are sset by the remote or even on the 653 controller itself.

3. The sniffer also uncovered how Intermatic is using the "Manufacturer Proprietary" Z-Wave commands to read values for the Air Temperature, Heater mode on/off and the Controller's clock. To display this information in a balanced and esthetic format I adjusted the layout to be more efficient and usable. Let me know your thoughts.

4. Removed the Settings/Preferences "default" values so that the Android configuration can be saved. The user was required to "set" the values manually anyway, so the default was just misleading. Be sure to set all the Preferences to reasonable values.

5. A few minor changes were made to improve compatibility with Hubitat. More changes will likely be necessary however.

Release Notes, Version 2.03 05/01/2017:

1. You can now quickly and easily refresh the water temperature display by tapping the temperature display. Unlike the "refresh" botton, which issues about a dozen commands and takes some time, tapping the temperature only sends the requst to refresh the temperature display, therefore it is much faster. The temperature is also refreshed whenever you use any of the four macro buttons. Still no luck with the poll().

Release Notes, Version 2.02 04/26/2017:

1. This release Fixes a nasty bug and adds two new features. Many have experienced the issue with using this DTH on version 3.4 of the Intermatic firmware and found that the handler is unable to change the temperatures of either pool or spa thermostat. The code used to work on prior versions of firmware, but Intermatci introduced some change in v3.4 where it rejects the request sent by the prior versions of this code. By using a Z-Wave sniffer I was able to identify how the PE953(remote) sent its request and adapt to that format. It had to do the "scale" (Celcius vs Farenheit). It was a simple change once I saw what their remote was sending, but literally took months to get a sniffer operational.

2. I recently installed Pentair color LED pool and spa lights. They are connected to my Sw3 and Sw5 circuits so I could turn them on or off remotely, but not change the color. I've been experimenting with an ability to change the color programtically. It is not bullet proof but seems to work pretty well. You configure which circuits control lights in the "settings" and select the color "mode" at the bottom of the app main screen using a new slider. Then by pressing on the "color x" button to the right of the slider, you can pulse the configured circuit to set the light mode. For more info on the light mode, see the Pentair info on their lights online.

3. I added a basic macro capability to the app. I know, some of you are saying why? You can just use the CoRE platform to build any complex macro you want. Yes, I've done that for my own setup and it works great, but it is beyond the more casual user who may not understand constructing logic trees. For the rest, there is now a very simple way to configure up to 4 macros. This is done in the "Settings". You'll see 4 sections, each begins with M1, M2, M3, M4 respectively. For each macro, you can choose which circuits to turn on/off, which mode to put the pool into (pool/spa), the temperature to set the heater, and a VSP speed to select. For each of these settings you can also choose "no change" for any of the settings and it will not alter the current setting. You can also "name" each macro and this name will appear on the app. I set up four macros: "Spa Time", "Normal Pool Mode", "Everything off", and "Do nothing" (just for testing purposes). Once you have made your selections, just tap the macro name (or switch to its left) and the actions configured in the settings will be processed. Be patient. That's a lot of Z-Wave commands, and they have to be spaced out at the 1000ms interval or the PE653 will drop some of them. Of course you can play with that interval in the settings as well, but I have not had much consistent luck very far below 1000.

As always, let me know of any issue you find. (Keith)

Release Notes, Version 2.01 08/10/2016:

1. This release delivers a major UI redesign. The Thermostat control was overly large while providing limited utility. As I added 9 buttons for the pool circuits and VSP speeds the UI had gotten disorganized and long, requiring scrolling. I took some inspriration from the PE953 remote, which lists the 5 pool circuits across the top. I opted for small buttons to enable a compact, single page display format. I'm hoping everyone is ok with the button size. Note that the one remaining large button is to the left of the pool temperature. The button only appears if you have "both" pool & spa, othewise the button is hidden. Similarly, if you have a VSP, then four small buttons appear to the right of the temperature, otherwise they are likewise hidden. The "Power" controls are removed as they did nothing. The Speed slider now supports a "zero" value which will turn off the VSP (assuming it was turned on by this app). You can now choose an alternate icon for the app amd change pool/spa mode on the "Things" page.

2. Extended the "Pump Type" configuration to add options for VSP. If you have a VSP it is important to set this using the settings "gear" to enable the VSP buttons. So far I cannot detect whether or not the PE653 has a VSP since it appears to be dynamically detected, and does not appear on a configuration page that I can see. Someday I hope to detect this from the controller.

3. Changed the ST "things" exposed by the Multi-channel SmartApp for the VSP from a "dimmer" to four separate on/off switches (Switch Endpoint 7-10) corresponding to the four speeds. These switches, as well as the four VSP buttons on the main UI function as "radio buttons", meaning that selecting any one of them deselects any other button that was previously on (only one on at a time). If you deselect the switch or button that is on, then the VSP is deselected and will turn off, if enabled by this app.

4. Added commands to interrogate the version info from the PE653 and display it in the IDE in the device info.

5. A new option has been added to allow configuring the delay between Z-wave commands. The default is 1000 milliseconds. This was the fixed value used in the previous version. Initial tests I have done suggest this could be much small, which will improve respobse time, but if too small may compromise reliability. For the adventurous, feel free to trying reducing this delay and see how far toward zero you can get.

6. Added a diagnostic mode (Debug Leve = High) which attemppts to interrogate every PE653 configuration page and displays this information in the logs. This causes a lot of message traffic so don't enable High level for an ongoing basis.

7. If you are using the ST Multichannel SmartApp, this version requires that you remove then reinstall that SmartApp in order for it to recognize the new endpoints. The 10 endpoints now implemented are as follows: Switch Endpoint 1 --> Pool Circuit #1 Switch Endpoint 2 --> Pool Circuit #2 Switch Endpoint 3 --> Pool Circuit #3 Switch Endpoint 4 --> Pool Circuit #4 Switch Endpoint 5 --> Pool Circuit #5 Switch Endpoint 6 --> Pool / Spa mode toggle Switch Endpoint 7 --> VSP Speed 1 Switch Endpoint 8 --> VSP Speed 2 Switch Endpoint 9 --> VSP Speed 3 Switch Endpoint 10 --> VSP Speed 4

After you reinstall the ST Multichannel SA you are free to rename the endpoints or even remove unwanted endpoints. Note: You are not required to install the Multichannel SA if you only instend to use the DTH UI and don't want to see the Endpoints in the "things" list.

Release Notes, Version 2.00 07/14/2016:

1. The main issue I battled with the original code is that it did not seem to work with my firmware level (v3.4). This may be due to changes made by Intermatic since the original @bigpunk6 version. Clearly the original code worked for some people. This conjecture is further supported by the fact that the Vera users group has also been unable to work with v3.4. For my version of firmware I found that it did not support the Z-Wave Multichannelv3 Command Class (0x25 version 3 in particular). My firmware does support v2 of Multichannel. Specifically I had to implement zwave.commands.multichannelv3.MultiInstanceCmdEncap instead of zwave.commands.multichannelv3.MultiChannelCmdEncap. I further verified this by polling the PE653 for its supported version level for Multichannel and it does in fact report v2.

2. I noticed that a very early version of bigpunks code directly implemented switches in the device type. Later he removed these in favor of supporting the multichannel SmarApp, which is avery cool feature by the way, and crutial for allowing fine grained control of the different circuits by SmartThings routines and SmartApps. I liked both options so I added the 5 switches back in and added support to send the necessary events to both the internal switches as well as the multichannel "virtual switches" which appear separately on the "things" tab after you install the ST Multichannel SmartApp. bigpunk6 is absolutely right here, don't add the @cooperslee apps, this device type directly supports adding the "things".

3. I needed support for switching between pool and spa modes. Although I did find some documentation on the commad classes implemented by the PE653 and the configuration parameters it suports, I never found a documented way to control the "mode". I came up with a back door approach of modifying the "PS Schedule" in real time to basically reconfigure the controller to be in Spa mode from 12:01 AM through 11:59PM when I want the Spa on, and resetting the schedule back off when I want pool mode. Although it is documented that the controller supports three schedules for each "switch", I discovered by trial and errors that there are another 3 for the pool/spa schedule control (config parm 19-21). I added a pool/spa "switch" which sends the configuration commands to enable/disable this schedule. I also added a "Switch Endpoint 6" to the Things so you can control it elsewhere in ST.

4. I don't have a Variable Speed Pump (VSP) but I know others (like @JDogg016) do and have been desparate for a way to control it. Since I don;t have one I can't test this directly but I did add code and controls to try this indirectly. I took a similar back door approach as the pool/spa method above. There are 4 sets of 3 schedules for each of the 4 speeds of the VSP. I added a slider control with values from 1-4. Depending on which speed you set it will set the third schedule for that speed to "always on" (12:01 AM - 11:59PM). I believe this has a reasonable chance of working, but I will need feedback and log results to validte this. I also added a "Dimmer Endpoint 7" for external ST control. There are very likely bugs in this area.

5. I observed that the PE653 advertizes support of a command class called "PowerLevel", which may be a mroe direct way of controlling the VSP. I added yet another slider for this called "power" that is worth trying. @JDogg016, give this a try as well).

6. While I was trying to troubleshoot my firmware version I needed to understand the command class supported versions so I added code to the "refresh" button to query all the supported command classes. The result is stored in the "state" variable which you can see in the ide if you look at the details of the device.

7. I added a lot to the logging in the device type so I can see better what is being sent to the device and what is coming back. You can control how much logging is done by a new configuration parameter in the deviice type. If you tap the settings icon in the upper right of the device type in the mobile app you will see a new parameter at the bottom called "Debug Level". You can set this to Off/Low/High. While troubleshooting, set this to High and this will create the most extensive logging data for viewing in the IDE.

Installation: The installation of this device type is exactly the same as the bigpunk6 version so I will not repeat the process of pairing and installing as this is covered extensively in the Community Forum. I wil just summarize the following:

1. Pair the controller to ST
2. Install the device type and assign it to the PE653 device
3. install the ST Multichannel SmartApp.
4. Set device configuration options (name, pump type, pool/spa, etc)
5. Set the Debug Level to Low or High.
6. Go into the IDE Live Logging on your computer. Filter the logging for only this device.
7. Exercise the device type, ideally while in view of the pool.
8. Take screen shots of the log data.
9. Post them on the forum if you have issues.

I can't promise to be super responsive but I'll do my best.

Known Issues:

• The code is not allowing me set the thermostats for the pool or spa. It reads them if I set them with the remote, but nothing I have done allows me to change the settings. I have not been able to crack this one.

• I am stil having some issues with the switches setting their state correctly in some cases. I can see that the events are firing but sometimes the switch in the mobile UI does not change even though the device does respond to the commands.

Disclaimers:

• This code should be considered experimental. It has only been tested by me and only for limited applications.
• If you have a working device type now, be very sure you save a backup copy of that code so you can easily backtrack if needed.
• This code was tested against Intermatic PR653 v3.4, and may not work appropriately against other firmware versions (even though I am hopefull it will work on prior firmware versions as well).