MSA-928: Device Handler for Aeon Water Sensor (DSB45-ZWEU/DSB45-ZWUS)

devicetypes/fuzzysb/aeon-water-sensor.src/aeon-water-sensor.groovy

@@ -0,0 +1,240 @@
+/**
+ *  Copyright 2016 Stuart Buchanan
+ *
+ *  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.
+ *
+ *	Aeon Water Sensor (DSB45-ZWEU/DSB45-ZWUS)
+ *
+ *	Author: Stuart Buchanan, Based on original work by Tosa with thanks
+ *	Date: 2016-03-07
+ */
+
+metadata {
+	definition (name: "Aeon Water Sensor", namespace: "fuzzysb", author: "Stuart Buchanan") {
+		capability "Water Sensor"
+		capability "Battery"
+		capability "Configuration"
+
+        fingerprint deviceId: "0x2001", inClusters: "0x30,0x80,0x84,0x71,0x70,0x85,0x86,0x72"
+	}
+
+	simulator {
+		status "dry": "command: 2001, payload: 00"
+		status "wet": "command: 2001, payload: FF"
+	}
+
+	
+tiles {
+		standardTile("water", "device.water", width: 2, height: 2) {
+			state "dry", icon:"st.alarm.water.dry", backgroundColor:"#ffffff"
+			state "wet", icon:"st.alarm.water.wet", backgroundColor:"#53a7c0"
+		}
+		valueTile("battery", "device.battery", inactiveLabel: false, canChangeBackground: true) {
+			state "battery", label:'${currentValue}% Battery', unit:"",
+            backgroundColors:[
+				[value: 19, color: "#BC2323"],
+				[value: 20, color: "#D04E00"],
+				[value: 30, color: "#D04E00"],
+				[value: 40, color: "#DAC400"],
+				[value: 41, color: "#79b821"]
+			]
+		}
+		standardTile("configure", "device.configure", inactiveLabel: false, decoration: "flat") {
+			state "configure", label:'', action:"configuration.configure", icon:"st.secondary.configure"
+		}
+		main "water"
+		details(["water", "battery", "configure"])
+	}
+}
+
+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 = [
+			zwave.manufacturerSpecificV2.manufacturerSpecificGet().format(),
+			"delay 1200",
+			zwave.wakeUpV1.wakeUpNoMoreInformation().format()
+		]
+	} else if (!state.lastbat) {
+		cmds = []
+	} else {
+		cmds = [zwave.wakeUpV1.wakeUpNoMoreInformation().format()]
+	}
+	response(cmds)
+}
+
+def configure() {
+	delayBetween([
+		zwave.manufacturerSpecificV2.manufacturerSpecificGet().format(),
+		batteryGetCommand()
+	], 6000)
+}
+
+def sensorValueEvent(value) {
+	if (value) {
+		createEvent(name: "water", value: "wet", descriptionText: "$device.displayName is wet")
+	} else {
+		createEvent(name: "water", value: "dry", descriptionText: "$device.displayName is dry")
+	}
+}
+
+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)
+			result << response(zwave.wakeUpV1.wakeUpIntervalSet(seconds:4*3600, nodeid:zwaveHubNodeId))
+			if(!state.MSR) result << response(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(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 << zwave.wakeUpV1.wakeUpIntervalSet(seconds:4*3600, nodeid:zwaveHubNodeId).format()
+		cmds << zwave.manufacturerSpecificV2.manufacturerSpecificGet().format()
+		cmds << "delay 1200"
+	}
+	if (!state.lastbat || now() - state.lastbat > 53*60*60*1000) {
+		cmds << batteryGetCommand()
+	} 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)
+
+	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(batteryGetCommand())
+		}
+	}
+
+	result
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.securityv1.SecurityMessageEncapsulation cmd) {
+	def encapsulatedCommand = cmd.encapsulatedCommand([0x20: 1, 0x85: 2, 0x70: 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)
+}
+
+def batteryGetCommand() {
+	def cmd = zwave.batteryV1.batteryGet()
+	if (state.sec) {
+		cmd = zwave.securityV1.securityMessageEncapsulation().encapsulate(cmd)
+	}
+	cmd.format()
+}

devicetypes/fuzzysb/dlink-dch-z510.src/dlink-dch-z510.groovy

@@ -1,263 +0,0 @@
-/**
- *  Copyright 2015 Stuart Buchanan
- *
- *  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.
- *
- *	Dlink DCH-Z510
- *
- *	Author: fuzzysb
- *	Date: 2015-01-05
- */
- 
- 
- 
-preferences {
- input "defaultSound", "enum", title: "Default Sound to use for the Siren?", options: ["Emergency","FireAlarm","Ambulance","PoliceCar","DoorChime"], required: false, defaultValue: "Emergency"
-}
- 
-metadata {
- definition (name: "Dlink DCH-Z510", namespace: "fuzzysb", author: "Stuart Buchanan") {
-	capability "Actuator"
-	capability "Alarm"
-	capability "Switch"
-	capability "Configuration"
-
-	command "Emergency"
-	command "FireAlarm"
-	command "Ambulance"
-	command "PoliceCar"
-	command "DoorChime"
-    
-	fingerprint deviceId: "0x1005", inClusters: "0x5E,0x71,0x20,0x25,0x85,0x70,0x72,0x86,0x30,0x59,0x73,0x5A,0x98,0x7A"
- }
-
-simulator {
-
-}
-
- tiles(scale: 2) {
-	multiAttributeTile(name:"alarm", type: "generic", width: 6, height: 4){
-		tileAttribute ("device.alarm", key: "PRIMARY_CONTROL") {
-			attributeState "off", label:'off', action:'alarm.siren', icon:"st.alarm.alarm.alarm", backgroundColor:"#ffffff"
-			attributeState "both", label:'alarm!', action:'alarm.off', icon:"st.alarm.alarm.alarm", backgroundColor:"#e86d13"
-		}
-	}
-	standardTile("Emergency", "device.button", inactiveLabel: false, decoration: "flat", width: 1, height: 1) {
-		state "default", label:'Emergency', action:"Emergency", icon:"st.Weather.weather1"
-	}
-	standardTile("FireAlarm", "device.button", inactiveLabel: false, decoration: "flat", width: 1, height: 1) {
-		state "default", label:'Fire Alarm', action:"FireAlarm", icon:"st.Outdoor.outdoor10"
-	}
-	standardTile("Ambulance", "device.button", inactiveLabel: false, decoration: "flat", width: 1, height: 1) {
-		state "default", label:'Ambulance', action:"Ambulance", icon:"st.Transportation.transportation2"
-	}
-	standardTile("PoliceCar", "device.button", inactiveLabel: false, decoration: "flat", width: 1, height: 1) {
-		state "default", label:'Police Car', action:"PoliceCar", icon:"st.Transportation.transportation8"
-	}
-	standardTile("DoorChime", "device.button", inactiveLabel: false, decoration: "flat", width: 1, height: 1) {
-		state "default", label:'Door Chime', action:"DoorChime", icon:"st.Home.home30"
-	}
-	standardTile("off", "device.button", inactiveLabel: false, decoration: "flat", width: 1, height: 1) {
-		state "default", label:'', action:"alarm.off", icon:"st.secondary.off"
-	}
-	main "alarm"
-	details(["alarm", "Emergency", "FireAlarm", "Ambulance", "PoliceCar", "DoorChime", "off"])
- }
-}
-
-def parse(String description)
-{
-	def result = null
-	if (description.startsWith("Err 106")) {
-		state.sec = 0
-		result = createEvent( name: "secureInclusion", value: "failed", isStateChange: true,
-			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.")
-	} else if (description != "updated") {
-		def cmd = zwave.parse(description, [0x20: 1, 0x25: 1, 0x26: 1, 0x70: 1, 0x80: 1])
-		if (cmd) {
-			result = zwaveEvent(cmd)
-            log.debug "Parse returned ${result?.inspect()}"
-            		} else {
-			log.debug("Couldn't zwave.parse '$description'")
-			null
-		}
-		
-	}
-	log.debug "Parsed '${description}' to ${result.inspect()}"
-	return result
-}
-
-
-
-def zwaveEvent(physicalgraph.zwave.commands.securityv1.SecurityMessageEncapsulation cmd) {
-	def encapsulatedCommand = cmd.encapsulatedCommand([0x20: 1, 0x25: 3, 0x26: 3, 0x70: 1, 0x80: 1])
-	state.sec = 1
-	log.debug "encapsulated: ${encapsulatedCommand}"
-	if (encapsulatedCommand) {
-		zwaveEvent(encapsulatedCommand)
-	} else {
-		log.warn "Unable to extract encapsulated cmd from $cmd"
-		createEvent(descriptionText: cmd.toString())
-	}
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.securityv1.SecurityCommandsSupportedReport cmd) {
-	response(configure())
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.configurationv1.ConfigurationReport cmd) {
-    log.debug "---CONFIGURATION REPORT V2--- ${device.displayName} parameter ${cmd.parameterNumber} with a byte size of ${cmd.size} is set to ${cmd.configurationValue}"
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.switchbinaryv1.SwitchBinaryReport cmd)
-{
-	[name: "switch", value: cmd.value ? "on" : "off", type: "digital", displayed: true, isStateChange: true]
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicReport cmd) {
-	log.debug "rx $cmd"
-	[
-		createEvent([name: "switch", value: cmd.value ? "on" : "off", displayed: false]),
-		createEvent([name: "alarm", value: cmd.value ? "both" : "off"])
-	]
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.sensorbinaryv2.SensorBinaryReport cmd) {
-	createEvent(name:"Alarm", cmd.sensorValue ? "on" : "off")
-}
-
-def zwaveEvent(physicalgraph.zwave.commands.notificationv3.NotificationReport cmd) {
-if (cmd.notificationType == 6 && cmd.event == 22) {
-		log.debug "Playing Door Chime"
-	} else if (cmd.notificationType == 10 && cmd.event == 1) {
-		log.debug "Playing Police Car"
-	} else if (cmd.notificationType == 10 && cmd.event == 3) {
-    	log.debug "Playing Ambulance"
-    } else if (cmd.notificationType == 10 && cmd.event == 2) {
-    	log.debug "Playing Fire Alarm"
-    } else if (cmd.notificationType == 7 && cmd.event == 1) {
-    	log.debug "Playing Emergency"
-    }
-}
-
-def zwaveEvent(physicalgraph.zwave.Command cmd) {
-	log.debug "Unhandled: $cmd"
-    createEvent(descriptionText: cmd.toString(), isStateChange: false)
-}
-
-def strobe() {
-	on()
-}
-
-def siren() {
-	on()
-}
-
-def both() {
-	on()
-}
-
-def on() {
-	log.debug("Sounding Siren")
-	switch ( settings.defaultSound ) {
-		case "Emergency":
-		Emergency()
-		break
-		
-		case "FireAlarm":
-		FireAlarm()
-		break
-		
-		case "Ambulance":
-		Ambulance()
-		break
-		
-		case "PoliceCar":
-		PoliceCar()
-		break
-		
-		case "DoorChime":
-		DoorChime()
-		break
-		
-		default:
-		Emergency()
-		break
-	}
-}
-
-def off() {
-	log.debug "sending off"
-	[
-		secure(zwave.basicV1.basicSet(value: 0x00)),
-		secure(zwave.basicV1.basicGet())
-	]
-}
-
-def Emergency() {
-	log.debug "Sounding Siren With Emergency"
-	[
-		secure(zwave.notificationV3.notificationReport(event: 0x01, notificationType: 0x07)),
-		secure(zwave.basicV1.basicGet())
-	]
-}
-
-def FireAlarm() {
-	log.debug "Sounding Siren With Fire Alarm"
-	[
-		secure(zwave.notificationV3.notificationReport(event: 0x02, notificationType: 0x0A)),
-        secure(zwave.basicV1.basicGet())
-	]
-}
-
-def Ambulance() {
-	log.debug "Sounding Siren With Ambulance"
-	[
-		secure(zwave.notificationV3.notificationReport(event: 0x03, notificationType: 0x0A)),
-        secure(zwave.basicV1.basicGet())
-	]
-}
-
-def PoliceCar() {
-	log.debug "Sounding Siren With Police Car"
-	[
-		secure(zwave.notificationV3.notificationReport(event: 0x01, notificationType: 0x0A)),
-        secure(zwave.basicV1.basicGet())
-	]
-}
-
-def DoorChime() {
-	log.debug "Sounding Siren With Door Chime"
-	[
-		secure(zwave.notificationV3.notificationReport(event: 0x16, notificationType: 0x06)),
-        secure(zwave.basicV1.basicGet())
-	]
-}
-
-def configure() {
-	log.debug "Resetting Siren Parameters to SmartThings Compatible Defaults"
-	def cmds = []
-    
-	cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 4, size: 1)
-    cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 29, size: 1)
-    cmds << zwave.configurationV1.configurationSet(configurationValue: [6], parameterNumber: 31, size: 1)
-    
-    delayBetween(cmds, 500)
-}
-
-private secure(physicalgraph.zwave.Command cmd) {
-	if (state.sec) {
-         log.debug "Sending Secure Command $cmd"
-		zwave.securityV1.securityMessageEncapsulation().encapsulate(cmd).format()
-	} else {
-    	log.debug "Sending Insecure Command $cmd"
-		cmd.format()
-	}
-}