MSA-1676: Expanded Im home, good bye routines to be used with SwitchLevel products

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

@@ -22,10 +22,9 @@ metadata {
 		capability "Sensor"
 		capability "Health Check"
 
-		fingerprint mfr:"0063", prod:"4457", deviceJoinName: "GE In-Wall Smart Dimmer "
-		fingerprint mfr:"0063", prod:"4944", deviceJoinName: "GE In-Wall Smart Dimmer "
-		fingerprint mfr:"0063", prod:"5044", deviceJoinName: "GE Plug-In Smart Dimmer "
-		fingerprint mfr:"0063", prod:"4944", model:"3034", deviceJoinName: "GE In-Wall Smart Fan Control"
+		fingerprint mfr:"0063", prod:"4457", deviceJoinName: "Z-Wave Wall Dimmer"
+		fingerprint mfr:"0063", prod:"4944", deviceJoinName: "Z-Wave Wall Dimmer"
+		fingerprint mfr:"0063", prod:"5044", deviceJoinName: "Z-Wave Plug-In Dimmer"
 	}
 
 	simulator {

devicetypes/smartthings/zwave-door-sensor-as-smoke-detector.src/zwave-door-sensor-as-smoke-detector.groovy

@@ -1,273 +0,0 @@
-/**
- *  Copyright 2015 SmartThings
- *
- *  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.
- *
- *  Z-Wave Door/Window Sensor
- *
- *  Author: SmartThings
- *  Date: 2013-11-3
- */
-
-metadata {
-	definition (name: "Z-Wave Door Sensor as Smoke Detector", namespace: "smartthings", author: "SmartThings") {
-		capability "Contact Sensor"
-		capability "Sensor"
-		capability "Battery"
-		capability "Configuration"
-
-		fingerprint deviceId: "0x2001", inClusters: "0x30,0x80,0x84,0x85,0x86,0x72"
-		fingerprint deviceId: "0x07", inClusters: "0x30"
-		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+
-	}
-
-	// simulator metadata
-	simulator {
-		// status messages
-		status "fire":  "command: 2001, payload: FF"
-		status "safe": "command: 2001, payload: 00"
-		status "wake up": "command: 8407, payload: "
-	}
-
-	// UI tile definitions
-	tiles {
-		standardTile("contact", "device.contact", width: 2, height: 2) {
-			state "fire",label: '${name}',icon: "st.alarm.smoke.smoke",backgroundColor: "#ffa81e"
-			state "safe",label: '${name}',icon: "st.alarm.smoke.clear",backgroundColor: "#79b821"
-		}
-		valueTile("battery", "device.battery", inactiveLabel: false, decoration: "flat") {
-			state "battery", label:'${currentValue}% battery', unit:""
-		}
-
-		main "contact"
-		details(["contact", "battery"])
-	}
-}
-
-def parse(String description) {
-	def result = null
-	if (description.startsWith("Err 106")) {
-		if (state.sec) {
-			log.debug description
-		} else {
-			result = createEvent(
-				descriptionText: "This sensor failed to complete the network security key exchange. If you are unable to control it via SmartThings, you must remove it from your network and add it again.",
-				eventType: "ALERT",
-				name: "secureInclusion",
-				value: "failed",
-				isStateChange: true,
-			)
-		}
-	} else if (description != "updated") {
-		def cmd = zwave.parse(description, [0x20: 1, 0x25: 1, 0x30: 1, 0x31: 5, 0x80: 1, 0x84: 1, 0x71: 3, 0x9C: 1])
-		if (cmd) {
-			result = zwaveEvent(cmd)
-		}
-	}
-	log.debug "parsed '$description' to $result"
-	return result
-}
-
-def updated() {
-	def cmds = []
-	if (!state.MSR) {
-		cmds = [
-			command(zwave.manufacturerSpecificV2.manufacturerSpecificGet()),
-			"delay 1200",
-			zwave.wakeUpV1.wakeUpNoMoreInformation().format()
-		]
-	} else if (!state.lastbat) {
-		cmds = []
-	} else {
-		cmds = [zwave.wakeUpV1.wakeUpNoMoreInformation().format()]
-	}
-	response(cmds)
-}
-
-def configure() {
-	commands([
-		zwave.manufacturerSpecificV2.manufacturerSpecificGet(),
-		zwave.batteryV1.batteryGet()
-	], 6000)
-}
-
-def sensorValueEvent(value) {
-	if (value) {
-		createEvent(name: "contact", value: "fire", descriptionText: "$device.displayName fire detected")
-	} else {
-		createEvent(name: "contact", value: "safe", descriptionText: "$device.displayName is safe")
-	}
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicReport cmd)
-{
-	sensorValueEvent(cmd.value)
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicSet cmd)
-{
-	sensorValueEvent(cmd.value)
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.switchbinaryv1.SwitchBinaryReport cmd)
-{
-	sensorValueEvent(cmd.value)
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.sensorbinaryv1.SensorBinaryReport cmd)
-{
-	sensorValueEvent(cmd.sensorValue)
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.sensoralarmv1.SensorAlarmReport cmd)
-{
-	sensorValueEvent(cmd.sensorState)
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.notificationv3.NotificationReport cmd)
-{
-	def result = []
-	if (cmd.notificationType == 0x06 && cmd.event == 0x16) {
-		result << sensorValueEvent(1)
-	} else if (cmd.notificationType == 0x06 && cmd.event == 0x17) {
-		result << sensorValueEvent(0)
-	} else if (cmd.notificationType == 0x07) {
-		if (cmd.v1AlarmType == 0x07) {  // special case for nonstandard messages from Monoprice door/window sensors
-			result << sensorValueEvent(cmd.v1AlarmLevel)
-		} else if (cmd.event == 0x01 || cmd.event == 0x02) {
-			result << sensorValueEvent(1)
-		} else if (cmd.event == 0x03) {
-			result << createEvent(descriptionText: "$device.displayName covering was removed", isStateChange: true)
-			if(!state.MSR) result << response(command(zwave.manufacturerSpecificV2.manufacturerSpecificGet()))
-		} else if (cmd.event == 0x05 || cmd.event == 0x06) {
-			result << createEvent(descriptionText: "$device.displayName detected glass breakage", isStateChange: true)
-		} else if (cmd.event == 0x07) {
-			if(!state.MSR) result << response(command(zwave.manufacturerSpecificV2.manufacturerSpecificGet()))
-			result << createEvent(name: "motion", value: "active", descriptionText:"$device.displayName detected motion")
-		}
-	} else if (cmd.notificationType) {
-		def text = "Notification $cmd.notificationType: event ${([cmd.event] + cmd.eventParameter).join(", ")}"
-		result << createEvent(name: "notification$cmd.notificationType", value: "$cmd.event", descriptionText: text, displayed: false)
-	} else {
-		def value = cmd.v1AlarmLevel == 255 ? "active" : cmd.v1AlarmLevel ?: "inactive"
-		result << createEvent(name: "alarm $cmd.v1AlarmType", value: value, displayed: false)
-	}
-	result
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.wakeupv1.WakeUpNotification cmd)
-{
-	def event = createEvent(descriptionText: "${device.displayName} woke up", isStateChange: false)
-	def cmds = []
-	if (!state.MSR) {
-		cmds << command(zwave.manufacturerSpecificV2.manufacturerSpecificGet())
-		cmds << "delay 1200"
-	}
-	if (!state.lastbat || now() - state.lastbat > 53*60*60*1000) {
-		cmds << command(zwave.batteryV1.batteryGet())
-	} else {
-		cmds << zwave.wakeUpV1.wakeUpNoMoreInformation().format()
-	}
-	[event, response(cmds)]
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {
-	def map = [ name: "battery", unit: "%" ]
-	if (cmd.batteryLevel == 0xFF) {
-		map.value = 1
-		map.descriptionText = "${device.displayName} has a low battery"
-		map.isStateChange = true
-	} else {
-		map.value = cmd.batteryLevel
-	}
-	state.lastbat = now()
-	[createEvent(map), response(zwave.wakeUpV1.wakeUpNoMoreInformation())]
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.manufacturerspecificv2.ManufacturerSpecificReport cmd) {
-	def result = []
-
-	def msr = String.format("%04X-%04X-%04X", cmd.manufacturerId, cmd.productTypeId, cmd.productId)
-	log.debug "msr: $msr"
-	updateDataValue("MSR", msr)
-
-	retypeBasedOnMSR()
-
-	result << createEvent(descriptionText: "$device.displayName MSR: $msr", isStateChange: false)
-
-	if (msr == "011A-0601-0901") {  // Enerwave motion doesn't always get the associationSet that the hub sends on join
-		result << response(zwave.associationV1.associationSet(groupingIdentifier:1, nodeId:zwaveHubNodeId))
-	} else if (!device.currentState("battery")) {
-		if (msr == "0086-0102-0059") {
-			result << response(zwave.securityV1.securityMessageEncapsulation().encapsulate(zwave.batteryV1.batteryGet()).format())
-		} else {
-			result << response(command(zwave.batteryV1.batteryGet()))
-		}
-	}
-
-	result
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.securityv1.SecurityMessageEncapsulation cmd) {
-	def encapsulatedCommand = cmd.encapsulatedCommand([0x20: 1, 0x25: 1, 0x30: 1, 0x31: 5, 0x80: 1, 0x84: 1, 0x71: 3, 0x9C: 1])
-	// log.debug "encapsulated: $encapsulatedCommand"
-	if (encapsulatedCommand) {
-		state.sec = 1
-		zwaveEvent(encapsulatedCommand)
-	}
-}
-
-def zwaveEvent(physicalgraph.zwave.Command cmd) {
-	createEvent(descriptionText: "$device.displayName: $cmd", displayed: false)
-}
-
-private command(physicalgraph.zwave.Command cmd) {
-	if (state.sec == 1) {
-		zwave.securityV1.securityMessageEncapsulation().encapsulate(cmd).format()
-	} else {
-		cmd.format()
-	}
-}
-
-private commands(commands, delay=200) {
-	delayBetween(commands.collect{ command(it) }, delay)
-}
-
-def retypeBasedOnMSR() {
-	switch (state.MSR) {
-		case "0086-0002-002D":
-			log.debug "Changing device type to Z-Wave Water Sensor"
-			setDeviceType("Z-Wave Water Sensor")
-			break
-		case "011F-0001-0001":  // Schlage motion
-		case "014A-0001-0001":  // Ecolink motion
-		case "014A-0004-0001":  // Ecolink motion +
-		case "0060-0001-0002":  // Everspring SP814
-		case "0060-0001-0003":  // Everspring HSP02
-		case "011A-0601-0901":  // Enerwave ZWN-BPC
-			log.debug "Changing device type to Z-Wave Motion Sensor"
-			setDeviceType("Z-Wave Motion Sensor")
-			break
-		case "013C-0002-000D":  // Philio multi +
-			log.debug "Changing device type to 3-in-1 Multisensor Plus (SG)"
-			setDeviceType("3-in-1 Multisensor Plus (SG)")
-			break
-		case "0109-2001-0106":  // Vision door/window
-			log.debug "Changing device type to Z-Wave Plus Door/Window Sensor"
-			setDeviceType("Z-Wave Plus Door/Window Sensor")
-			break
-		case "0109-2002-0205": // Vision Motion
-			log.debug "Changing device type to Z-Wave Plus Motion/Temp Sensor"
-			setDeviceType("Z-Wave Plus Motion/Temp Sensor")
-			break
-	}
-}

devicetypes/smartthings/zwave-switch-generic.src/zwave-switch-generic.groovy

@@ -25,9 +25,6 @@ metadata {
 		fingerprint mfr:"0063", prod:"4F50", model:"3031", deviceJoinName: "GE Plug-in Outdoor Switch"
 		fingerprint mfr:"001D", prod:"1D04", model:"0334", deviceJoinName: "Leviton Outlet"
 		fingerprint mfr:"001D", prod:"1C02", model:"0334", deviceJoinName: "Leviton Switch"
-		fingerprint mfr:"001D", prod:"0301", model:"0334", deviceJoinName: "Leviton 15A Switch"
-		fingerprint mfr:"011A", prod:"0101", model:"0102", deviceJoinName: "Enerwave On/Off Switch"
-		fingerprint mfr:"011A", prod:"0101", model:"0603", deviceJoinName: "Enerwave Duplex Receptacle"
 	}
 
 	// simulator metadata

smartapps/herna202/smart-im-home.src/smart-im-home.groovy

@@ -0,0 +1,212 @@
+/**
+ *  Smart Im Home
+ *
+ *  Copyright 2016 Fernando Hernandez
+ *
+ *  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 Im Home",
+    namespace: "Herna202",
+    author: "Fernando Hernandez",
+    description: "Only turn on the light after sunset when you are the first to come home",
+    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("When I arrive and leave...")
+    {
+		input "presence1", "capability.presenceSensor", title: "Who?",required: true, multiple: true
+	}
+	section("Turn on/off a light...")
+    {
+		input "switch1", "capability.switchLevel",required: true, multiple: true
+	}
+    section("Light Level") 
+    {
+    	input "LightLevel", "number", required: true, title: "How Bright?"
+    }
+    section("Change to this mode when you leave (defaults to Away)") 
+    {
+        input "leaveMode", "mode", required: false ,title: "Mode?"
+    }
+    section("Change to this mode when you return (defaults to Home)") 
+    {
+        input "returnMode", "mode", required: false, title: "Mode?"
+    }
+    section("False alarm threshold (defaults to 2 min)") 
+    {
+        input "falseAlarmThreshold", "decimal", title: "Number of minutes", required: false
+    }
+    section( "Notifications" ) 
+    {
+        input("recipients", "contact", title: "Send notifications to", required: false) 
+        {
+            input "sendPushMessage", "enum", title: "Send a push notification?", options: ["Yes", "No"], required: false
+            input "phone", "phone", title: "Send a Text Message?", required: false
+        }
+    }
+}
+
+def installed()
+{
+    state.howManyPeopleAreHome = isAnyoneHome()
+	subscribe(presence1, "presence", presenceHandler)
+}
+
+def updated()
+{
+	unsubscribe()
+	subscribe(presence1, "presence", presenceHandler)
+}
+
+private findFalseAlarmThreshold() 
+{
+    (falseAlarmThreshold != null && falseAlarmThreshold != "") ? falseAlarmThreshold : 2
+}
+
+private findReturnMode() 
+{
+    (returnMode != null && returnMode != "") ? returnMode : "Home"
+}
+
+private findLeaveMode() 
+{
+    (leaveMode != null && leaveMode != "") ? leaveMode : "Away"
+}
+
+private isAnyoneHome()
+{
+    def result = 0
+    for (person in presence1) 
+    {
+        if (person.currentPresence == "present") 
+        {
+            result++
+        }
+    }
+    return result
+}
+
+def checkIfEveryoneIsActuallyGone() {
+    if (isAnyoneHome() == 0) {
+        def threshold = 1000 * 60 * falseAlarmThreshold - 1000
+        def awayLongEnough = presence1.findAll { person ->
+            def presenceState = presence1.currentState("presence")
+            def elapsed = now() - presenceState.rawDateCreated.time
+            elapsed >= threshold
+        }
+        log.debug "Found ${awayLongEnough.size()} out of ${presence1.size()} person(s) who were away long enough"
+        if (awayLongEnough.size() == presence1.size()) {
+            //def message = "${app.label} changed your mode to '${newMode}' because everyone left home"
+            def message = "SmartThings changed your mode to '${findLeaveMode()}' because everyone left home"
+            log.info message
+            send(message)
+            switch1.setLevel(0)
+            state.howManyPeopleAreHome = 0
+            log.warn "Everyone's away."
+            changeMode(findLeaveMode())
+            runIn(30, "VerifyAway", [overwrite: false])
+        } else {
+            log.debug "not everyone has been away long enough; doing nothing"
+        }
+    } else {
+        log.debug "not everyone is away; doing nothing"
+    }
+}
+
+private send(msg) {
+    if ( sendPushMessage != "No" ) {
+        log.debug( "sending push message" )
+        sendPush( msg )
+    }
+
+    if ( phone ) {
+        log.debug( "sending text message" )
+        sendSms( phone, msg )
+    }
+
+    log.debug msg
+}
+
+def changeMode(newMode) 
+{
+    log.warn "changeMode, location.mode = $location.mode, newMode = $newMode, location.modes = $location.modes"
+
+    if (location.mode != newMode) {
+        if (location.modes?.find{it.name == newMode}) {
+            setLocationMode(newMode)
+            log.warn "changeMode, location.mode = $location.mode, newMode = $newMode, location.modes = $location.modes"
+        }  else {
+            log.warn "Tried to change to undefined mode '${newMode}'"
+        }
+    }
+}
+
+def VerifyHome() 
+{
+	log.warn "VerifyHome, location.mode = $location.mode"
+}
+
+def VerifyAway() 
+{
+	log.warn "VerifyAway, location.mode = $location.mode"
+}
+
+def presenceHandler(evt)
+{
+	def now = new Date()
+	def sunTime = getSunriseAndSunset()
+    def tempHowManyPoepleAreHome = isAnyoneHome()
+    
+	log.debug "nowTime: $now"
+	log.debug "riseTime: $sunTime.sunrise"
+	log.debug "setTime: $sunTime.sunset"
+	log.debug "presenceHandler $evt.name: $evt.value"
+	log.debug "The current mode ID is: ${location.currentMode}"
+
+    if(tempHowManyPoepleAreHome == 0)
+    {
+        log.info "starting debounce sequence"
+        runIn(findFalseAlarmThreshold() * 60, "checkIfEveryoneIsActuallyGone", [overwrite: false])
+    }
+	else if(state.howManyPeopleAreHome)
+    {
+    	log.warn "Someone is already Home, no need to take action"
+    }
+    else
+    {
+        log.warn "First person to arrive, need to take action"
+    	state.howManyPeopleAreHome = tempHowManyPoepleAreHome
+        log.debug "How many people are home after update $state.howManyPeopleAreHome"
+        def message = "SmartThings changed your mode to '${findReturnMode()}' because everyone came home"
+        log.info message
+        send(message)
+        changeMode(findReturnMode())
+        runIn(30, "VerifyHome", [overwrite: false])
+        if(state.howManyPeopleAreHome && (now > sunTime.sunset)) 
+        {
+            switch1.setLevel(LightLevel)
+            log.warn "Welcome home at night!"
+        }
+        else if(state.howManyPeopleAreHome && (now < sunTime.sunset)) 
+        {
+            log.warn "Welcome home at daytime!"
+        }
+    }
+}
+
+