MSA-1395: Smart Family Presence is a smart app with no handlers or device type dependencies.

The presence sensors have little/no configuration, especially when it comes to alerts.  I found lots of room for improvement regarding how those alerts are carried out.  Here are the problems with the original implementation of presence alerts:

1)  Each person gets and individual alert.  If you have a family of 4, each person will receive a *separate* alert for every person.
2)  There are no exceptions.  Even if the family is all together, it still individually alerts that everyone arrived/departed.
3)  Since you can't control which person gets the push alert, #1 and #2 exacerbate the issue by people receiving alerts for themselves.

The Smart Family Presence app lets the user select how and when they receive alerts.  The code is commented to explain the edge cases, but essentially, if the family arrives or departs together, no alert should be sent.  The app tracks state for whether the family was previously apart, so that it knows when and when not to send alerts.

I have found this code extremely fun to write and configure, and I believe others out in the community could benefit from it as I saw very few smart apps related to presence sensors themselves.

devicetypes/smartthings/smartsense-moisture-sensor.src/smartsense-moisture-sensor.groovy

@@ -255,8 +255,7 @@ private Map getBatteryResult(rawValue) {
 				def minVolts = 2.1
 				def maxVolts = 3.0
 				def pct = (volts - minVolts) / (maxVolts - minVolts)
-				def roundedPct = Math.round(pct * 100)
+				result.value = Math.min(100, (int) pct * 100)
-				result.value = Math.min(100, roundedPct)
 				result.descriptionText = "{{ device.displayName }} battery was {{ value }}%"
 			}
 		}

devicetypes/smartthings/smartsense-motion-sensor.src/smartsense-motion-sensor.groovy

@@ -271,8 +271,7 @@ private Map getBatteryResult(rawValue) {
 				def minVolts = 2.1
 				def maxVolts = 3.0
 				def pct = (volts - minVolts) / (maxVolts - minVolts)
-				def roundedPct = Math.round(pct * 100)
+				result.value = Math.min(100, (int) pct * 100)
-				result.value = Math.min(100, roundedPct)
 				result.descriptionText = "{{ device.displayName }} battery was {{ value }}%"
 			}
 		}

devicetypes/smartthings/smartsense-motion-temp-sensor.src/smartsense-motion-temp-sensor.groovy

@@ -240,8 +240,7 @@ private Map getBatteryResult(rawValue) {
 			def minVolts = 2.1
 			def maxVolts = 3.0
 			def pct = (volts - minVolts) / (maxVolts - minVolts)
-			def roundedPct = Math.round(pct * 100)
+			result.value = Math.min(100, (int) pct * 100)
-			result.value = Math.min(100, roundedPct)
 			result.descriptionText = "${linkText} battery was ${result.value}%"
 		}
 	}

devicetypes/smartthings/smartsense-multi-sensor.src/smartsense-multi-sensor.groovy

@@ -338,8 +338,7 @@ private Map getBatteryResult(rawValue) {
 				def minVolts = 2.1
 				def maxVolts = 3.0
 				def pct = (volts - minVolts) / (maxVolts - minVolts)
-				def roundedPct = Math.round(pct * 100)
+				result.value = Math.min(100, (int) pct * 100)
-				result.value = Math.min(100, roundedPct)
 				result.descriptionText = "{{ device.displayName }} battery was {{ value }}%"
 			}
 		}

devicetypes/smartthings/smartsense-open-closed-accelerometer-sensor.src/smartsense-open-closed-accelerometer-sensor.groovy

@@ -234,8 +234,7 @@ def getTemperature(value) {
 			def minVolts = 2.1
 			def maxVolts = 3.0
 			def pct = (volts - minVolts) / (maxVolts - minVolts)
-			def roundedPct = Math.round(pct * 100)
+			result.value = Math.min(100, (int) pct * 100)
-			result.value = Math.min(100, roundedPct)
 			result.descriptionText = "${linkText} battery was ${result.value}%"
 		}
 

devicetypes/smartthings/smartsense-open-closed-sensor.src/smartsense-open-closed-sensor.groovy

@@ -229,8 +229,7 @@ private Map getBatteryResult(rawValue) {
 		def minVolts = 2.1
     	def maxVolts = 3.0
 		def pct = (volts - minVolts) / (maxVolts - minVolts)
-		def roundedPct = Math.round(pct * 100)
+		result.value = Math.min(100, (int) pct * 100)
-		result.value = Math.min(100, roundedPct)
 		result.descriptionText = "${linkText} battery was ${result.value}%"
 	}
 

devicetypes/smartthings/smartsense-temp-humidity-sensor.src/smartsense-temp-humidity-sensor.groovy

@@ -205,8 +205,7 @@ private Map getBatteryResult(rawValue) {
 		def minVolts = 2.1
     	def maxVolts = 3.0
 		def pct = (volts - minVolts) / (maxVolts - minVolts)
-		def roundedPct = Math.round(pct * 100)
+		result.value = Math.min(100, (int) pct * 100)
-		result.value = Math.min(100, roundedPct)
 		result.descriptionText = "${linkText} battery was ${result.value}%"
 	}
 

devicetypes/smartthings/tyco-door-window-sensor.src/tyco-door-window-sensor.groovy

@@ -223,8 +223,7 @@ private Map getBatteryResult(rawValue) {
 		def minVolts = 2.1
     	def maxVolts = 3.0
 		def pct = (volts - minVolts) / (maxVolts - minVolts)
-		def roundedPct = Math.round(pct * 100)
+		result.value = Math.min(100, (int) pct * 100)
-		result.value = Math.min(100, roundedPct)
 		result.descriptionText = "${linkText} battery was ${result.value}%"
 	}
 

devicetypes/smartthings/zwave-door-window-sensor.src/zwave-door-window-sensor.groovy

@@ -28,6 +28,7 @@ metadata {
 		fingerprint deviceId: "0x0701", inClusters: "0x5E,0x98"
 		fingerprint deviceId: "0x0701", inClusters: "0x5E,0x86,0x72,0x98", outClusters: "0x5A,0x82"
 		fingerprint deviceId: "0x0701", inClusters: "0x5E,0x80,0x71,0x85,0x70,0x72,0x86,0x30,0x31,0x84,0x59,0x73,0x5A,0x8F,0x98,0x7A", outClusters:"0x20" // Philio multi+
+		fingerprint deviceId: "0x0701", inClusters: "0x5E,0x72,0x5A,0x80,0x73,0x84,0x85,0x59,0x71,0x70,0x7A,0x98" // Vision door/window
 	}
 
 	// simulator metadata
@@ -82,12 +83,12 @@ def updated() {
 		cmds = [
 			command(zwave.manufacturerSpecificV2.manufacturerSpecificGet()),
 			"delay 1200",
-			zwave.wakeUpV1.wakeUpNoMoreInformation().format()
+			zwave.wakeUpV1.wakeUpNoMoreInformation()
 		]
 	} else if (!state.lastbat) {
 		cmds = []
 	} else {
-		cmds = [zwave.wakeUpV1.wakeUpNoMoreInformation().format()]
+		cmds = [zwave.wakeUpV1.wakeUpNoMoreInformation()]
 	}
 	response(cmds)
 }

smartapps/climbingcoder/lifx-scene-manager.src/lifx-scene-manager.groovy

@@ -1,131 +0,0 @@
-/**
- *  LifX Scene Manager
- *
- *  Copyright 2016 Patrick Killian
- *
- *  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.
- *
- */
-definition(
-    name: "LifX Scene Manager",
-    namespace: "climbingcoder",
-    author: "Patrick Killian",
-    description: "When your mode changes, automatically activate a Lifx lighting scene with the same name",
-    category: "Convenience",
-    iconUrl: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience.png",
-    iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience@2x.png",
-    iconX3Url: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience@2x.png")
-
-
-preferences {
-	section("Configuration") {
-		input(name:"apikey", type:"text", title:"LifX API Token", required:true)
-        input(name:"fadeTime", type:"number", title:"Fade Time", description:"Seconds of fade between scenes", required:true)
-	}
-    section("Getting a LifX API Token") {
-        paragraph "1. Go to https://cloud.lifx.com/sign_in and sign in with your LifX account"
-        paragraph "2. Click on your email address and then choose settings from the drop down menu"
-        paragraph "3. Click 'Generate Token' and give your token any name"
-        paragraph "4. Copy your token to the required field above and save it somewhere else for reference"
-    }
-}
-
-def installed() {   
-	log.debug "Installed with settings: ${settings}"
-	initialize()
-}
-
-def updated() {
-	log.debug "Updated with settings: ${settings}"
-	unsubscribe()
-	initialize()
-}
-
-def initialize() {
-	subscribe(location, "mode", modeChangeHandler)
-}
-
-
-def modeChangeHandler(evt) {
-    log.debug "mode changed to ${evt.value}"
-    def sceneUUID = ""
-    sceneUUID = findMatchingLifxScene("${evt.value}")
-    if (sceneUUID == "") {
-    	log.debug "No matching scene found"
-    } else {
-    	activateLifxScene("${sceneUUID}")
-    }
-}
-
-
-/**
-* Returns the UUID of a LifX scene that matches
-*   the passed in sceneName by obtaining a list
-*   of all available scenes and comparing them
-*   to the passed in name
-*
-* @param sceneName - the name of the desired scene
-*
-* @return UUID - the UUID of any matching scenes found
-*/
-def findMatchingLifxScene(sceneName) {
-	log.debug ("Getting list of LifX scenes")
-	def params = [
-    	headers: ["Authorization": "Bearer ${settings.apikey}"],
-    	uri: "https://api.lifx.com/v1/scenes",
-        body: []
-	]
-    def uuid = ""
-
-	try {
-   		httpGet(params) { resp ->
-        	log.debug "response status code: ${resp.status}"
-            resp.data.each {
-            	log.debug("Found scene '${it.name}'")
-            	if ("${it.name}" == sceneName) {
-                	uuid = "${it.uuid}"
-                }
-            }
-    	}
-	} catch (e) {
-    	log.error "something went wrong: $e"
-	} finally {
-    	return uuid
-    }
-}
-
-
-
-/**
-* Calls the Lifx http endpoint to activate a scene with
-*  the given UUID
-*
-* @param UUID - the UUID of the scene to activate
-*/
-def activateLifxScene(UUID) {
-	log.debug "Activating scene with UUID '${UUID}'"
-	def params = [
-    	headers: ["Authorization": "Bearer ${settings.apikey}"],
-    	uri: "https://api.lifx.com/v1/scenes/scene_id:${UUID}/activate",
-        body: [
-        	duration: "${settings.fadeTime}"
-        ]
-	]
-
-	try {
-   		httpPut(params) { resp ->
-        	log.debug "response status code: ${resp.status}"
-    	}
-	} catch (e) {
-    	log.error "something went wrong: $e"
-	}
-}
-
-

smartapps/ddspivey/smart-family-presence.src/smart-family-presence.groovy

@@ -0,0 +1,251 @@
+/**
+ *  Smart Family Presence
+ *
+ *  Copyright 2016 Darin Spivey
+ *
+ *  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.
+ *
+ */
+definition(
+    name: "Smart Family Presence",
+    namespace: "ddspivey",
+    author: "Darin Spivey",
+    description: "Smart arrival and departure push messages for couples/families that are traveling together.  When family members arrive and depart together, there is no need to send an individual push alert for each.",
+    category: "Family",
+    iconUrl: "http://cdn.device-icons.smartthings.com/Home/home4-icn@2x.png",
+    iconX2Url: "http://cdn.device-icons.smartthings.com/Home/home4-icn@2x.png",
+    iconX3Url: "http://cdn.device-icons.smartthings.com/Home/home4-icn@2x.png")
+
+
+preferences {
+	section("Family Members") {
+		input "familySensors", "capability.presenceSensor", required: true, title: "Who's in your family?", multiple: true
+	}
+    section("Threshold") {
+    	paragraph "Set the time in seconds to allow for group arrival/departure"
+    	input "timeThreshold", "text", required: false, title: "Default is ${defaultThreshold}."
+    }
+	section("Smart departure alerts") {
+    	paragraph "When family members are home together, departure push alerts may not be necessary because most of the time, people are aware when their family members are leaving.  This feature will only send a push alert if the the entire family was previously apart."
+		paragraph "For example, when my wife and I are home together, I know when she's leaving; I don't need an alert for that.  If this feature is off, it will send a departure alert when she leaves."
+        input("smartDepartureFeature", "enum", title: "Default is On.", default:"On", options: ["On","Off"])
+	}
+    section("Verbose logging") {
+    	paragraph "For debugging, you may log all the app's decisions to the notifications log."
+    	input("logToNotifications", "enum", title: "Default is No.", default:"No", options: ["Yes", "No" ])
+	}
+}
+
+/****************************
+	Auto-getters and setters
+*****************************/
+
+def getDefaultThreshold() {
+	60
+}
+
+def setInProgress(value) {
+	state.inProgress = value
+}
+
+def getInProgress() {
+	state.inProgress == true
+}
+
+def getSmartDeparture() {
+	settings.smartDepartureFeature == 'On'
+}
+
+def getLogToNotifications() {
+	settings.logToNotifications == 'Yes'
+}
+
+def getThreshold() {
+	settings.timeThreshold ? settings.timeThreshold.toInteger() : defaultThreshold
+}
+
+/****************************
+ Framework methods
+*****************************/
+
+def installed() {
+	initialize()
+}
+ 
+def logit(msg) {
+	log.debug msg
+    if (logToNotifications) {
+    	sendNotificationEvent("[Smart Family Presense] $msg")
+    }
+}
+
+def updated() {
+	unsubscribe()
+	initialize()
+}
+
+def initialize() {
+    subscribe(familySensors, "presence", presenceHandler)
+    log.debug("Subscribed ${familySensors.toString()} to presenceHandler")
+
+	/*
+    	Regular usage shows that, during certain cases such as the hub going offline,
+        or power outages, the app may lose state and not send alerts.  This will ensure that
+        it re-evaluates its state at least once per hour.
+    */
+    
+	logit "Scheduling a re-calibration at the top of every hour."
+    schedule("0 0 0/1 1/1 * ? *", reset)
+	reset()
+}
+
+/*****************************
+ Smart Family Presence methods
+******************************/
+
+def reset() {
+	if (inProgress) {
+    	logit "Skipping re-calibration, execution in progress!"
+        return
+    }    
+    logit "Re-calibrating."
+    state.baseCase = null
+    state.changedThisTime = []
+    wasApart()
+}
+
+def isFamilyTogether() {
+	// Check to see if the entire family has arrived/departed together
+
+	if (state.changedThisTime.size() == 0) {
+    	logit "No changes."
+        reset()
+    	return
+	}
+    
+	logit "People who changed presence: ${state.changedThisTime}"
+
+	def theirState = state.baseCase
+  	def notTogether = statusNotEquals(theirState)
+    
+  	if (notTogether) {
+    	// The family is not together, send an alert as normal
+        
+    	logit "${notTogether.join(", ")} is not with the rest of the family (who are $theirState)"
+        sendPushAlert()
+    }
+    else {
+    	/* 
+        	Special case - When everyone is gone, but they *previously* weren't together,
+        	then technically they were apart to begin with and are still apart upon leaving
+        */
+            
+        if (state.wasApart && theirState == 'not present') {
+           	logit "Family was previously apart and now all gone.  Alert."
+        	sendPushAlert()
+        }
+        else {    
+    		logit "OK!  Everyone has arrived/departed together.  The family is $theirState"
+        }
+    }
+    inProgress = false
+    reset()
+}
+
+def wasApart() {
+	// This is true if everyone is gone, or some were home
+	def allGone = statusEquals('not present') == familySensors
+    def someHome = statusEquals('present') != familySensors
+    if (allGone || someHome) {
+    	state.wasApart = true
+    }
+    else {
+    	state.wasApart = false
+    }
+}
+
+
+def presenceHandler(evt) {
+    def person = evt.displayName
+
+	logit "Presence Event: $person is $evt.value"
+    
+	if (! inProgress) {
+    	inProgress = true
+    	state.baseCase = evt.value
+        logit "First person sensed.  Checking for others to be $evt.value in ${threshold} seconds"
+        runIn(threshold, isFamilyTogether, [overwrite: false])
+	}
+    
+	if (! state.changedThisTime.contains(person)) {    
+    	state.changedThisTime.push person
+    }
+    else {
+    	// Special case - presence has changed within the threshold.  Remove this person.
+        state.changedThisTime = state.changedThisTime - person
+		logit "Ignoring flapping presence event for $person"
+    }
+}
+
+def statusEquals(status) {
+	if (status == null) return
+    
+	familySensors.findAll {
+        it.currentPresence == status
+    }
+}
+
+def statusNotEquals(status) {
+	if (status == null) return
+      
+	familySensors.findAll {
+        it.currentPresence != status 
+    }
+}
+
+def sendPushAlert() {
+	def baseCase = state.baseCase
+    def changedPeople = state.changedThisTime
+    
+    if (baseCase == 'not present' && state.wasApart == false && smartDeparture) {
+      logit "Not sending departure alert because smartDeparture is $smartDeparture"
+        return
+    }
+    
+	def statuses = [ 'present':[], 'not present':[] ]
+
+	for (sensor in familySensors) {
+    	def person = sensor.toString()       
+        if (changedPeople.contains(person)) {
+        	def currentState = sensor.currentPresence
+        	log.debug "$person is now $currentState"
+            statuses[currentState].push person
+        } 
+	}
+    logit "Statuses: $statuses"
+    
+    // Construct the message payload
+    
+    def pushMsg = ""    
+    def home = statuses.present
+    def notHome = statuses['not present']
+ 	String adVerb;
+   
+    if (home.size() > 0) {
+    	adVerb = home.size > 1 ? "have" : "has"
+    	pushMsg += "${home.join(", ")} $adVerb arrived $location.name. "
+    }
+    if (notHome.size() > 0) {
+    	adVerb = notHome.size > 1 ? "have" : "has"
+    	pushMsg += "${notHome.join(", ")} $adVerb left $location.name"
+    }    	
+    
+    sendPush pushMsg
+}

smartapps/smartthings/gentle-wake-up.src/gentle-wake-up.groovy

@@ -720,7 +720,7 @@ def completionPercentage() {
 
 	def now = new Date().getTime()
 	def timeElapsed = now - atomicState.start
-	def totalRunTime = totalRunTimeMillis() ?: 1
+	def totalRunTime = totalRunTimeMillis()
 	def percentComplete = timeElapsed / totalRunTime * 100
 	log.debug "percentComplete: ${percentComplete}"
 

smartapps/smartthings/hue-connect.src/hue-connect.groovy

@@ -689,7 +689,7 @@ def parse(childDevice, description) {
             	log.warn "Parsing Body failed - trying again..."
                 poll()
             }
-            if (body instanceof java.util.Map) {
+            if (body instanceof java.util.HashMap) {
             	//poll response
                 def bulbs = getChildDevices()
                 for (bulb in body) {