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/keybounce/lannouncer-alerter.src/lannouncer-alerter.groovy

@@ -1,360 +0,0 @@
-/**
- *  LANnouncer Alerter (Formerly LANdroid - but Google didn't like that much.)
- *
- *  Requires the LANnouncer android app; https://play.google.com/store/apps/details?id=com.keybounce.lannouncer
- *  See http://www.keybounce.com/LANdroidHowTo/LANdroid.html for full downloads and instructions.
- *  SmartThings thread: https://community.smartthings.com/t/android-as-a-speech-alarm-device-released/30282/12
- *  
- * Note: Only Siren and Strobe from the U.I. or Alarm capabilities default to continuous.
- *
- *  Version 1.25 22 July 2016
- * 
- *
- *  Copyright 2015-2016 Tony McNamara
- *
- *  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.
- *
- * To Do: Add string return to Image Capture attribute
- *
- */
-
-metadata {
-    definition (name: "LANnouncer Alerter", namespace: "KeyBounce", author: "Tony McNamara") {
-        capability "Alarm"
-        capability "Speech Synthesis"
-        capability "Notification"
-        capability "Tone"
-        capability "Image Capture"
-        attribute  "LANdroidSMS","string"
-        /* Per http://docs.smartthings.com/en/latest/device-type-developers-guide/overview.html#actuator-and-sensor */
-        capability "Sensor"
-        capability "Actuator"
-
-        // Custom Commands
-        /** Retrieve image, formatted for SmartThings, from camera by name. */
-        command "chime"
-        command "doorbell"
-        command "ipCamSequence", ["number"]
-        command "retrieveAndWait", ["string"]
-        command "retrieveFirstAndWait"
-        command "retrieveSecondAndWait"
-    }
-    preferences {
-        input("DeviceLocalLan", "string", title:"Android IP Address", description:"Please enter your tablet's I.P. address", defaultValue:"" , required: false, displayDuringSetup: true)
-        input("DevicePort", "string", title:"Android Port", description:"Port the Android device listens on", defaultValue:"1035", required: false, displayDuringSetup: true)
-        input("ReplyOnEmpty", "bool", title:"Say Nothing", description:"When no speech is found, announce LANdroid?  (Needed for the speech and notify tiles to work)", defaultValue: true, displayDuringSetup: true)
-        input("AlarmContinuous", "bool", title:"Continuous Alarm (vs 10 sec.)", description: "When on, the alarm will sound until Stop is issued.", defaultValue: false, displayDuringSetup: true)
-    }
-
-    simulator {
-        // reply messages
-        ["strobe","siren","both","off"].each 
-            {
-                reply "$it": "alarm:$it"
-            }
-    }
-
-    tiles {
-        standardTile("alarm", "device.alarm", width: 2, height: 2) {
-            state "off", label:'off', action:'alarm.both', icon:"st.alarm.alarm.alarm", backgroundColor:"#ffffff"
-            state "strobe", label:'strobe!', action:'alarm.off', icon:"st.Lighting.light11", backgroundColor:"#e86d13"
-            state "siren", label:'siren!', action:'alarm.off', icon:"st.alarm.alarm.alarm", backgroundColor:"#e86d13"
-            state "both", label:'alarm!', action:'alarm.off', icon:"st.alarm.alarm.alarm", backgroundColor:"#e86d13"
-        }
-        standardTile("strobe", "device.alarm", inactiveLabel: false, decoration: "flat") {
-            state "default", label:'', action:"alarm.strobe", icon:"st.secondary.strobe"
-        }
-        
-        standardTile("siren", "device.alarm", inactiveLabel: false, decoration: "flat") {
-            state "default", label:'', action:"alarm.siren", icon:"st.secondary.siren"
-        }
-        standardTile("off", "device.alarm", inactiveLabel: false, decoration: "flat") {
-            state "default", label:'Off', action:"alarm.off", icon:"st.quirky.spotter.quirky-spotter-sound-off"
-        }       
-        
-        /* Apparently can't show image attributes on tiles. */
-        standardTile("take", "device.image", width: 1, height: 1, canChangeIcon: false, 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("speak", "device.speech", inactiveLabel: false, decoration: "flat") 
-        {
-            state "default", label:'Speak', action:"Speech Synthesis.speak", icon:"st.Electronics.electronics13"
-        }
-        standardTile("toast", "device.notification", inactiveLabel: false, decoration: "flat") {
-            state "default", label:'Notify', action:"notification.deviceNotification", icon:"st.Kids.kids1"
-        }
-        standardTile("beep", "device.tone", inactiveLabel: false, decoration: "flat") {
-            state "default", label:'Tone', action:"tone.beep", icon:"st.Entertainment.entertainment2"
-        }
-        carouselTile("cameraDetails", "device.image", width: 3, height: 2) { }
-
-        main (["alarm", "take"]);
-        details(["alarm","strobe","siren","off","speak", "take","toast","beep", "cameraDetails"]);
-    }
-}
-
-/** Generally matches TTSServer/app/build.gradle */
-String getVersion() {return "24 built July 2016";}
-
-
-/** Alarm Capability, Off.
- *  Turns off both the strobe and the alarm.
- *  Necessary when in continuous mode. 
- */
-def off() {
-    log.debug "Executing 'off'"
-    sendEvent(name:"alarm", value:"off")
-    def command="&ALARM=STOP&FLASH=STOP&"+getDoneString();
-    return sendCommands(command)
-}
-
-/** Alarm Capability: Strobe
- *  Flashes the camera light, if any.
- */
-def strobe() {
-    log.debug "Executing 'strobe'"
-    // For illustration, switch to siren and sendEvent after.
-    def command= (AlarmContinuous?"&FLASH=CONTINUOUS&":"&FLASH=STROBE&")+getDoneString();
-    // def command=(AlarmContinuous?"&ALARM=SIREN:CONTINUOUS&":"&ALARM=SIREN&")+getDoneString();
-    def hubAction = sendCommands(command)
-    sendEvent(name:"alarm", value:"strobe")
-    return hubAction;
-}
-
-/** Alarm Capability: Siren 
- *  Sounds the siren, either continuous or for a brief period, depending on setting.
- *  If continuous, Stop should be called later.
- */
-def siren() {
-    log.debug "Executing 'siren'"
-    sendEvent(name:"alarm", value:"siren")
-    def command=(AlarmContinuous?"&ALARM=SIREN:CONTINUOUS&":"&ALARM=SIREN&")+getDoneString();
-    return sendCommands(command);
-}
-
-/** Tone Capability: Beep
- *  Sounds a short beep
- */
-def beep() {
-    log.debug "Executing 'beep'"
-    def command="&ALARM=CHIME&"+getDoneString()
-    return sendCommands(command);
-}
-
-def both() {
-    log.debug "Executing 'both'"
-    sendEvent(name:"alarm", value:"both")
-    def command="&ALARM=ON&FLASH=ON&"+getDoneString()
-    if (AlarmContinuous)
-    {
-        command="&ALARM=SIREN:CONTINUOUS&FLASH=CONTINUOUS&"+getDoneString()
-    }
-    return sendCommands(command);
-}
-
-/** speechSynthesis Capability: Speak
- */
-def speak(toSay) {
-    log.debug "Executing 'speak'"
-    if (!toSay?.trim()) {
-        if (ReplyOnEmpty) {
-            toSay = "LANnouncer Version ${version}"
-        }
-    }
-
-    if (toSay?.trim()) {
-        def command="&SPEAK="+toSay+"&"+getDoneString()
-        return sendCommands(command)
-    }
-}
-
-/** Notification capability: deviceNotification
- */
-def deviceNotification(toToast) {
-    log.debug "Executing notification with "+toToast
-    if (!toToast?.trim()) {
-        if (ReplyOnEmpty) {
-            toToast = "LANnouncer Version ${version}";
-        }
-    }
-    if (toToast?.trim()) {
-        def command="&TOAST="+toToast+"&"+getDoneString()
-        return sendCommands(command)
-    }
-}    
-
-def chime() {
-    log.debug "Executing 'chime'"
-    // TODO: handle 'siren' command
-    def command="&ALARM=CHIME&"+getDoneString()
-    return sendCommands(command)
-}
-
-def doorbell() {
-    log.debug "Executing 'doorbell'"
-    // TODO: handle 'siren' command
-    def command="&ALARM=DOORBELL&"+getDoneString()
-    return sendCommands(command)
-}
-
-def ipCamSequence(cameraNumber) {
-    def camera = (cameraNumber==1?"FIRST":"SECOND");
-    def command="&RETRIEVESEQ="+cameraNumber+"&"+getDoneString()
-    return sendIPCommand(command, true)
-}
-
-
-def retrieveFirstAndWait() {
-    retrieveAndWait("FIRST");
-}
-def retrieveSecondAndWait() {
-    retrieveAndWait("SECOND");
-}
-def retrieveAndWait(cameraName) {
-    log.info("Requesting image from camera ${cameraName}");
-    def command="&RETRIEVE="+cameraName+"&STSHRINK=TRUE&"+getDoneString()
-    return sendIPCommand(command, true)
-}
-
-
-def take() {
-    // This won't result in received file. Can't handle large or binaries in hub.
-    log.debug "Executing 'take'"
-    def command="&PHOTO=BACK&STSHRINK=TRUE&"+getDoneString()
-    return sendIPCommand(command, true)
-}
-
-/** Send to IP and to SMS as appropriate 
- *  The caller MUST return the value, which is the hubAction.
- *  As of version 1.25, does not "send" the command so much as 
- *  request that the calling service send it.
- */
-private sendCommands(command) {
-    log.info "Command request: "+command
-    sendSMSCommand(command)
-    return sendIPCommand(command)
-}
-
-/** Prepares the hubAction to be executed.
- *  Pre-V25, this was executed in-line.  
- *  Now it is returned, not executed, and must be returned up the calling chain.
- */
-private sendIPCommand(commandString, sendToS3 = false) {
-    log.info "Sending command "+ commandString+" to "+DeviceLocalLan+":"+DevicePort
-    if (DeviceLocalLan?.trim()) {
-        def hosthex = convertIPtoHex(DeviceLocalLan)
-        def porthex = convertPortToHex(DevicePort)
-        device.deviceNetworkId = "$hosthex:$porthex"
-
-        def headers = [:] 
-        headers.put("HOST", "$DeviceLocalLan:$DevicePort")
-
-        def method = "GET"
-
-        def hubAction = new physicalgraph.device.HubAction(
-            method: method,
-            path: "/"+commandString,
-            headers: headers
-            );
-        if (sendToS3 == true)
-        {
-            hubAction.options = [outputMsgToS3:true];
-        }
-        log.debug hubAction
-        return hubAction;
-    }
-}
-
-private sendSMSCommand(commandString) {
-    def preface = "+@TTSSMS@+"
-    def smsValue = preface+"&"+commandString
-    state.lastsmscommand = smsValue
-    sendEvent(name: "LANdroidSMS", value: smsValue, isStateChange: true)
-    /*
-    if (SMSPhone?.trim()) {
-        sendSmsMessage(SMSPhone, preface+"&"+commandString)
-    }
-    */
-}
-
-private String getDoneString() {
-    return "@DONE@"
-}
-
-def parse(String description) {
-    log.debug "Parsing '${description}'"
-    def map = parseLanMessage(description);
-    log.debug "As LAN: " + map;
-    if ((map.headers) && (map.headers.'Content-Type' != null) && (map.headers.'Content-Type'.contains("image/jpeg")) )
-    {   //  Store the file
-      if(map.body) 
-      {
-            storeImage(getPictureName(), map.body);
-      }
-    }
-/* 'index:0F, mac:0073E023A13A, ip:C0A80114, port:040B, requestId:f9036fb2-9637-40b8-b2c5-71ba5a09fd3e, bucket:smartthings-device-conn-temp, key:fc8e3dfd-5035-40a2-8adc-a312926f9034' */
-
-    else if (map.bucket && map.key)
-    { //    S3 pointer; retrieve image from it to store.
-        try {
-            def s3ObjectContent; // Needed for scope of try-catch
-            def imageBytes = getS3Object(map.bucket, map.key + ".jpg")
-
-            if(imageBytes)
-            {
-                log.info ("Got image bytes; saving them.")
-                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() }
-        }        
-    }
-}
-
-
-// Image Capture handling
-/* Note that images are stored in https://graph.api.smartthings.com/api/s3/smartthings-smartsense-camera/[IMAGE-ID4], 
- * where [IMAGE-ID] is listed in the IDE under My Devices > [Camera] > Current States: Image. That page is updated as pictures are taken.
- */
-
-
-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
-}

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