WWST-202, DVCSMP-3666 Refactor Ecobee service manger (SmartThingsCommunity#2963)

* WWST-202, DVCSMP-3666 Refactor Ecobee service manger
WWST-202 - Refactor Ecobee service manger to not use DTH polling (being depreciated)
Move device polling to be controlled by the Service Manager (Connect) app and implement
device health in Switch, Thermostat and Sensor.
Addition of event subscriptions can't be done until Ecobee releases an API that allows for that.

DVCSMP-3666 - Ecobee (Connect) not able to re-authenticate ST subscription
If, for some reason the authorization grant, token or credentials are invalid,
expired or revoked, Ecobee (connect) may still try to poll the cloud and keep trying to refresh authToken.
For a user to resolve this the ST Ecobee integration needs to re-authenticate the ST subscription in the
Ecobee cloud, however as the connect app skips the login page if authToken exits, there's no check to
see if the token is valid, there's no way for the user to re-authenticate.

Also, changed use of atomicState to state to reduce possible data corruption and added a mechanism
to stop and restart polling when user launches the SM to add/remove devices to avoid data corruption

* Update ecobee-connect.groovy

Adding support for testing in staging

* Update ecobee-switch.groovy

Added updated() method to ecobee switch on request from Vinay.

Author: marstorp

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

@@ -14,6 +14,7 @@
  *
  *	Author: SmartThings
  */
+import groovy.json.JsonOutput
 metadata {
 	definition (name: "Ecobee Sensor", namespace: "smartthings", author: "SmartThings") {
 		capability "Sensor"
@@ -25,7 +26,7 @@ metadata {
 	tiles(scale: 2) {
 		multiAttributeTile(name: "temperature", type: "generic", width: 6, height: 4, canChangeIcon: true) {
       			tileAttribute ("device.temperature", key: "PRIMARY_CONTROL") {
-			  	attributeState "temperature", label:'${currentValue}°',
+			  	attributeState "temperature", label:'${currentValue}°', icon: "st.alarm.temperature.normal",
 					backgroundColors:[
 						// Celsius
 						[value: 0, color: "#153591"],
@@ -61,13 +62,30 @@ metadata {
 	}
 }
 
-def refresh() {
-	log.debug "refresh called"
-	poll()
+def initialize() {
+	sendEvent(name: "DeviceWatch-Enroll", value: JsonOutput.toJson([protocol: "cloud", scheme:"untracked"]), displayed: false)
+	updateDataValue("EnrolledUTDH", "true")
+}
+
+void installed() {
+	initialize()
 }
 
-void poll() {
-	log.debug "Executing 'poll' using parent SmartApp"
-	parent.pollChild()
+def updated() {
+	log.debug "updated()"
+	parent.setSensorName(device.label, device.deviceNetworkId)
+	initialize()
+}
 
+// Called when the DTH is uninstalled, is this true for cirrus/gadfly integrations?
+// Informs parent to purge its associated data
+def uninstalled() {
+	log.debug "uninstalled() parent.purgeChildDevice($device.deviceNetworkId)"
+	// purge DTH from parent
+	parent?.purgeChildDevice(this)
+}
+
+def refresh() {
+	log.debug "refresh, calling parent poll"
+	parent.poll()
 }

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

@@ -32,7 +32,7 @@ metadata {
                  attributeState "off", label:'${name}', action:"switch.on", icon:"st.Home.home30", backgroundColor:"#ffffff", nextState:"turningOn"
                  attributeState "turningOn", label:'${name}', action:"switch.off", icon:"st.Home.home30", backgroundColor:"#00a0dc", nextState:"turningOff"
                  attributeState "turningOff", label:'${name}', action:"switch.on", icon:"st.Home.home30", backgroundColor:"#ffffff", nextState:"turningOn"
- 			}
+            }
         }
 
         standardTile("switch", "device.switch", width: 2, height: 2, canChangeIcon: true) {
@@ -44,49 +44,52 @@ metadata {
         }
         standardTile("refresh", "device.switch", inactiveLabel: false, height: 2, width: 2, decoration: "flat") {
             state "default", label:"", action:"refresh.refresh", icon:"st.secondary.refresh"
-        }       
+        }
         main(["switch"])
         details(["rich-control", "refresh"])
     }
 }
 
 // parse events into attributes
 def parse(String description) {
-	log.debug "Parsing '${description}'"
+    log.debug "Parsing '${description}'"
+}
+
+void initialize() {
+    sendEvent(name: "DeviceWatch-Enroll", value: toJson([protocol: "cloud", scheme:"untracked"]), displayed: false) 	
 }
 
 void installed() {
     log.trace "[DTH] Executing installed() for device=${this.device.displayName}"
-    sendEvent(name: "DeviceWatch-Enroll", value: toJson([protocol: "cloud", scheme:"untracked"]), displayed: false) 	
+    initialize() 	
+}
+
+void updated() {
+    log.trace "[DTH] Executing updated() for device=${this.device.displayName}"
+    initialize() 	
 }
 
 //remove from the selected devices list in SM
 void uninstalled() {
     log.trace "[DTH] Executing uninstalled() for device=${this.device.displayName}"
-    parent?.removeChildDevice(this)
-}
-
-// handle commands
-def poll() {
-	log.trace "[DTH] Executing 'poll' for ${this.device.displayName}"
-	parent.pollSwitches()
+    parent?.purgeChildDevice(this)
 }
 
 def refresh() {
-	log.trace "[DTH] Executing 'refresh' for ${this.device.displayName}"
-    poll()
+    log.trace "[DTH] Executing 'refresh' for ${this.device.displayName}"
+    parent?.poll()
 }
 
 def on() {
-	log.trace "[DTH] Executing 'on' for ${this.device.displayName}"
+    log.trace "[DTH] Executing 'on' for ${this.device.displayName}"
     boolean desiredState = true
-	parent.controlSwitch( this.device.deviceNetworkId, desiredState )
+    parent.controlSwitch( this.device.deviceNetworkId, desiredState )
 }
 
 def off() {
-	log.trace "[DTH] Executing 'on' for ${this.device.displayName}"
+    log.trace "[DTH] Executing 'off' for ${this.device.displayName}"
     boolean desiredState = false
-	parent.controlSwitch( this.device.deviceNetworkId, desiredState )
+    parent.controlSwitch( this.device.deviceNetworkId, desiredState )
 }
 
 def toJson(Map m) {

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

@@ -15,6 +15,7 @@
  *	Author: SmartThings
  *	Date: 2013-06-13
  */
+import groovy.json.JsonOutput
 metadata {
 	definition (name: "Ecobee Thermostat", namespace: "smartthings", author: "SmartThings") {
 		capability "Actuator"
@@ -135,16 +136,29 @@ metadata {
 void installed() {
     // The device refreshes every 5 minutes by default so if we miss 2 refreshes we can consider it offline
     // Using 12 minutes because in testing, device health team found that there could be "jitter"
-    sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "cloud"], displayed: false)
+	initialize()
+}
+def initialize() {
+	sendEvent(name: "DeviceWatch-Enroll", value: JsonOutput.toJson([protocol: "cloud", scheme:"untracked"]), displayed: false)
+	updateDataValue("EnrolledUTDH", "true")
+}
+
+def updated() {
+	log.debug "updated()"
+	parent.setName(device.label, device.deviceNetworkId)
+	initialize()
+}
+
+// Called when the DTH is uninstalled, is this true for cirrus/gadfly integrations?
+// Informs parent to purge its associated data
+def uninstalled() {
+    log.debug "uninstalled() parent.purgeChildDevice($device.deviceNetworkId)"
+    // purge DTH from parent
+    parent?.purgeChildDevice(this)
 }
 
-// Device Watch will ping the device to proactively determine if the device has gone offline
-// If the device was online the last time we refreshed, trigger another refresh as part of the ping.
 def ping() {
-    def isAlive = device.currentValue("deviceAlive") == "true" ? true : false
-    if (isAlive) {
-        refresh()
-    }
+	log.debug "ping() NOP"
 }
 
 // parse events into attributes
@@ -153,13 +167,12 @@ def parse(String description) {
 }
 
 def refresh() {
-	log.debug "refresh"
-	poll()
+	log.debug "refresh, calling parent poll"
+	parent.poll()
 }
 
 void poll() {
-	log.debug "Executing 'poll' using parent SmartApp"
-	parent.pollChild()
+	log.debug "poll not implemented as it is done by parent SmartApp every 5 minutes"
 }
 
 def generateEvent(Map results) {
@@ -197,6 +210,8 @@ def generateEvent(Map results) {
 			} else if (name == "thermostatMode") {
 				thermostatMode = (value == "auxHeatOnly") ? "emergency heat" : value.toLowerCase()
 				return // as we don't want to send this event here, proceed to next name/value pair
+			} else if (name == "name") {
+				return // as we don't want to send this event, proceed to next name/value pair
 			} else {
 				event << [value: value.toString()]
 			}
@@ -502,9 +517,13 @@ def updateSetpoint(data) {
 	def sendHoldType = holdType ? ((holdType=="Temporary") ? "nextTransition" : "indefinite") : "indefinite"
 
 	if (parent.setHold(data.targetHeatingSetpoint, data.targetCoolingSetpoint, deviceId, sendHoldType)) {
-		log.debug "alterSetpoint succeed to change setpoints:${data}"
+		log.debug "updateSetpoint succeed to change setpoints:${data}"
+		sendEvent("name": "heatingSetpoint", "value": getTempInLocalScale(data.targetHeatingSetpoint, deviceScale),
+				unit: getTemperatureScale(), eventType: "ENTITY_UPDATE", displayed: false)
+		sendEvent("name": "coolingSetpoint", "value": getTempInLocalScale(data.targetCoolingSetpoint, deviceScale),
+				unit: getTemperatureScale(), eventType: "ENTITY_UPDATE", displayed: false)
 	} else {
-		log.error "Error alterSetpoint"
+		log.error "Error updateSetpoint"
 	}
 	runIn(5, "refresh", [overwrite: true])
 }