Update gocontrol-wireless-remote-switch.groovy

devicetypes/ajpri/gocontrol-wireless-remote-switch.src/gocontrol-wireless-remote-switch.groovy

@@ -1,7 +1,12 @@
-/**
- *  GoControl Wireless Remote Switch WA00Z-1
+/*
+ *  GoControl Wireless Remote Switch
+ * 
+ *  Contains code from https://github.com/nuttytree/Nutty-SmartThings/blob/master/devicetypes/nuttytree/ge-jasco-zwave-plus-on-off-switch.src/ge-jasco-zwave-plus-on-off-switch.groovy
+ *  Contains code from https://github.com/ajpri/ST-GoContWirelessSwitch/blob/master/devicetypes/ajpri/gocontrol-wireless-remote-switch.src/gocontrol-wireless-remote-switch.groovy
  *
- *  Copyright 2016 Austin Pritchett
+ *  Copyright 2020 Chris Nussbaum, Austin Pritchett, and updated by Tim Grimley
+ *  Thanks Austin for the original copy of this code, which was used as a template to make these updates.
+ *  Thanks Chris for association programming and double tap.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
  *  in compliance with the License. You may obtain a copy of the License at:
@@ -12,19 +17,32 @@
  *  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
  *  for the specific language governing permissions and limitations under the License.
  *
+ *	Author: Austin Pritchett, Tim Grimley
+ *	Date: 09/22/2020
+ *
+ *	Changelog:
+ *
+ *  0.11 (09/22/2020) - Initial Release Updated to Work with New Smartthings App, support double tap and associations
  *	
- */
-
- /*
- Version 1.2 - June 19th, 2017
- 	Exposed "Actuator" & "Sensor" Capability
- Version 1.1 - December 15th, 2016
-    Added Reverse Buttons functionality
-    Fixed Issues with some SmartApps
- Version 1 - April 12th, 2016
-    Initial Release
+ *   Button Mappings:
+ *
+ *   ACTION          BUTTON#    BUTTON ACTION
+ *   Single-Tap Up     1        pressed/held
+ *   Single-Tap Down     2        pressed/held
+ *   Double-Tap Up     3        pressed/held
+ *   Double-Tap Down   4        pressed/held   
+ *
+ *  Note - Central scene control still triggers on any double tap, ie doubletap up does trigger button 3, but also triggers button 1.  
+ *  Preferences can be updated to only send association commands, which would support double tap button 3 and 4, but disable button 1 and 2 
+ *  from scene control and smartapp use. Single tap Button 1 and 2 could then be used to trigger zwave devices in association group 2 directly only.
+ *  Possible solution to use all buttons and differentiate control is to use Webcore and set up a condition to trigger after single tap, 
+ *  wait a few seconds, check for double tap, and trigger different actions based on whether double tap was detected or not
+ *
  */
 
+import groovy.transform.Field
+import groovy.json.JsonOutput
+
 metadata {
 	definition (name: "GoControl Wireless Remote Switch", namespace: "ajpri", author: "Austin Pritchett") {
     	capability "Actuator"
@@ -33,6 +51,17 @@ metadata {
 		capability "Configuration"
         capability "Battery"
         capability "Sensor"
+        capability "Refresh"
+
+        attribute "inverted", "enum", ["inverted", "not inverted"]
+        attribute "controlled", "enum", ["both", "scene", "association"]
+
+
+        command "inverted"
+        command "notInverted"
+        command "controlBoth"
+        command "controlScene"
+        command "controlAssociation"
 
 
 		fingerprint deviceId:"0x1801", inClusters:"0x5E, 0x86, 0x72, 0x5B, 0x85, 0x59, 0x73, 0x70, 0x80, 0x84, 0x5A, 0x7A", outClusters:"0x5B, 0x20"        
@@ -56,7 +85,38 @@ metadata {
 	}
 
     preferences {
-        input name: "reverse", type: "bool", title: "Reverse Buttons", description: "Reverse the top and bottom buttons", required: true
+       input (
+            type: "paragraph",
+            element: "paragraph",
+            title: "Instructions:",
+            description: "Switch must be awake prior to setting. Press any button on switch prior to setting any option on this page. Press any button again once or twice after changing for them to program to the switch."
+       )
+
+        input  "invertSwitch", "bool", title: "Invert Switch", description: "Invert switch? ", required: false 
+      	input  "controlMode", "enum", title: "Control Mode (Default Both)", description: "Associaton and scene control... ", required: false, options:["both": "Send Both Scenes and Associations", "scene": "Send Scenes Only", "association": "Send Associations Only" ], defaultValue: "both" 
+
+      input (
+            type: "paragraph",
+            element: "paragraph",
+            title: "Configure Association Groups:",
+            description: "Devices in association group 2 will receive commands directly from the controller.  Press up or down for on off, hold up or hold down for brighten or dim. Use this to control another device as if it was connected to this switch.\n\n" +
+                         "Devices in association group 3 will receive commands directly from the controller when it is double tapped.  Press up or down twice for on off, press up twice and hold for brighten or down twice and hold to dim.\n\n" +
+                         "Devices are entered as a comma delimited list of IDs in hexadecimal format.  These will not work with send scenes only option, and will only work on other Zwave devices."
+        )
+
+        input (
+            name: "requestedGroup2",
+            title: "Association Group 2 Members (Max of 5):",
+            type: "text",
+            required: false
+        )
+
+        input (
+            name: "requestedGroup3",
+            title: "Association Group 3 Members (Max of 4):",
+            type: "text",
+            required: false
+        )
     }
 }
 
@@ -74,23 +134,39 @@ def parse(String description) {
 		if(!results) results = [ descriptionText: cmd, displayed: true ]
 	}
 	return results
+
+     if (!device.currentValue("supportedButtonValues")) {
+        sendEvent(name: "supportedButtonValues", value:JsonOutput.toJson(["pushed","held"]), displayed:false)
+    }
 
 }
 
-def zwaveEvent(physicalgraph.zwave.commands.centralscenev1.CentralSceneNotification cmd) {
-    Integer button   
-    if(reverse == true){
-    	if(cmd.sceneNumber == 1){
-        	button = 2
-        }else{
-        	button = 1
-        }
-        log.debug button
-    }else{
-    	button = (cmd.sceneNumber) as Integer
+def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicSet cmd) {
+    log.debug "---Double Tap--- ${device.displayName} sent ${cmd}"
+	if (cmd.value == 255) {
+    	createEvent(name: "button", value: "pushed", data: [buttonNumber: 3], descriptionText: "Double-tap up (button 3) on $device.displayName", isStateChange: true, type: "physical")
+    }
+	else if (cmd.value == 0) {
+    	createEvent(name: "button", value: "pushed", data: [buttonNumber: 4], descriptionText: "Double-tap down (button 4) on $device.displayName", isStateChange: true, type: "physical")
+    }
+ }
+
+ def zwaveEvent(physicalgraph.zwave.commands.switchmultilevelv3.SwitchMultilevelStartLevelChange cmd) {
+	 log.debug "---Double Tap and Hold--- ${device.displayName} sent ${cmd}"
+	if (cmd.startLevel == 0) {
+    	createEvent(name: "button", value: "held", data: [buttonNumber: 3], descriptionText: "Double-tap up and hold (button 3) on $device.displayName", isStateChange: true, type: "physical")     }
+	else if (cmd.startLevel == 255) {
+    	createEvent(name: "button", value: "held", data: [buttonNumber: 4], descriptionText: "Double-tap down and hold (button 4) on $device.displayName", isStateChange: true, type: "physical")
     }
-    	
+ }
 
+
+def zwaveEvent(physicalgraph.zwave.commands.centralscenev1.CentralSceneNotification cmd) {
+    log.debug "---Central Scene Command--- ${device.displayName} sent ${cmd}"
+    def button = []
+
+    button = (cmd.sceneNumber) as Integer
+
     if(cmd.keyAttributes == 0){
 		createEvent(name: "button", value: "pushed", data: [buttonNumber: button], descriptionText: "$device.displayName button $button was pushed", isStateChange: true)
     }else if(cmd.keyAttributes == 1){
@@ -113,6 +189,19 @@ def zwaveEvent(physicalgraph.zwave.commands.wakeupv2.WakeUpNotification cmd) {
     result
 }
 
+def zwaveEvent(physicalgraph.zwave.commands.associationv2.AssociationReport cmd) {
+	log.debug "---ASSOCIATION REPORT V2--- ${device.displayName} sent groupingIdentifier: ${cmd.groupingIdentifier} maxNodesSupported: ${cmd.maxNodesSupported} nodeId: ${cmd.nodeId} reportsToFollow: ${cmd.reportsToFollow}"
+    if (cmd.groupingIdentifier == 3) {
+    	if (cmd.nodeId.contains(zwaveHubNodeId)) {
+
+        }
+        else {
+			sendHubCommand(new physicalgraph.device.HubAction(zwave.associationV2.associationSet(groupingIdentifier: 3, nodeId: zwaveHubNodeId).format()))
+			sendHubCommand(new physicalgraph.device.HubAction(zwave.associationV2.associationGet(groupingIdentifier: 3).format()))
+        	        }
+    }
+}
+
 def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {    
     def result = []
 	def map = [ name: "battery", unit: "%" ]
@@ -129,18 +218,148 @@ def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {
 	result
 }
 
+def zwaveEvent(physicalgraph.zwave.Command cmd) {
+    log.warn "${device.displayName} received unhandled command: ${cmd}"
+}
+
 def configure() {
-
+    def cmds = []
+    // Get current config parameter values
+    cmds << zwave.configurationV2.configurationGet(parameterNumber: 2).format()
+    cmds << zwave.configurationV2.configurationGet(parameterNumber: 4).format()
+
+
+    // Add the hub to association group 3 to get double-tap notifications
+    cmds << zwave.associationV2.associationSet(groupingIdentifier: 3, nodeId: zwaveHubNodeId).format()
+
+    delayBetween(cmds,500)
 }
 
 def installed() {
 	initialize()
 }
 
 def updated() {
-	initialize()
+	if (state.lastUpdated && now() <= state.lastUpdated + 3000) return
+    state.lastUpdated = now()
+
+	def nodes = []
+    def cmds = []
+
+    if (settings.requestedGroup2 != state.currentGroup2) {
+        nodes = parseAssocGroupList(settings.requestedGroup2, 2)
+        cmds << zwave.associationV2.associationRemove(groupingIdentifier: 2, nodeId: [])
+        cmds << zwave.associationV2.associationSet(groupingIdentifier: 2, nodeId: nodes)
+        cmds << zwave.associationV2.associationGet(groupingIdentifier: 2)
+        state.currentGroup2 = settings.requestedGroup2
+    }
+
+    if (settings.requestedGroup3 != state.currentGroup3) {
+        nodes = parseAssocGroupList(settings.requestedGroup3, 3)
+        cmds << zwave.associationV2.associationRemove(groupingIdentifier: 3, nodeId: [])
+        cmds << zwave.associationV2.associationSet(groupingIdentifier: 3, nodeId: nodes)
+        cmds << zwave.associationV2.associationGet(groupingIdentifier: 3)
+        state.currentGroup3 = settings.requestedGroup3
+    }
+
+    switch (invertSwitch) {
+    	case "false":
+        	notInverted()
+            break
+        case "true":
+        	inverted()
+            break
+        default:
+        	notInverted()
+            break
+	}   
+
+    switch (controlMode) {
+		case "both":
+			controlBoth()
+			break
+		case "association":
+			controlAssociation()
+			break
+		case "scene":
+			controlScene()
+			break
+		default:
+			controlBoth()
+			break
+	}
+
+    sendHubCommand(cmds.collect{ new physicalgraph.device.HubAction(it.format()) }, 500)
+
+}
+
+void controlBoth() {
+	sendEvent(name: "controlled", value: "both", displayed: false)
+	sendHubCommand(new physicalgraph.device.HubAction(zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 2, size: 1).format()))
+}
+
+void controlScene() {
+	sendEvent(name: "controlled", value: "scene", displayed: false)
+	sendHubCommand(new physicalgraph.device.HubAction(zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 2, size: 1).format()))
+}
+
+void controlAssociation() {
+	sendEvent(name: "controlled", value: "association", displayed: false)
+	sendHubCommand(new physicalgraph.device.HubAction(zwave.configurationV1.configurationSet(configurationValue: [2], parameterNumber: 2, size: 1).format()))
+}
+
+void inverted() {
+	sendEvent(name: "inverted", value: "inverted", display: false)
+    sendHubCommand(new physicalgraph.device.HubAction(zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 4, size: 1).format()))
+	}
+
+void notInverted() {
+	sendEvent(name: "inverted", value: "not inverted", display: false)
+    sendHubCommand(new physicalgraph.device.HubAction(zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 4, size: 1).format()))
 }
 
 def initialize() {
-	sendEvent(name: "numberOfButtons", value: 2)
-}
+	sendEvent(name: "numberOfButtons", value: 4, displayed: false)
+    sendEvent(name: "button", value: "pushed", data: [buttonNumber: 1], displayed: false)
+
+     if (!device.currentValue("supportedButtonValues")) {
+        sendEvent(name: "supportedButtonValues", value:JsonOutput.toJson(["pushed","held"]), displayed:false) }
+
+
+}
+
+// Private Methods
+
+private parseAssocGroupList(list, group) {
+    def nodes = group == 2 ? [] : [zwaveHubNodeId]
+    if (list) {
+        def nodeList = list.split(',')
+        def max = group == 2 ? 5 : 4
+        def count = 0
+
+        nodeList.each { node ->
+            node = node.trim()
+            if ( count >= max) {
+                log.warn "Association Group ${group}: Number of members is greater than ${max}! The following member was discarded: ${node}"
+            }
+            else if (node.matches("\\p{XDigit}+")) {
+                def nodeId = Integer.parseInt(node,16)
+                if (nodeId == zwaveHubNodeId) {
+                	log.warn "Association Group ${group}: Adding the hub as an association is not allowed (it would break double-tap)."
+                }
+                else if ( (nodeId > 0) & (nodeId < 256) ) {
+                    nodes << nodeId
+                    count++
+                }
+                else {
+                    log.warn "Association Group ${group}: Invalid member: ${node}"
+                }
+            }
+            else {
+                log.warn "Association Group ${group}: Invalid member: ${node}"
+            }
+        }
+    }
+
+    return nodes
+}