Merge pull request #2097 from skt123/zigbee_button

[DHF-16] Added Health Check Implementation for Zigbee Button.

devicetypes/smartthings/ecobee-thermostat.src/ecobee-thermostat.groovy

@@ -70,7 +70,7 @@ metadata {
 			state "heat", action:"switchMode",  nextState: "updating", icon: "st.thermostat.heat"
 			state "cool", action:"switchMode",  nextState: "updating", icon: "st.thermostat.cool"
 			state "auto", action:"switchMode",  nextState: "updating", icon: "st.thermostat.auto"
-			state "auxheatonly", action:"switchMode", icon: "st.thermostat.emergency-heat"
+			state "emergency heat", action:"switchMode", icon: "st.thermostat.emergency-heat" // emergency heat = auxHeatOnly
 			state "updating", label:"Working", icon: "st.secondary.secondary"
 		}
 		standardTile("fanMode", "device.thermostatFanMode", inactiveLabel: false, decoration: "flat") {
@@ -156,49 +156,47 @@ void poll() {
 def generateEvent(Map results) {
 	log.debug "parsing data $results"
 	if(results) {
+		results.each { name, value ->
 
 			def linkText = getLinkText(device)
-		def supportedThermostatModes = []
-		def thermostatMode = null
-
-		results.each { name, value ->
+			def isChange = false
+			def isDisplayed = true
 			def event = [name: name, linkText: linkText, descriptionText: getThermostatDescriptionText(name, value, linkText),
 						 handlerName: name]
 
 			if (name=="temperature" || name=="heatingSetpoint" || name=="coolingSetpoint" ) {
 				def sendValue =  location.temperatureScale == "C"? roundC(convertFtoC(value.toDouble())) : value.toInteger()
-				event << [value: sendValue, unit: temperatureScale]
+				isChange = isTemperatureStateChange(device, name, value.toString())
+				isDisplayed = isChange
+				event << [value: sendValue, unit: temperatureScale, isStateChange: isChange, displayed: isDisplayed]
 			}  else if (name=="maxCoolingSetpoint" || name=="minCoolingSetpoint" || name=="maxHeatingSetpoint" || name=="minHeatingSetpoint") {
 				def sendValue =  location.temperatureScale == "C"? roundC(convertFtoC(value.toDouble())) : value.toInteger()
 				event << [value: sendValue, unit: temperatureScale, displayed: false]
 			}  else if (name=="heatMode" || name=="coolMode" || name=="autoMode" || name=="auxHeatMode"){
-				if (value == true) {
-					supportedThermostatModes << ((name == "auxHeatMode") ? "auxheatonly" : name - "Mode")
-				}
-				return // as we don't want to send this event here, proceed to next name/value pair
+				isChange = isStateChange(device, name, value.toString())
+				event << [value: value.toString(), isStateChange: isChange, displayed: false]
 			}  else if (name=="thermostatFanMode"){
-				sendEvent(name: "supportedThermostatFanModes", value: fanModes(), displayed: false)
-				event << [value: value.toString(), data:[supportedThermostatFanModes: fanModes()]]
+				isChange = isStateChange(device, name, value.toString())
+				event << [value: value.toString(), isStateChange: isChange, displayed: false]
 			}  else if (name=="humidity") {
-				event << [value: value.toString(), displayed: false, unit: "%"]
+				isChange = isStateChange(device, name, value.toString())
+				event << [value: value.toString(), isStateChange: isChange, displayed: false, unit: "%"]
 			} else if (name == "deviceAlive") {
+				isChange = isStateChange(device, name, value.toString())
+				event['isStateChange'] = isChange
 				event['displayed'] = false
 			} else if (name == "thermostatMode") {
-				thermostatMode = value.toLowerCase()
-				return // as we don't want to send this event here, proceed to next name/value pair
+				def mode = value.toString()
+				mode = (mode == "auxHeatOnly") ? "emergency heat" : mode
+				isChange = isStateChange(device, name, mode)
+				event << [value: mode, isStateChange: isChange, displayed: isDisplayed]
 			} else {
-				event << [value: value.toString()]
+				isChange = isStateChange(device, name, value.toString())
+				isDisplayed = isChange
+				event << [value: value.toString(), isStateChange: isChange, displayed: isDisplayed]
 			}
 			sendEvent(event)
 		}
-		if (state.supportedThermostatModes != supportedThermostatModes) {
-			state.supportedThermostatModes = supportedThermostatModes
-			sendEvent(name: "supportedThermostatModes", value: supportedThermostatModes, displayed: false)
-		}
-		if (thermostatMode) {
-			sendEvent(name: "thermostatMode", value: thermostatMode, data:[supportedThermostatModes:state.supportedThermostatModes], linkText: linkText,
-					descriptionText: getThermostatDescriptionText("thermostatMode", thermostatMode, linkText), handlerName: "thermostatMode")
-		}
 		generateSetpointEvent ()
 		generateStatusEvent ()
 	}
@@ -324,7 +322,15 @@ void resumeProgram() {
 }
 
 def modes() {
-	return state.supportedThermostatModes
+	if (state.modes) {
+		log.debug "Modes = ${state.modes}"
+		return state.modes
+	}
+	else {
+		state.modes = parent.availableModes(this)
+		log.debug "Modes = ${state.modes}"
+		return state.modes
+	}
 }
 
 def fanModes() {
@@ -407,13 +413,11 @@ def setThermostatFanMode(String mode) {
 }
 
 def generateModeEvent(mode) {
-	sendEvent(name: "thermostatMode", value: mode, data:[supportedThermostatModes: state.supportedThermostatModes],
-			descriptionText: "$device.displayName is in ${mode} mode")
+	sendEvent(name: "thermostatMode", value: mode, descriptionText: "$device.displayName is in ${mode} mode", displayed: true)
 }
 
 def generateFanModeEvent(fanMode) {
-	sendEvent(name: "thermostatFanMode", value: fanMode, data:[supportedThermostatFanModes: fanModes()],
-			descriptionText: "$device.displayName fan is in ${fanMode} mode")
+	sendEvent(name: "thermostatFanMode", value: fanMode, descriptionText: "$device.displayName fan is in ${fanMode} mode", displayed: true)
 }
 
 def generateOperatingStateEvent(operatingState) {
@@ -449,14 +453,14 @@ def heat() {
 }
 
 def emergencyHeat() {
-	auxheatonly()
+	auxHeatOnly()
 }
 
-def auxheatonly() {
-	log.debug "auxheatonly()"
+def auxHeatOnly() {
+	log.debug "auxHeatOnly = emergency heat"
 	def deviceId = device.deviceNetworkId.split(/\./).last()
 	if (parent.setMode ("auxHeatOnly", deviceId))
-		generateModeEvent("auxheatonly")
+		generateModeEvent("emergency heat") // emergency heat = auxHeatOnly
 	else {
 		log.debug "Error setting new mode."
 		def currentMode = device.currentState("thermostatMode")?.value
@@ -589,7 +593,7 @@ def generateSetpointEvent() {
 	} else if (mode == "off") {
 		sendEvent("name":"thermostatSetpoint", "value":averageSetpoint, "unit":location.temperatureScale)
 		sendEvent("name":"displayThermostatSetpoint", "value":"Off", displayed: false)
-	} else if (mode == "auxheatonly") {
+	} else if (mode == "emergency heat") { // emergency heat = auxHeatOnly
 		sendEvent("name":"thermostatSetpoint", "value":heatingSetpoint, "unit":location.temperatureScale)
 		sendEvent("name":"displayThermostatSetpoint", "value":heatingSetpoint, "unit":location.temperatureScale, displayed: false)
 	}
@@ -628,7 +632,7 @@ void raiseSetpoint() {
 		targetvalue = thermostatSetpoint ? thermostatSetpoint : 0
 		targetvalue = location.temperatureScale == "F"? targetvalue + 1 : targetvalue + 0.5
 
-		if ((mode == "heat" || mode == "auxheatonly") && targetvalue > maxHeatingSetpoint) {
+		if ((mode == "heat" || mode == "emergency heat") && targetvalue > maxHeatingSetpoint) { // emergency heat = auxHeatOnly
 			targetvalue = maxHeatingSetpoint
 		} else if (mode == "cool" && targetvalue > maxCoolingSetpoint) {
 			targetvalue = maxCoolingSetpoint
@@ -674,7 +678,7 @@ void lowerSetpoint() {
 		targetvalue = thermostatSetpoint ? thermostatSetpoint : 0
 		targetvalue = location.temperatureScale == "F"? targetvalue - 1 : targetvalue - 0.5
 
-		if ((mode == "heat" || mode == "auxheatonly") && targetvalue < minHeatingSetpoint) {
+		if ((mode == "heat" || mode == "emergency heat") && targetvalue < minHeatingSetpoint) { // emergency heat = auxHeatOnly
 			targetvalue = minHeatingSetpoint
 		} else if (mode == "cool" && targetvalue < minCoolingSetpoint) {
 			targetvalue = minCoolingSetpoint
@@ -715,7 +719,7 @@ void alterSetpoint(temp) {
 		}
 
 		//step1: check thermostatMode, enforce limits before sending request to cloud
-		if (mode == "heat" || mode == "auxheatonly"){
+		if (mode == "heat" || mode == "emergency heat"){ // emergency heat = auxHeatOnly
 			if (temp.value > coolingSetpoint){
 				targetHeatingSetpoint = temp.value
 				targetCoolingSetpoint = temp.value
@@ -750,7 +754,7 @@ void alterSetpoint(temp) {
 			log.debug "alterSetpoint in mode $mode succeed change setpoint to= ${temp.value}"
 		} else {
 			log.error "Error alterSetpoint()"
-			if (mode == "heat" || mode == "auxheatonly"){
+			if (mode == "heat" || mode == "emergency heat"){ // emergency heat = auxHeatOnly
 				sendEvent("name": "thermostatSetpoint", "value": heatingSetpoint.toString(), displayed: false)
 				sendEvent("name": "displayThermostatSetpoint", "value": heatingSetpoint.toString(), displayed: false)
 			} else if (mode == "cool") {
@@ -779,7 +783,7 @@ def generateStatusEvent() {
 	log.debug "Cooling set point = ${coolingSetpoint}"
 	log.debug "HVAC Mode = ${mode}"
 
-	if (mode == "heat" || mode == "auxheatonly") {
+	if (mode == "heat") {
 		if (temperature >= heatingSetpoint) {
 			statusText = "Right Now: Idle"
 		} else {
@@ -802,6 +806,8 @@ def generateStatusEvent() {
 		}
 	} else if (mode == "off") {
 		statusText = "Right Now: Off"
+	} else if (mode == "emergency heat") { // emergency heat = auxHeatOnly
+		statusText = "Emergency Heat"
 	} else {
 		statusText = "?"
 	}

devicetypes/smartthings/smartpower-outlet.src/smartpower-outlet.groovy

@@ -23,6 +23,7 @@ metadata {
 		capability "Refresh"
 		capability "Sensor"
 		capability "Health Check"
+		capability "Light"
 		capability "Outlet"
 
 		fingerprint profileId: "0104", inClusters: "0000,0003,0004,0005,0006,0B04,0B05", outClusters: "0019", manufacturer: "CentraLite", model: "3200", deviceJoinName: "Outlet"

devicetypes/smartthings/zigbee-button.src/.st-ignore

@@ -0,0 +1,2 @@
+.st-ignore
+README.md

devicetypes/smartthings/zigbee-button.src/README.md

@@ -0,0 +1,43 @@
+# ZigBee Button
+
+Cloud Execution
+
+Works with: 
+
+* [OSRAM LIGHTIFY Dimming Switch](https://support.smartthings.com/hc/en-us/articles/115000236823-SYLVANIA-Dimming-Switch)
+* [Iris Smart Button](https://support.smartthings.com/hc/en-us/articles/115000190186-Iris-Smart-Button)
+* [Iris KeyFob](https://support.smartthings.com/hc/en-us/articles/217409686-Iris-Smart-Fob)
+
+## Table of contents
+
+* [Capabilities](#capabilities)
+* [Health](#device-health)
+* [Troubleshooting](#troubleshooting)
+
+## Capabilities
+
+* **Actuator** - It represents that a device has commands.
+* **Battery** - It defines that the device has a battery
+* **Button** - It defines that a device has one or more buttons
+* **Holdable Button** - It defines that a device has one or more holdable buttons
+* **Configuration** - _configure()_ command called when device is installed or device preferences updated
+* **Refresh** - _refresh()_ command for status updates
+* **Sensor** - it represents that a Device has attributes.
+* **Health Check** - indicates ability to get device health notifications
+
+
+## Device Health
+
+SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE` 
+
+* __722min__ checkInterval
+
+## Troubleshooting
+
+If the device doesn't pair when trying from the SmartThings mobile app, it is possible that the device is out of range.
+Pairing needs to be tried again by placing the device closer to the hub.
+It may also happen that you need to reset the device.
+Instructions related to pairing, resetting and removing the device from SmartThings can be found in the following link:
+* [OSRAM LIGHTIFY Dimming Switch Troubleshooting Tips](https://support.smartthings.com/hc/en-us/articles/115000236823-SYLVANIA-Dimming-Switch)
+* [Iris Smart Button Troubleshooting Tips](https://support.smartthings.com/hc/en-us/articles/115000190186-Iris-Smart-Button)
+* [Iris KeyFob Troubleshooting Tips](https://support.smartthings.com/hc/en-us/articles/217409686-Iris-Smart-Fob)

devicetypes/smartthings/zigbee-button.src/zigbee-button.groovy

@@ -24,6 +24,7 @@ metadata {
         capability "Configuration"
         capability "Refresh"
         capability "Sensor"
+        capability "Health Check"
 
         command "enrollResponse"
 
@@ -182,6 +183,13 @@ private Map parseNonIasButtonMessage(Map descMap){
     }
 }
 
+/**
+ * PING is used by Device-Watch in attempt to reach the Device
+ * */
+def ping() {
+    refresh()
+}
+
 def refresh() {
     log.debug "Refreshing Battery"
 
@@ -190,6 +198,8 @@ def refresh() {
 }
 
 def configure() {
+    // Device-Watch allows 2 check-in misses from device (plus 2 mins lag time)
+    sendEvent(name: "checkInterval", value: 2 * 6 * 60 * 60 + 2 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
     log.debug "Configuring Reporting, IAS CIE, and Bindings."
     def cmds = []
     if (device.getDataValue("model") == "3450-L") {