MSA-837: Nest controller

devicetypes/smartthings-users/nest.src/nest.groovy

@@ -0,0 +1,177 @@
+/**
+ *  Nest
+ *
+ *  Copyright 2016 John Lister
+ *
+ *  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:
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
+ *  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.
+ *
+ */
+metadata {
+	definition (name: "Nest", namespace: "smartthings-users", author: "John Lister") {
+		capability "Polling"
+		capability "Presence Sensor"
+		capability "Relative Humidity Measurement"
+		capability "Sensor"
+		capability "Thermostat"
+
+		attribute "temperatureUnit", "string"
+
+		command "away"
+		command "present"
+		command "setPresence"
+		command "heatingSetpointUp"
+		command "heatingSetpointDown"
+		command "coolingSetpointUp"
+		command "coolingSetpointDown"
+		command "setFahrenheit"
+		command "setCelsius"
+	}
+
+	simulator {
+		// TODO: define status and reply messages here
+	}
+
+	tiles {
+		// TODO: define your main and details tiles here
+	}
+}
+
+// parse events into attributes
+def parse(String description) {
+	log.debug "Parsing '${description}'"
+	// TODO: handle 'presence' attribute
+	// TODO: handle 'humidity' attribute
+	// TODO: handle 'temperature' attribute
+	// TODO: handle 'heatingSetpoint' attribute
+	// TODO: handle 'coolingSetpoint' attribute
+	// TODO: handle 'thermostatSetpoint' attribute
+	// TODO: handle 'thermostatMode' attribute
+	// TODO: handle 'thermostatFanMode' attribute
+	// TODO: handle 'thermostatOperatingState' attribute
+	// TODO: handle 'schedule' attribute
+	// TODO: handle 'temperatureUnit' attribute
+
+}
+
+// handle commands
+def poll() {
+	log.debug "Executing 'poll'"
+	// TODO: handle 'poll' command
+}
+
+def setHeatingSetpoint() {
+	log.debug "Executing 'setHeatingSetpoint'"
+	// TODO: handle 'setHeatingSetpoint' command
+}
+
+def setCoolingSetpoint() {
+	log.debug "Executing 'setCoolingSetpoint'"
+	// TODO: handle 'setCoolingSetpoint' command
+}
+
+def off() {
+	log.debug "Executing 'off'"
+	// TODO: handle 'off' command
+}
+
+def heat() {
+	log.debug "Executing 'heat'"
+	// TODO: handle 'heat' command
+}
+
+def emergencyHeat() {
+	log.debug "Executing 'emergencyHeat'"
+	// TODO: handle 'emergencyHeat' command
+}
+
+def cool() {
+	log.debug "Executing 'cool'"
+	// TODO: handle 'cool' command
+}
+
+def setThermostatMode() {
+	log.debug "Executing 'setThermostatMode'"
+	// TODO: handle 'setThermostatMode' command
+}
+
+def fanOn() {
+	log.debug "Executing 'fanOn'"
+	// TODO: handle 'fanOn' command
+}
+
+def fanAuto() {
+	log.debug "Executing 'fanAuto'"
+	// TODO: handle 'fanAuto' command
+}
+
+def fanCirculate() {
+	log.debug "Executing 'fanCirculate'"
+	// TODO: handle 'fanCirculate' command
+}
+
+def setThermostatFanMode() {
+	log.debug "Executing 'setThermostatFanMode'"
+	// TODO: handle 'setThermostatFanMode' command
+}
+
+def auto() {
+	log.debug "Executing 'auto'"
+	// TODO: handle 'auto' command
+}
+
+def setSchedule() {
+	log.debug "Executing 'setSchedule'"
+	// TODO: handle 'setSchedule' command
+}
+
+def away() {
+	log.debug "Executing 'away'"
+	// TODO: handle 'away' command
+}
+
+def present() {
+	log.debug "Executing 'present'"
+	// TODO: handle 'present' command
+}
+
+def setPresence() {
+	log.debug "Executing 'setPresence'"
+	// TODO: handle 'setPresence' command
+}
+
+def heatingSetpointUp() {
+	log.debug "Executing 'heatingSetpointUp'"
+	// TODO: handle 'heatingSetpointUp' command
+}
+
+def heatingSetpointDown() {
+	log.debug "Executing 'heatingSetpointDown'"
+	// TODO: handle 'heatingSetpointDown' command
+}
+
+def coolingSetpointUp() {
+	log.debug "Executing 'coolingSetpointUp'"
+	// TODO: handle 'coolingSetpointUp' command
+}
+
+def coolingSetpointDown() {
+	log.debug "Executing 'coolingSetpointDown'"
+	// TODO: handle 'coolingSetpointDown' command
+}
+
+def setFahrenheit() {
+	log.debug "Executing 'setFahrenheit'"
+	// TODO: handle 'setFahrenheit' command
+}
+
+def setCelsius() {
+	log.debug "Executing 'setCelsius'"
+	// TODO: handle 'setCelsius' command
+}

smartapps/initialstate-events/initial-state-event-streamer.src/initial-state-event-streamer.groovy

@@ -1,7 +1,7 @@
 /**
  *  Initial State Event Streamer
  *
- *  Copyright 2016 David Sulpy
+ *  Copyright 2015 David Sulpy
  *
  *  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:
@@ -77,62 +77,6 @@ mappings {
 	}
 }
 
-def getAccessKey() {
-	log.trace "get access key"
-	if (atomicState.accessKey == null) {
-		httpError(404, "Access Key Not Found")
-	} else {
-		[
-			accessKey: atomicState.accessKey
-		]
-	}
-}
-
-def getBucketKey() {
-	log.trace "get bucket key"
-	if (atomicState.bucketKey == null) {
-		httpError(404, "Bucket key Not Found")
-	} else {
-		[
-			bucketKey: atomicState.bucketKey,
-			bucketName: atomicState.bucketName
-		]
-	}
-}
-
-def setBucketKey() {
-	log.trace "set bucket key"
-	def newBucketKey = request.JSON?.bucketKey
-	def newBucketName = request.JSON?.bucketName
-
-	log.debug "bucket name: $newBucketName"
-	log.debug "bucket key: $newBucketKey"
-
-	if (newBucketKey && (newBucketKey != atomicState.bucketKey || newBucketName != atomicState.bucketName)) {
-		atomicState.bucketKey = "$newBucketKey"
-		atomicState.bucketName = "$newBucketName"
-		atomicState.isBucketCreated = false
-	}
-
-	tryCreateBucket()
-}
-
-def setAccessKey() {
-	log.trace "set access key"
-	def newAccessKey = request.JSON?.accessKey
-	def newGrokerSubdomain = request.JSON?.grokerSubdomain
-
-	if (newGrokerSubdomain && newGrokerSubdomain != "" && newGrokerSubdomain != atomicState.grokerSubdomain) {
-		atomicState.grokerSubdomain = "$newGrokerSubdomain"
-		atomicState.isBucketCreated = false
-	}
-
-	if (newAccessKey && newAccessKey != atomicState.accessKey) {
-		atomicState.accessKey = "$newAccessKey"
-		atomicState.isBucketCreated = false
-	}
-}
-
 def subscribeToEvents() {
 	if (accelerometers != null) {
 		subscribe(accelerometers, "acceleration", genericHandler)
@@ -225,27 +169,85 @@ def subscribeToEvents() {
 	}
 }
 
+def getAccessKey() {
+	log.trace "get access key"
+	if (atomicState.accessKey == null) {
+		httpError(404, "Access Key Not Found")
+	} else {
+		[
+			accessKey: atomicState.accessKey
+		]
+	}
+}
+
+def getBucketKey() {
+	log.trace "get bucket key"
+	if (atomicState.bucketKey == null) {
+		httpError(404, "Bucket key Not Found")
+	} else {
+		[
+			bucketKey: atomicState.bucketKey,
+			bucketName: atomicState.bucketName
+		]
+	}
+}
+
+def setBucketKey() {
+	log.trace "set bucket key"
+	def newBucketKey = request.JSON?.bucketKey
+	def newBucketName = request.JSON?.bucketName
+
+	log.debug "bucket name: $newBucketName"
+	log.debug "bucket key: $newBucketKey"
+
+	if (newBucketKey && (newBucketKey != atomicState.bucketKey || newBucketName != atomicState.bucketName)) {
+		atomicState.bucketKey = "$newBucketKey"
+		atomicState.bucketName = "$newBucketName"
+		atomicState.isBucketCreated = false
+	}
+
+	tryCreateBucket()
+}
+
+def setAccessKey() {
+	log.trace "set access key"
+	def newAccessKey = request.JSON?.accessKey
+	def newGrokerSubdomain = request.JSON?.grokerSubdomain
+
+	if (newGrokerSubdomain && newGrokerSubdomain != "" && newGrokerSubdomain != atomicState.grokerSubdomain) {
+		atomicState.grokerSubdomain = "$newGrokerSubdomain"
+		atomicState.isBucketCreated = false
+	}
+
+	if (newAccessKey && newAccessKey != atomicState.accessKey) {
+		atomicState.accessKey = "$newAccessKey"
+		atomicState.isBucketCreated = false
+	}
+}
+
 def installed() {
-	atomicState.version = "1.1.0"
-
-	atomicState.isBucketCreated = false
-	atomicState.grokerSubdomain = "groker"
-
+	atomicState.version = "1.0.18"
 	subscribeToEvents()
 
 	atomicState.isBucketCreated = false
 	atomicState.grokerSubdomain = "groker"
+	atomicState.eventBuffer = []
+
+	runEvery15Minutes(flushBuffer)
 
 	log.debug "installed (version $atomicState.version)"
 }
 
 def updated() {
-	atomicState.version = "1.1.0"
+	atomicState.version = "1.0.18"
 	unsubscribe()
 
 	if (atomicState.bucketKey != null && atomicState.accessKey != null) {
 		atomicState.isBucketCreated = false
 	}
+	if (atomicState.eventBuffer == null) {
+		atomicState.eventBuffer = []
+	}
 	if (atomicState.grokerSubdomain == null || atomicState.grokerSubdomain == "") {
 		atomicState.grokerSubdomain = "groker"
 	}
@@ -325,17 +327,37 @@ def genericHandler(evt) {
 	eventHandler(key, value)
 }
 
-def eventHandler(name, value) {
-	def epoch = now() / 1000
-
-	def event = new JsonSlurper().parseText("{\"key\": \"$name\", \"value\": \"$value\", \"epoch\": \"$epoch\"}")
-
-	tryShipEvents(event)
-	
-	log.debug "Shipped Event: " + event
+// This is a handler function for flushing the event buffer
+// after a specified amount of time to reduce the load on ST servers
+def flushBuffer() {
+	def eventBuffer = atomicState.eventBuffer
+	log.trace "About to flush the buffer on schedule"
+	if (eventBuffer != null && eventBuffer.size() > 0) {
+		atomicState.eventBuffer = []
+		tryShipEvents(eventBuffer)
+	}
 }
 
-def tryShipEvents(event) {
+def eventHandler(name, value) {
+	def epoch = now() / 1000
+	def eventBuffer = atomicState.eventBuffer ?: []
+	eventBuffer << [key: "$name", value: "$value", epoch: "$epoch"]
+
+	if (eventBuffer.size() >= 10) {
+		// Clear eventBuffer right away since we've already pulled it off of atomicState to reduce the risk of missing
+		// events.  This assumes the grokerSubdomain, accessKey, and bucketKey are set correctly to avoid the eventBuffer
+		// from growing unbounded.
+		atomicState.eventBuffer = []
+		tryShipEvents(eventBuffer)
+	} else {
+		// Make sure we persist the updated eventBuffer with the new event added back to atomicState
+		atomicState.eventBuffer = eventBuffer
+	}
+	log.debug "Event added to buffer: " + eventBuffer
+}
+
+// a helper function for shipping the atomicState.eventBuffer to Initial State
+def tryShipEvents(eventBuffer) {
 
 	def grokerSubdomain = atomicState.grokerSubdomain
 	// can't ship events if there is no grokerSubdomain
@@ -358,7 +380,7 @@ def tryShipEvents(event) {
 			"X-IS-AccessKey": "${accessKey}",
 			"Accept-Version": "0.0.2"
 		],
-		body: event
+		body: eventBuffer
 	]
 
 	try {