MSA-2129: A device handler for the Devolo Humidity Sensor

[DHF-14][DHF-15] Updated comments & rectified typo

devicetypes/fortrezz/fortrezz-mimolite.src/fortrezz-mimolite.groovy

@@ -1,204 +0,0 @@
-/**
- *  FortrezZ Flow Meter Interface
- *
- *  Copyright 2016 FortrezZ, LLC
- *
- *  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.
- *
- *  Based on Todd Wackford's MimoLite Garage Door Opener
- */
-metadata {
-	// Automatically generated. Make future change here.
-	definition (name: "FortrezZ MIMOlite", namespace: "fortrezz", author: "FortrezZ, LLC") {
-		capability "Configuration"
-		capability "Switch"
-		capability "Refresh"
-		capability "Contact Sensor"
-        capability "Voltage Measurement"
-
-		attribute "powered", "string"
-
-		command "on"
-		command "off"
-        
-        fingerprint deviceId: "0x1000", inClusters: "0x72,0x86,0x71,0x30,0x31,0x35,0x70,0x85,0x25,0x03"
-	}
-
-	simulator {
-	// Simulator stuff
-    
-	}
-    
-    preferences {
-       input "RelaySwitchDelay", "decimal", title: "Delay between relay switch on and off in seconds. Only Numbers 0 to 3.0 allowed. 0 value will remove delay and allow relay to function as a standard switch", description: "Numbers 0 to 3.1 allowed.", defaultValue: 0, required: false, displayDuringSetup: true
-    }
-
-
-	// UI tile definitions 
-	tiles (scale: 2) {
-        standardTile("switch", "device.switch", width: 4, height: 4, canChangeIcon: false, decoration: "flat") {
-            state "on", label: "On", action: "off", icon: "http://swiftlet.technology/wp-content/uploads/2016/06/Switch-On-104-edit.png", backgroundColor: "#53a7c0"
-			state "off", label: 'Off', action: "on", icon: "http://swiftlet.technology/wp-content/uploads/2016/06/Switch-Off-104-edit.png", backgroundColor: "#ffffff"
-        }
-        standardTile("contact", "device.contact", width: 2, height: 2, inactiveLabel: false) {
-			state "open", label: '${name}', icon: "st.contact.contact.open", backgroundColor: "#ffa81e"
-			state "closed", label: '${name}', icon: "st.contact.contact.closed", backgroundColor: "#79b821"
-		}
-        standardTile("refresh", "device.switch", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
-			state "default", label:'', action:"refresh.refresh", icon:"st.secondary.refresh"
-		}
-        standardTile("powered", "device.powered", width: 2, height: 2, inactiveLabel: false) {
-			state "powerOn", label: "Power On", icon: "st.switches.switch.on", backgroundColor: "#79b821"
-			state "powerOff", label: "Power Off", icon: "st.switches.switch.off", backgroundColor: "#ffa81e"
-		}
-		standardTile("configure", "device.configure", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
-			state "configure", label:'', action:"configuration.configure", icon:"st.secondary.configure"
-		}
-        valueTile("voltage", "device.voltage", width: 2, height: 2) {
-            state "val", label:'${currentValue}v', unit:"", defaultState: true
-        }
-        valueTile("voltageCounts", "device.voltageCounts", width: 2, height: 2) {
-            state "val", label:'${currentValue}', unit:"", defaultState: true
-        }
-		main (["switch"])
-		details(["switch", "contact", "voltage", "powered", "refresh","configure"])
-	}
-}
-
-def parse(String description) {
-//log.debug "description is: ${description}"
-
-	def result = null
-	def cmd = zwave.parse(description, [0x20: 1, 0x84: 1, 0x30: 1, 0x70: 1, 0x31: 5])
-    
-    //log.debug "command value is: $cmd.CMD"
-    
-    if (cmd.CMD == "7105") {				//Mimo sent a power loss report
-    	log.debug "Device lost power"
-    	sendEvent(name: "powered", value: "powerOff", descriptionText: "$device.displayName lost power")
-    } else {
-    	sendEvent(name: "powered", value: "powerOn", descriptionText: "$device.displayName regained power")
-    }
-    //log.debug "${device.currentValue('contact')}" // debug message to make sure the contact tile is working
-	if (cmd) {
-		result = createEvent(zwaveEvent(cmd))
-	}
-	log.debug "Parse returned ${result?.descriptionText} $cmd.CMD"
-	return result
-}
-
-def updated() {
-	log.debug "Settings Updated..."
-    configure()
-}
-//notes about zwaveEvents:
-// these are special overloaded functions which MUST be returned with a map similar to (return [name: "switch", value: "on"])
-// not doing so will produce a null on the parse function, this will mess you up in the future.
-// Perhaps can use 'createEvent()' and return that as long as a map is inside it.
-def zwaveEvent(physicalgraph.zwave.commands.switchbinaryv1.SwitchBinaryReport cmd) { 
-log.debug "switchBinaryReport ${cmd}"
-    if (cmd.value) // if the switch is on it will not be 0, so on = true
-    {
-		return [name: "switch", value: "on"] // change switch value to on
-    }
-    else // if the switch sensor report says its off then do...
-    {
-		return [name: "switch", value: "off"] // change switch value to off
-    }
-       
-}
-
-// working on next for the analogue and digital stuff.
-def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicSet cmd) // basic set is essentially our digital sensor for SIG1
-{
-	log.debug "sent a BasicSet command"
-    //refresh()  
-    delayBetween([zwave.sensorMultilevelV5.sensorMultilevelGet().format()])// requests a report of the anologue input voltage
-	[name: "contact", value: cmd.value ? "open" : "closed"]}
-    //[name: "contact", value: cmd.value ? "open" : "closed", type: "digital"]}
-    
-def zwaveEvent(physicalgraph.zwave.commands.sensorbinaryv1.SensorBinaryReport cmd)
-{
-	log.debug "sent a sensorBinaryReport command"
-	refresh()    
-	[name: "contact", value: cmd.value ? "open" : "closed"]
-}
-
-
-    
-def zwaveEvent (physicalgraph.zwave.commands.sensormultilevelv5.SensorMultilevelReport cmd) // sensorMultilevelReport is used to report the value of the analog voltage for SIG1
-{
-	log.debug "sent a SensorMultilevelReport"
-	def ADCvalue = cmd.scaledSensorValue
-    sendEvent(name: "voltageCounts", value: ADCvalue)
-   
-    CalculateVoltage(cmd.scaledSensorValue)
-}
-
-def zwaveEvent(physicalgraph.zwave.Command cmd) {
-	// Handles all Z-Wave commands we aren't interested in
-     log.debug("Un-parsed Z-Wave message ${cmd}")
-	[:]
-}
-
-def CalculateVoltage(ADCvalue)
-{
-	 def map = [:]
-     
-     def volt = (((1.5338*(10**-16))*(ADCvalue**5)) - ((1.2630*(10**-12))*(ADCvalue**4)) + ((3.8111*(10**-9))*(ADCvalue**3)) - ((4.7739*(10**-6))*(ADCvalue**2)) + ((2.8558*(10**-3))*(ADCvalue)) - (2.2721*(10**-2)))
-
-    //def volt = (((3.19*(10**-16))*(ADCvalue**5)) - ((2.18*(10**-12))*(ADCvalue**4)) + ((5.47*(10**-9))*(ADCvalue**3)) - ((5.68*(10**-6))*(ADCvalue**2)) + (0.0028*ADCvalue) - (0.0293))
-	//log.debug "$cmd.scale $cmd.precision $cmd.size $cmd.sensorType $cmd.sensorValue $cmd.scaledSensorValue"
-	def voltResult = volt.round(1)// + "v"
-    
-	map.name = "voltage"
-    map.value = voltResult
-    map.unit = "v"
-    return map
-}
-	
-
-def configure() {
-	def x = (RelaySwitchDelay*10).toInteger()
-    log.debug "Configuring.... " //setting up to monitor power alarm and actuator duration
-    
-	delayBetween([
-		zwave.associationV1.associationSet(groupingIdentifier:3, nodeId:[zwaveHubNodeId]).format(), // 	FYI: Group 3: If a power dropout occurs, the MIMOlite will send an Alarm Command Class report 
-        																							//	(if there is enough available residual power)
-        zwave.associationV1.associationSet(groupingIdentifier:2, nodeId:[zwaveHubNodeId]).format(), // periodically send a multilevel sensor report of the ADC analog voltage to the input
-        zwave.associationV1.associationSet(groupingIdentifier:4, nodeId:[zwaveHubNodeId]).format(), // when the input is digitally triggered or untriggered, snd a binary sensor report
-        zwave.configurationV1.configurationSet(configurationValue: [x], parameterNumber: 11, size: 1).format() // configurationValue for parameterNumber means how many 100ms do you want the relay
-        																										// to wait before it cycles again / size should just be 1 (for 1 byte.)
-        //zwave.configurationV1.configurationGet(parameterNumber: 11).format() // gets the new parameter changes. not currently needed. (forces a null return value without a zwaveEvent funciton
-	])
-}
-
-def on() {
-	delayBetween([
-		zwave.basicV1.basicSet(value: 0xFF).format(),	// physically changes the relay from on to off and requests a report of the relay
-        refresh()// to make sure that it changed (the report is used elsewhere, look for switchBinaryReport()
-       ])
-}
-
-def off() {
-	delayBetween([
-		zwave.basicV1.basicSet(value: 0x00).format(), // physically changes the relay from on to off and requests a report of the relay
-        refresh()// to make sure that it changed (the report is used elsewhere, look for switchBinaryReport()
-	])
-}
-
-def refresh() {
-log.debug "REFRESH!"
-	delayBetween([
-        zwave.switchBinaryV1.switchBinaryGet().format(), //requests a report of the relay to make sure that it changed (the report is used elsewhere, look for switchBinaryReport()
-        zwave.sensorMultilevelV5.sensorMultilevelGet().format()// requests a report of the anologue input voltage
-
-    ])
-}

devicetypes/garth/devolo-humidity-sensor.src/devolo-humidity-sensor.groovy

@@ -0,0 +1,188 @@
+/**
+ *  Devolo Humidity Sensor
+ *
+ *  Copyright 2017 Garth Williams
+ *
+ *  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.
+ *
+ *
+ *  Based on definition (name: "Aeon Multisensor 6", namespace: "smartthings", author: "SmartThings")
+ *
+ */
+metadata {
+	definition (name: "Devolo Humidity Sensor", namespace: "garth", author: "Garth Williams") {
+		capability "Temperature Measurement"
+		capability "Relative Humidity Measurement"
+		capability "Configuration"
+		capability "Sensor"
+		capability "Battery"
+		capability "Health Check"
+        
+        attribute "batteryStatus", "string"
+        
+        fingerprint mfr: "0175", prod: "0002", model: "0020"
+	}
+
+	simulator {
+		for (int i = 0; i <= 100; i += 20) {
+			status "temperature ${i}F": new physicalgraph.zwave.Zwave().securityV1.securityMessageEncapsulation().encapsulate(
+				new physicalgraph.zwave.Zwave().sensorMultilevelV2.sensorMultilevelReport(
+					scaledSensorValue: i, precision: 1, sensorType: 1, scale: 1)
+				).incomingMessage()
+		}
+
+		for (int i = 0; i <= 100; i += 20) {
+			status "humidity ${i}%":  new physicalgraph.zwave.Zwave().securityV1.securityMessageEncapsulation().encapsulate(
+				new physicalgraph.zwave.Zwave().sensorMultilevelV2.sensorMultilevelReport(scaledSensorValue: i, sensorType: 5)
+			).incomingMessage()
+		}
+
+		for (int i in [0, 5, 10, 15, 50, 99, 100]) {
+			status "battery ${i}%":  new physicalgraph.zwave.Zwave().securityV1.securityMessageEncapsulation().encapsulate(
+				new physicalgraph.zwave.Zwave().batteryV1.batteryReport(batteryLevel: i)
+			).incomingMessage()
+		}
+		status "low battery alert":  new physicalgraph.zwave.Zwave().securityV1.securityMessageEncapsulation().encapsulate(
+			new physicalgraph.zwave.Zwave().batteryV1.batteryReport(batteryLevel: 255)
+		).incomingMessage()
+
+		status "wake up" : "command: 8407, payload: "
+	}
+
+	preferences {
+	}
+
+	tiles(scale: 2) {
+		valueTile("temperature", "device.temperature", inactiveLabel: false, width: 2, height: 2) {
+			state "temperature", label:'${currentValue}°',
+			backgroundColors:[
+				[value: 32, color: "#153591"],
+				[value: 44, color: "#1e9cbb"],
+				[value: 59, color: "#90d2a7"],
+				[value: 74, color: "#44b621"],
+				[value: 84, color: "#f1d801"],
+				[value: 92, color: "#d04e00"],
+				[value: 98, color: "#bc2323"]
+			]
+		}
+		valueTile("humidity", "device.humidity", inactiveLabel: false, width: 2, height: 2) {
+			state "humidity", label:'${currentValue}% humidity', unit:""
+		}
+
+		valueTile("battery", "device.battery", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
+			state "battery", label:'${currentValue}% battery', unit:""
+		}
+
+		valueTile("batteryStatus", "device.batteryStatus", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
+			state "batteryStatus", label:'${currentValue}', unit:""
+		}
+
+		main(["temperature", "humidity"])
+		details(["temperature", "humidity", "batteryStatus"])
+	}
+}
+
+def parse(String description) {
+	log.debug "parse() >> description: $description"
+	def result = null
+	if (description.startsWith("Err 106")) {
+		log.debug "parse() >> Err 106"
+		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") {
+		log.debug "parse() >> zwave.parse(description)"
+		def cmd = zwave.parse(description, [0x31: 5, 0x30: 2, 0x84: 1])
+		if (cmd) {
+			result = zwaveEvent(cmd)
+		}
+	}
+	log.debug "After zwaveEvent(cmd) >> Parsed '${description}' to ${result.inspect()}"
+	return result
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.securityv1.SecurityMessageEncapsulation cmd) {
+	def encapsulatedCommand = cmd.encapsulatedCommand([0x31: 5, 0x30: 2, 0x84: 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) {
+	log.info "Executing zwaveEvent 98 (SecurityV1): 03 (SecurityCommandsSupportedReport) with cmd: $cmd"
+	state.sec = 1
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.securityv1.NetworkKeyVerify cmd) {
+	state.sec = 1
+	log.info "Executing zwaveEvent 98 (SecurityV1): 07 (NetworkKeyVerify) with cmd: $cmd (node is securely included)"
+	def result = [createEvent(name:"secureInclusion", value:"success", descriptionText:"Secure inclusion was successful", isStateChange: true)]
+	result
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {
+	def result = []
+	def map = [ name: "battery", unit: "%" ]
+	if (cmd.batteryLevel == 0xFF) {
+		map.value = 1
+		map.descriptionText = "${device.displayName} battery is low"
+		map.isStateChange = true
+	} else {
+		map.value = cmd.batteryLevel
+	}
+	state.lastbatt = now()
+	result << createEvent(map)
+	if (device.latestValue("powerSupply") != "USB Cable"){
+		result << createEvent(name: "batteryStatus", value: "${map.value} % battery", displayed: false)
+	}
+	result
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.sensormultilevelv5.SensorMultilevelReport cmd){
+	def map = [:]
+	switch (cmd.sensorType) {
+		case 1:
+			map.name = "temperature"
+			def cmdScale = cmd.scale == 1 ? "F" : "C"
+			map.value = convertTemperatureIfNeeded(cmd.scaledSensorValue, cmdScale, cmd.precision)
+			map.unit = getTemperatureScale()
+			break
+		case 5:
+			map.name = "humidity"
+			map.value = cmd.scaledSensorValue.toInteger()
+			map.unit = "%"
+			break
+		default:
+			map.descriptionText = cmd.toString()
+	}
+	createEvent(map)
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.configurationv2.ConfigurationReport cmd) {
+	log.debug "ConfigurationReport: $cmd"
+	def result = []
+	def value
+	if (cmd.parameterNumber == 9 && cmd.configurationValue[0] == 1) {
+		value = "Battery"
+		result << createEvent(name: "powerSupply", value: value, displayed: false)
+	} else if (cmd.parameterNumber == 101){
+		result << response(configure())
+	}
+	result
+}
+
+def zwaveEvent(physicalgraph.zwave.Command cmd) {
+	log.debug "General zwaveEvent cmd: ${cmd}"
+	createEvent(descriptionText: cmd.toString(), isStateChange: false)
+}

devicetypes/smartthings/aeon-key-fob.src/aeon-key-fob.groovy

@@ -133,8 +133,8 @@ def updated() {
 }
 
 def initialize() {
-	// Arrival sensors only goes OFFLINE when Hub is off
-	sendEvent(name: "DeviceWatch-Enroll", value: JsonOutput.toJson([protocol: "zigbee", scheme:"untracked"]), displayed: false)
+	// Device only goes OFFLINE when Hub is off
+	sendEvent(name: "DeviceWatch-Enroll", value: JsonOutput.toJson([protocol: "zwave", scheme:"untracked"]), displayed: false)
 
 	def zwMap = getZwaveInfo()
 	def buttons = 4 // Default for Key Fob

devicetypes/smartthings/aeon-minimote.src/aeon-minimote.groovy

@@ -111,7 +111,6 @@ def configure() {
 	return cmds
 }
 
-
 def installed() {
 	initialize()
 }
@@ -121,7 +120,7 @@ def updated() {
 }
 
 def initialize() {
-	// Arrival sensors only goes OFFLINE when Hub is off
-	sendEvent(name: "DeviceWatch-Enroll", value: JsonOutput.toJson([protocol: "zigbee", scheme:"untracked"]), displayed: false)
+	// Device only goes OFFLINE when Hub is off
+	sendEvent(name: "DeviceWatch-Enroll", value: JsonOutput.toJson([protocol: "zwave", scheme:"untracked"]), displayed: false)
 	sendEvent(name: "numberOfButtons", value: 4)
 }

devicetypes/smartthings/zwave-siren.src/zwave-siren.groovy

@@ -72,7 +72,7 @@ def createEvents(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {
 
 def poll() {
 	if (secondsPast(state.lastbatt, 36*60*60)) {
-		return zwave.batteryV1.batteryGet().format
+		return zwave.batteryV1.batteryGet().format()
 	} else {
 		return null
 	}