MSA-1816: A SmartApp which flashes a light or toggles a switch on an event, but restricted to a defined time of day.

smartapps/smartthings/flasher-ii.src/flasher-ii.groovy

@@ -0,0 +1,159 @@
+/**
+ *  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.
+ *
+ *  The Flasher
+ *
+ *  Author: bob
+ *  Date: 2013-02-06
+ *
+ * Modified by Craig Parkin (2017-03-02) to include a time range that events can be triggered in.
+ */
+definition(
+    name: "Flasher II",
+    namespace: "smartthings",
+    author: "SmartThings/Craig Parkin",
+    description: "Flashes a set of lights/switch in response to motion, an open/close event, or a switch, during a defined time period.",
+    category: "Convenience",
+    iconUrl: "https://s3.amazonaws.com/smartapp-icons/Meta/light_motion-outlet-contact.png",
+    iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Meta/light_motion-outlet-contact@2x.png"
+)
+
+preferences {
+	section("When any of the following devices trigger..."){
+		input "motion", "capability.motionSensor", title: "Motion Sensor?", required: false
+		input "contact", "capability.contactSensor", title: "Contact Sensor?", required: false
+		input "acceleration", "capability.accelerationSensor", title: "Acceleration Sensor?", required: false
+		input "mySwitch", "capability.switch", title: "Switch?", required: false
+		input "myPresence", "capability.presenceSensor", title: "Presence Sensor?", required: false
+	}
+	section("Then flash..."){
+		input "switches", "capability.switch", title: "These lights", multiple: true
+		input "numFlashes", "number", title: "This number of times (default 3)", required: false
+	}
+	section("Time settings in milliseconds (optional)..."){
+		input "onFor", "number", title: "On for (default 1000)", required: false
+		input "offFor", "number", title: "Off for (default 1000)", required: false
+	}
+    section("Trigger between what times?") {
+        input "fromTime", "time", title: "From", required: true
+        input "toTime", "time", title: "To", required: true
+    }
+}
+
+def installed() {
+	log.debug "Installed with settings: ${settings}"
+
+	subscribe()
+}
+
+def updated() {
+	log.debug "Updated with settings: ${settings}"
+
+	unsubscribe()
+	subscribe()
+}
+
+def subscribe() {
+	if (contact) {
+		subscribe(contact, "contact.open", contactOpenHandler)
+	}
+	if (acceleration) {
+		subscribe(acceleration, "acceleration.active", accelerationActiveHandler)
+	}
+	if (motion) {
+		subscribe(motion, "motion.active", motionActiveHandler)
+	}
+	if (mySwitch) {
+		subscribe(mySwitch, "switch.on", switchOnHandler)
+	}
+	if (myPresence) {
+		subscribe(myPresence, "presence", presenceHandler)
+	}
+}
+
+def motionActiveHandler(evt) {
+	log.debug "motion $evt.value"
+	flashLights()
+}
+
+def contactOpenHandler(evt) {
+	log.debug "contact $evt.value"
+	flashLights()
+}
+
+def accelerationActiveHandler(evt) {
+	log.debug "acceleration $evt.value"
+	flashLights()
+}
+
+def switchOnHandler(evt) {
+	log.debug "switch $evt.value"
+	flashLights()
+}
+
+def presenceHandler(evt) {
+	log.debug "presence $evt.value"
+	if (evt.value == "present") {
+		flashLights()
+	} else if (evt.value == "not present") {
+		flashLights()
+	}
+}
+
+private flashLights() {
+
+	def between = timeOfDayIsBetween(fromTime, toTime, new Date(), location.timeZone)
+    if (between) {
+        def doFlash = true
+        def onFor = onFor ?: 1000
+        def offFor = offFor ?: 1000
+        def numFlashes = numFlashes ?: 3
+
+        log.debug "LAST ACTIVATED IS: ${state.lastActivated}"
+        if (state.lastActivated) {
+            def elapsed = now() - state.lastActivated
+            def sequenceTime = (numFlashes + 1) * (onFor + offFor)
+            doFlash = elapsed > sequenceTime
+            log.debug "DO FLASH: $doFlash, ELAPSED: $elapsed, LAST ACTIVATED: ${state.lastActivated}"
+        }
+
+        if (doFlash) {
+            log.debug "FLASHING $numFlashes times"
+            state.lastActivated = now()
+            log.debug "LAST ACTIVATED SET TO: ${state.lastActivated}"
+            def initialActionOn = switches.collect{it.currentSwitch != "on"}
+            def delay = 0L
+            numFlashes.times {
+                log.trace "Switch on after  $delay msec"
+                switches.eachWithIndex {s, i ->
+                    if (initialActionOn[i]) {
+                        s.on(delay: delay)
+                    }
+                    else {
+                        s.off(delay:delay)
+                    }
+                }
+                delay += onFor
+                log.trace "Switch off after $delay msec"
+                switches.eachWithIndex {s, i ->
+                    if (initialActionOn[i]) {
+                        s.off(delay: delay)
+                    }
+                    else {
+                        s.on(delay:delay)
+                    }
+                }
+                delay += offFor
+            }
+        }
+    }
+}