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

[CHF-477] Health Check for Z-Wave Dimmer Switch Generic

devicetypes/ps/generic-camera-device.src/generic-camera-device.groovy

@@ -1,206 +0,0 @@
-/**
- *  Generic Camera Device v1.0.07102014
- *
- *  Copyright 2014 patrick@patrickstuart.com
- *
- *  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: "Generic Camera Device", namespace: "ps", author: "patrick@patrickstuart.com") {
-		capability "Image Capture"
-		capability "Sensor"
-		capability "Actuator"
-        
-		attribute "hubactionMode", "string"
-        
-	}
-
-    preferences {
-    input("CameraIP", "string", title:"Camera IP Address", description: "Please enter your camera's IP Address", required: true, displayDuringSetup: true)
-    input("CameraPort", "string", title:"Camera Port", description: "Please enter your camera's Port", defaultValue: 80 , required: true, displayDuringSetup: true)
-    input("CameraPath", "string", title:"Camera Path to Image", description: "Please enter the path to the image", defaultValue: "/SnapshotJPEG?Resolution=640x480&Quality=Clarity", required: true, displayDuringSetup: true)
-    input("CameraAuth", "bool", title:"Does Camera require User Auth?", description: "Please choose if the camera requires authentication (only basic is supported)", defaultValue: true, displayDuringSetup: true)
-    input("CameraPostGet", "string", title:"Does Camera use a Post or Get, normally Get?", description: "Please choose if the camera uses a POST or a GET command to retreive the image", defaultValue: "GET", displayDuringSetup: true)
-    input("CameraUser", "string", title:"Camera User", description: "Please enter your camera's username", required: false, displayDuringSetup: true)
-    input("CameraPassword", "string", title:"Camera Password", description: "Please enter your camera's password", required: false, displayDuringSetup: true)
-	}
-    
-	simulator {
-    
-	}
-/*
-	tiles {
-		standardTile("camera", "device.image", width: 1, height: 1, canChangeIcon: false, inactiveLabel: true, canChangeBackground: true) {
-			state "default", label: "", action: "", icon: "st.camera.dropcam-centered", backgroundColor: "#FFFFFF"
-		}
-		carouselTile("cameraDetails", "device.image", width: 3, height: 2) { }
-		standardTile("take", "device.image", width: 1, height: 1, canChangeIcon: false, inactiveLabel: true, canChangeBackground: false) {
-			state "take", label: "Take", action: "Image Capture.take", icon: "st.camera.camera", backgroundColor: "#FFFFFF", nextState:"taking"
-			state "taking", label:'Taking', action: "", icon: "st.camera.take-photo", backgroundColor: "#53a7c0"
-			//state "image", label: "Take", action: "Image Capture.take", icon: "st.camera.camera", backgroundColor: "#FFFFFF", nextState:"taking"
-		}
-	standardTile("blank", "device.image", width: 1, height: 1, canChangeIcon: false, canChangeBackground: false, decoration: "flat") {
-            state "blank", label: "", action: "", icon: "", backgroundColor: "#FFFFFF"
-        }
-		main "camera"
-		details(["cameraDetails", "blank", "take"])
-	}
-    
-    */
-    tiles {
-        standardTile("take", "device.image", width: 1, height: 1, canChangeIcon: false, inactiveLabel: true, canChangeBackground: false) {
-            state "take", label: "Take", action: "Image Capture.take", icon: "st.camera.camera", backgroundColor: "#FFFFFF", nextState:"taking"
-            state "taking", label:'Taking', action: "", icon: "st.camera.take-photo", backgroundColor: "#53a7c0"
-            state "image", label: "Take", action: "Image Capture.take", icon: "st.camera.camera", backgroundColor: "#FFFFFF", nextState:"taking"
-        }
-
-        standardTile("refresh", "device.alarmStatus", inactiveLabel: false, decoration: "flat") {
-            state "refresh", action:"polling.poll", icon:"st.secondary.refresh"
-        }
-        standardTile("blank", "device.image", width: 1, height: 1, canChangeIcon: false, canChangeBackground: false, decoration: "flat") {
-            state "blank", label: "", action: "", icon: "", backgroundColor: "#FFFFFF"
-        }
-        carouselTile("cameraDetails", "device.image", width: 3, height: 2) { }
-        main "take"
-        details([ "take", "blank", "refresh", "cameraDetails"])
-    }
-}
-
-def parse(String description) {
-    log.debug "Parsing '${description}'"
-    def map = [:]
-	def retResult = []
-	def descMap = parseDescriptionAsMap(description)
-	//Image
-	if (descMap["bucket"] && descMap["key"]) {
-		putImageInS3(descMap)
-	} 
-}
-
-// handle commands
-def take() {
-	def userpassascii = "${CameraUser}:${CameraPassword}"
-	def userpass = "Basic " + userpassascii.encodeAsBase64().toString()
-    def host = CameraIP 
-    def hosthex = convertIPtoHex(host)
-    def porthex = convertPortToHex(CameraPort)
-    device.deviceNetworkId = "$hosthex:$porthex" 
-    
-    log.debug "The device id configured is: $device.deviceNetworkId"
-    
-    def path = CameraPath 
-    log.debug "path is: $path"
-    log.debug "Requires Auth: $CameraAuth"
-    log.debug "Uses which method: $CameraPostGet"
-    
-    def headers = [:] 
-    headers.put("HOST", "$host:$CameraPort")
-   	if (CameraAuth) {
-        headers.put("Authorization", userpass)
-    }
-    
-    log.debug "The Header is $headers"
-    
-    def method = "GET"
-    try {
-    	if (CameraPostGet.toUpperCase() == "POST") {
-        	method = "POST"
-        	}
-        }
-    catch (Exception e) { // HACK to get around default values not setting in devices
-    	settings.CameraPostGet = "GET"
-        log.debug e
-        log.debug "You must not of set the perference for the CameraPOSTGET option"
-    }
-    
-    log.debug "The method is $method"
-    
-    try {
-    def hubAction = new physicalgraph.device.HubAction(
-    	method: method,
-    	path: path,
-    	headers: headers
-        )
-        	
-    hubAction.options = [outputMsgToS3:true]
-    log.debug hubAction
-    hubAction
-    }
-    catch (Exception e) {
-    	log.debug "Hit Exception $e on $hubAction"
-    }
-    
-}
-def putImageInS3(map) {
-	log.debug "firing s3"
-    def s3ObjectContent
-    try {
-        def imageBytes = getS3Object(map.bucket, map.key + ".jpg")
-        if(imageBytes)
-        {
-            s3ObjectContent = imageBytes.getObjectContent()
-            def bytes = new ByteArrayInputStream(s3ObjectContent.bytes)
-            storeImage(getPictureName(), bytes)
-        }
-    }
-    catch(Exception e) {
-        log.error e
-    }
-	finally {
-    //Explicitly close the stream
-		if (s3ObjectContent) { s3ObjectContent.close() }
-	}
-}
-
-def parseDescriptionAsMap(description) {
-description.split(",").inject([:]) { map, param ->
-def nameAndValue = param.split(":")
-map += [(nameAndValue[0].trim()):nameAndValue[1].trim()]
-}
-}
-
-private getPictureName() {
-	def pictureUuid = java.util.UUID.randomUUID().toString().replaceAll('-', '')
-    log.debug pictureUuid
-    def picName = device.deviceNetworkId.replaceAll(':', '') + "_$pictureUuid" + ".jpg"
-	return picName
-}
-
-private String convertIPtoHex(ipAddress) { 
-    String hex = ipAddress.tokenize( '.' ).collect {  String.format( '%02x', it.toInteger() ) }.join()
-    log.debug "IP address entered is $ipAddress and the converted hex code is $hex"
-    return hex
-
-}
-
-private String convertPortToHex(port) {
-	String hexport = port.toString().format( '%04x', port.toInteger() )
-    log.debug hexport
-    return hexport
-}
-
-private Integer convertHexToInt(hex) {
-	Integer.parseInt(hex,16)
-}
-
-
-private String convertHexToIP(hex) {
-	log.debug("Convert hex to ip: $hex") 
-	[convertHexToInt(hex[0..1]),convertHexToInt(hex[2..3]),convertHexToInt(hex[4..5]),convertHexToInt(hex[6..7])].join(".")
-}
-
-private getHostAddress() {
-	def parts = device.deviceNetworkId.split(":")
-    log.debug device.deviceNetworkId
-	def ip = convertHexToIP(parts[0])
-	def port = convertHexToInt(parts[1])
-	return ip + ":" + port
-}

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

@@ -24,6 +24,10 @@ metadata {
 		fingerprint inClusters: "0x26", deviceJoinName: "Z-Wave Dimmer"
 		fingerprint mfr:"001D", prod:"1902", deviceJoinName: "Z-Wave Dimmer"
 		fingerprint mfr:"001D", prod:"1B03", model:"0334", deviceJoinName: "Leviton Universal Dimmer"
+		fingerprint mfr:"011A", prod:"0102", model:"0201", deviceJoinName: "Enerwave In-Wall Dimmer"
+		fingerprint mfr:"001D", prod:"1001", model:"0334", deviceJoinName: "Leviton 3-Speed Fan Controller"
+		fingerprint mfr:"001D", prod:"0602", model:"0334", deviceJoinName: "Leviton Magnetic Low Voltage Dimmer"
+		fingerprint mfr:"001D", prod:"0401", model:"0334", deviceJoinName: "Leviton 600W Incandescent Dimmer"
 	}
 
 	simulator {

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!"
+        }
+    }
+}
+
+