Initial commit

devicetypes/smartthings/zwave-siren.src/zwave-siren.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.
+ *
+ *  Everspring Siren
+ *
+ *  Author: SmartThings
+ *  Date: 2014-07-15
+ */
+metadata {
+	definition (name: "Z-Wave Siren", namespace: "smartthings", author: "SmartThings") {
+		capability "Actuator"
+        capability "Alarm"
+        capability "Battery"
+        capability "Polling"
+        capability "Refresh"
+        capability "Sensor"
+		capability "Switch"
+
+
+		fingerprint inClusters: "0x20,0x25,0x86,0x80,0x85,0x72,0x71"
+	}
+
+	simulator {
+		// reply messages
+		reply "2001FF,2002": "command: 2003, payload: FF"
+		reply "200100,2002": "command: 2003, payload: 00"
+		reply "200121,2002": "command: 2003, payload: 21"
+		reply "200142,2002": "command: 2003, payload: 42"
+		reply "2001FF,delay 3000,200100,2002": "command: 2003, payload: 00"
+	}
+
+	tiles {
+		standardTile("alarm", "device.alarm", width: 2, height: 2) {
+			state "off", label:'off', action:'alarm.strobe', icon:"st.alarm.alarm.alarm", backgroundColor:"#ffffff"
+			state "both", label:'alarm!', action:'alarm.off', icon:"st.alarm.alarm.alarm", backgroundColor:"#e86d13"
+		}
+		standardTile("off", "device.alarm", inactiveLabel: false, decoration: "flat") {
+			state "default", label:'', action:"alarm.off", icon:"st.secondary.off"
+		}
+        valueTile("battery", "device.battery", inactiveLabel: false, decoration: "flat") {
+			state "battery", label:'${currentValue}% battery', unit:""
+		}
+        standardTile("refresh", "device.refresh", inactiveLabel: false, decoration: "flat") {
+			state "default", label:'', action:"refresh.refresh", icon:"st.secondary.refresh"
+		}
+        
+		main "alarm"
+		details(["alarm","off","battery","refresh"])
+	}
+}
+
+def createEvents(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"
+	} else {
+		map.value = cmd.batteryLevel
+	}
+	state.lastbatt = new Date().time
+	createEvent(map)
+}
+
+def poll() {
+	if (secondsPast(state.lastbatt, 36*60*60)) {
+		return zwave.batteryV1.batteryGet().format
+	} else {
+		return null
+	}
+}
+
+private Boolean secondsPast(timestamp, seconds) {
+	if (!(timestamp instanceof Number)) {
+		if (timestamp instanceof Date) {
+			timestamp = timestamp.time
+		} else if ((timestamp instanceof String) && timestamp.isNumber()) {
+			timestamp = timestamp.toLong()
+		} else {
+			return true
+		}
+	}
+	return (new Date().time - timestamp) > (seconds * 1000)
+}
+
+def on() {
+	log.debug "sending on"
+	[
+		zwave.basicV1.basicSet(value: 0xFF).format(),
+		zwave.basicV1.basicGet().format()
+	]
+}
+
+def off() {
+	log.debug "sending off"
+	[
+		zwave.basicV1.basicSet(value: 0x00).format(),
+		zwave.basicV1.basicGet().format()
+	]
+}
+
+def strobe() {
+	log.debug "sending stobe/on command"
+	[
+		zwave.basicV1.basicSet(value: 0xFF).format(),
+		zwave.basicV1.basicGet().format()
+	]
+}
+
+def refresh() {
+	log.debug "sending battery refresh command"
+	zwave.batteryV1.batteryGet().format()
+}
+
+def parse(String description) {
+	log.debug "parse($description)"
+	def result = null
+	def cmd = zwave.parse(description, [0x20: 1])
+	if (cmd) {
+		result = createEvents(cmd)
+	}
+	log.debug "Parse returned ${result?.descriptionText}"
+	return result
+}
+
+def createEvents(physicalgraph.zwave.commands.basicv1.BasicReport cmd)
+{
+	def switchValue = cmd.value ? "on" : "off"
+	def alarmValue
+	if (cmd.value == 0) {
+		alarmValue = "off"
+	}
+	else if (cmd.value <= 33) {
+		alarmValue = "strobe"
+	}
+	else if (cmd.value <= 66) {
+		alarmValue = "siren"
+	}
+	else {
+		alarmValue = "both"
+	}
+	[
+		createEvent([name: "switch", value: switchValue, type: "digital", displayed: false]),
+		createEvent([name: "alarm", value: alarmValue, type: "digital"])
+	]
+}
+
+
+def createEvents(physicalgraph.zwave.Command cmd) {
+	log.warn "UNEXPECTED COMMAND: $cmd"
+}