MSA-2341: add xiomi sensor

devicetypes/a4refillpad/xiaomi-door-window-sensor.src/xiaomi-door-window-sensor.groovy

@@ -0,0 +1,284 @@
+/**
+ *  Xiaomi Door/Window Sensor
+ *
+ *
+ *  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 original DH by Eric Maycock 2015 and Rave from Lazcad
+ *  change log:
+ *	added DH Colours
+ *  added 100% battery max
+ *  fixed battery parsing problem
+ *  added lastcheckin attribute and tile
+ *  added extra tile to show when last opened
+ *  colours to confirm to new smartthings standards
+ *  added ability to force override current state to Open or Closed.
+ *  added experimental health check as worked out by rolled54.Why
+ *
+ */
+metadata {
+   definition (name: "Xiaomi Door/Window Sensor", namespace: "a4refillpad", author: "a4refillpad") {
+   capability "Configuration"
+   capability "Sensor"
+   capability "Contact Sensor"
+   capability "Refresh"
+   capability "Battery"
+   capability "Health Check"
+   
+   attribute "lastCheckin", "String"
+   attribute "lastOpened", "String"
+   
+   fingerprint profileId: "0104", deviceId: "0104", inClusters: "0000, 0003", outClusters: "0000, 0004, 0003, 0006, 0008, 0005", manufacturer: "LUMI", model: "lumi.sensor_magnet", deviceJoinName: "Xiaomi Door Sensor"
+   
+   command "enrollResponse"
+   command "resetClosed"
+   command "resetOpen"
+ 
+   }
+    
+   simulator {
+      status "closed": "on/off: 0"
+      status "open": "on/off: 1"
+   }
+    
+   tiles(scale: 2) {
+      multiAttributeTile(name:"contact", type: "generic", width: 6, height: 4){
+         tileAttribute ("device.contact", key: "PRIMARY_CONTROL") {
+            attributeState "open", label:'${name}', icon:"st.contact.contact.open", backgroundColor:"#e86d13"
+            attributeState "closed", label:'${name}', icon:"st.contact.contact.closed", backgroundColor:"#00a0dc"
+         }
+            tileAttribute("device.lastCheckin", key: "SECONDARY_CONTROL") {
+    			attributeState("default", label:'Last Update: ${currentValue}',icon: "st.Health & Wellness.health9")
+            }
+      }
+      standardTile("icon", "device.refresh", inactiveLabel: false, decoration: "flat", width: 4, height: 1) {
+            state "default", label:'Last Opened:', icon:"st.Entertainment.entertainment15"
+      }
+      valueTile("lastopened", "device.lastOpened", decoration: "flat", inactiveLabel: false, width: 4, height: 1) {
+			state "default", label:'${currentValue}'
+	  }
+      valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
+			state "battery", label:'${currentValue}% battery', unit:""
+	  }  	
+      standardTile("resetClosed", "device.resetClosed", inactiveLabel: false, decoration: "flat", width: 3, height: 1) {
+			state "default", action:"resetClosed", label: "Override Close", icon:"st.contact.contact.closed"
+	  }
+	  standardTile("resetOpen", "device.resetOpen", inactiveLabel: false, decoration: "flat", width: 3, height: 1) {
+			state "default", action:"resetOpen", label: "Override Open", icon:"st.contact.contact.open"
+	  }
+      
+
+      main (["contact"])
+      details(["contact","battery","icon","lastopened","resetClosed","resetOpen"])
+   }
+}
+
+def parse(String description) {
+   log.debug "Parsing '${description}'"
+   
+//  send event for heartbeat    
+   def now = new Date().format("yyyy MMM dd EEE h:mm:ss a", location.timeZone)
+   sendEvent(name: "lastCheckin", value: now)
+    
+   Map map = [:]
+
+   log.debug "${resultMap}"
+   if (description?.startsWith('on/off: ')) {
+      map = parseCustomMessage(description) 
+      sendEvent(name: "lastOpened", value: now)
+	}
+   if (description?.startsWith('catchall:')) 
+      map = parseCatchAllMessage(description)
+   log.debug "Parse returned $map"
+   def results = map ? createEvent(map) : null
+
+   return results;
+}
+
+private Map getBatteryResult(rawValue) {
+	log.debug 'Battery'
+	def linkText = getLinkText(device)
+
+	log.debug rawValue
+
+	def result = [
+		name: 'battery',
+		value: '--'
+	]
+    
+	def volts = rawValue / 1
+    def maxVolts = 100
+
+	if (volts > maxVolts) {
+				volts = maxVolts
+    }
+   
+    result.value = volts
+	result.descriptionText = "${linkText} battery was ${result.value}%"
+
+	return result
+}
+
+private Map parseCatchAllMessage(String description) {
+	Map resultMap = [:]
+	def cluster = zigbee.parse(description)
+	log.debug cluster
+	if (cluster) {
+		switch(cluster.clusterId) {
+			case 0x0000:
+			resultMap = getBatteryResult(cluster.data.get(23))
+			break
+
+			case 0xFC02:
+			log.debug 'ACCELERATION'
+			break
+
+			case 0x0402:
+			log.debug 'TEMP'
+				// temp is last 2 data values. reverse to swap endian
+				String temp = cluster.data[-2..-1].reverse().collect { cluster.hex1(it) }.join()
+				def value = getTemperature(temp)
+				resultMap = getTemperatureResult(value)
+				break
+		}
+	}
+
+	return resultMap
+}
+
+private boolean shouldProcessMessage(cluster) {
+	// 0x0B is default response indicating message got through
+	// 0x07 is bind message
+	boolean ignoredMessage = cluster.profileId != 0x0104 ||
+	cluster.command == 0x0B ||
+	cluster.command == 0x07 ||
+	(cluster.data.size() > 0 && cluster.data.first() == 0x3e)
+	return !ignoredMessage
+}
+
+
+def configure() {
+	String zigbeeEui = swapEndianHex(device.hub.zigbeeEui)
+	log.debug "${device.deviceNetworkId}"
+    def endpointId = 1
+    log.debug "${device.zigbeeId}"
+    log.debug "${zigbeeEui}"
+	def configCmds = [
+			//battery reporting and heartbeat
+			"zdo bind 0x${device.deviceNetworkId} 1 ${endpointId} 1 {${device.zigbeeId}} {}", "delay 200",
+			"zcl global send-me-a-report 1 0x20 0x20 600 3600 {01}", "delay 200",
+			"send 0x${device.deviceNetworkId} 1 ${endpointId}", "delay 1500",
+
+
+			// Writes CIE attribute on end device to direct reports to the hub's EUID
+			"zcl global write 0x500 0x10 0xf0 {${zigbeeEui}}", "delay 200",
+			"send 0x${device.deviceNetworkId} 1 1", "delay 500",
+	]
+
+	log.debug "configure: Write IAS CIE"
+	return configCmds
+}
+
+def enrollResponse() {
+	log.debug "Enrolling device into the IAS Zone"
+	[
+			// Enrolling device into the IAS Zone
+			"raw 0x500 {01 23 00 00 00}", "delay 200",
+			"send 0x${device.deviceNetworkId} 1 1"
+	]
+}
+
+/*
+def refresh() {
+	log.debug "Refreshing Battery"
+    def endpointId = 0x01
+	[
+	    "st rattr 0x${device.deviceNetworkId} ${endpointId} 0x0000 0x0000", "delay 200"
+
+	] //+ enrollResponse()
+}
+*/
+
+def refresh() {
+	log.debug "refreshing"
+    [
+        "st rattr 0x${device.deviceNetworkId} 1 0 0", "delay 500",
+        "st rattr 0x${device.deviceNetworkId} 1 0", "delay 250",
+    ]
+}
+
+
+private Map parseCustomMessage(String description) {
+   def result
+   if (description?.startsWith('on/off: ')) {
+      if (description == 'on/off: 0') 		//contact closed
+         result = getContactResult("closed")
+      else if (description == 'on/off: 1') 	//contact opened
+         result = getContactResult("open")
+      return result
+   }
+}
+
+private Map getContactResult(value) {
+   def linkText = getLinkText(device)
+   def descriptionText = "${linkText} was ${value == 'open' ? 'opened' : 'closed'}"
+   return [
+      name: 'contact',
+      value: value,
+      descriptionText: descriptionText
+	]
+}
+
+private String swapEndianHex(String hex) {
+	reverseArray(hex.decodeHex()).encodeHex()
+}
+private getEndpointId() {
+	new BigInteger(device.endpointId, 16).toString()
+}
+
+Integer convertHexToInt(hex) {
+	Integer.parseInt(hex,16)
+}
+
+private byte[] reverseArray(byte[] array) {
+	int i = 0;
+	int j = array.length - 1;
+	byte tmp;
+
+	while (j > i) {
+		tmp = array[j];
+		array[j] = array[i];
+		array[i] = tmp;
+		j--;
+		i++;
+	}
+
+	return array
+}
+
+def resetClosed() {
+	sendEvent(name:"contact", value:"closed")
+} 
+
+def resetOpen() {
+	sendEvent(name:"contact", value:"open")
+}
+
+def installed() {
+// Device wakes up every 1 hour, this interval allows us to miss one wakeup notification before marking offline
+	log.debug "Configured health checkInterval when installed()"
+	sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 2 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
+}
+
+def updated() {
+// Device wakes up every 1 hours, this interval allows us to miss one wakeup notification before marking offline
+	log.debug "Configured health checkInterval when updated()"
+	sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 2 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
+}

devicetypes/a4refillpad/xiaomi-motion-sensor.src/xiaomi-motion-sensor.groovy

@@ -0,0 +1,332 @@
+/**
+ *  Xiaomi Motion Sensor
+ *
+ *
+ *  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 original DH by Eric Maycock 2015
+ * modified 29/12/2016 a4refillpad 
+ * Added fingerprinting
+ * Added heartbeat/lastcheckin for monitoring
+ * Added battery and refresh 
+ * Motion background colours consistent with latest DH
+ * Fixed max battery percentage to be 100%
+ * Added Last update to main tile
+ * Added last motion tile
+ * Heartdeat icon plus improved localisation of date
+ * removed non working tiles and changed layout and incorporated latest colours
+ * added experimental health check as worked out by rolled54.Why
+ *
+ */
+
+metadata {
+	definition (name: "Xiaomi Motion Sensor", namespace: "a4refillpad", author: "a4refillpad") {
+		capability "Motion Sensor"
+		capability "Configuration"
+		capability "Battery"
+		capability "Sensor"
+		capability "Refresh"
+        capability "Health Check" 
+        
+        attribute "lastCheckin", "String"
+        attribute "lastMotion", "String"
+
+    	fingerprint profileId: "0104", deviceId: "0104", inClusters: "0000, 0003, FFFF, 0019", outClusters: "0000, 0004, 0003, 0006, 0008, 0005, 0019", manufacturer: "LUMI", model: "lumi.sensor_motion", deviceJoinName: "Xiaomi Motion"
+        
+        command "reset"
+        
+	}
+
+	simulator {
+	}
+
+	preferences {
+		input "motionReset", "number", title: "Number of seconds after the last reported activity to report that motion is inactive (in seconds). \n\n(The device will always remain blind to motion for 60seconds following first detected motion. This value just clears the 'active' status after the number of seconds you set here but the device will still remain blind for 60seconds in normal operation.)", description: "", value:120, displayDuringSetup: false
+	}
+
+	tiles(scale: 2) {
+		multiAttributeTile(name:"motion", type: "generic", width: 6, height: 4){
+			tileAttribute ("device.motion", key: "PRIMARY_CONTROL") {
+				attributeState "active", label:'motion', icon:"st.motion.motion.active", backgroundColor:"#00a0dc"
+				attributeState "inactive", label:'no motion', icon:"st.motion.motion.inactive", backgroundColor:"#ffffff"
+			}
+            tileAttribute("device.lastCheckin", key: "SECONDARY_CONTROL") {
+    			attributeState("default", label:'Last Update: ${currentValue}',icon: "st.Health & Wellness.health9")
+            }
+		}
+		valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
+			state "battery", label:'${currentValue}% battery', unit:""
+		}
+              
+	    standardTile("refresh", "device.refresh", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
+            state "default", action:"refresh.refresh", icon:"st.secondary.refresh"
+        }
+        standardTile("configure", "device.configure", inactiveLabel: false, width: 2, height: 2, decoration: "flat") {
+			state "configure", label:'', action:"configuration.configure", icon:"st.secondary.configure"
+	    }       
+        
+		standardTile("reset", "device.reset", inactiveLabel: false, decoration: "flat", width: 2, height: 1) {
+			state "default", action:"reset", label: "Reset Motion"
+		}
+		standardTile("icon", "device.refresh", inactiveLabel: false, decoration: "flat", width: 4, height: 1) {
+            state "default", label:'Last Motion:', icon:"st.Entertainment.entertainment15"
+        }
+        valueTile("lastmotion", "device.lastMotion", decoration: "flat", inactiveLabel: false, width: 4, height: 1) {
+			state "default", label:'${currentValue}'
+        }
+
+		main(["motion"])
+		details(["motion", "battery", "icon", "lastmotion", "reset" ])
+	}
+}
+
+def parse(String description) {
+	log.debug "description: $description"
+    def value = zigbee.parse(description)?.text
+    log.debug "Parse: $value"
+	Map map = [:]
+	if (description?.startsWith('catchall:')) {
+		map = parseCatchAllMessage(description)
+	}
+	else if (description?.startsWith('read attr -')) {
+		map = parseReportAttributeMessage(description)
+	}
+ 
+	log.debug "Parse returned $map"
+	def result = map ? createEvent(map) : null
+//  send event for heartbeat    
+    def now = new Date().format("yyyy MMM dd EEE h:mm:ss a", location.timeZone)
+    sendEvent(name: "lastCheckin", value: now)
+    
+    if (description?.startsWith('enroll request')) {
+    	List cmds = enrollResponse()
+        log.debug "enroll response: ${cmds}"
+        result = cmds?.collect { new physicalgraph.device.HubAction(it) }
+    }
+
+       return result
+}
+
+private Map getBatteryResult(rawValue) {
+	log.debug 'Battery'
+	def linkText = getLinkText(device)
+
+	log.debug rawValue
+
+	def result = [
+		name: 'battery',
+		value: '--'
+	]
+    
+	def volts = rawValue / 1
+    
+    def maxVolts = 100
+
+	if (volts > maxVolts) {
+				volts = maxVolts
+    }
+   
+    result.value = volts
+	result.descriptionText = "${linkText} battery was ${result.value}%"
+
+	return result
+}
+
+private Map parseCatchAllMessage(String description) {
+	Map resultMap = [:]
+	def cluster = zigbee.parse(description)
+	log.debug cluster
+	if (shouldProcessMessage(cluster)) {
+		switch(cluster.clusterId) {
+			case 0x0000:
+			resultMap = getBatteryResult(cluster.data.last())
+			break
+
+			case 0xFC02:
+			log.debug 'ACCELERATION'
+			break
+
+			case 0x0402:
+			log.debug 'TEMP'
+				// temp is last 2 data values. reverse to swap endian
+				String temp = cluster.data[-2..-1].reverse().collect { cluster.hex1(it) }.join()
+				def value = getTemperature(temp)
+				resultMap = getTemperatureResult(value)
+				break
+		}
+	}
+
+	return resultMap
+}
+
+private boolean shouldProcessMessage(cluster) {
+	// 0x0B is default response indicating message got through
+	// 0x07 is bind message
+	boolean ignoredMessage = cluster.profileId != 0x0104 ||
+	cluster.command == 0x0B ||
+	cluster.command == 0x07 ||
+	(cluster.data.size() > 0 && cluster.data.first() == 0x3e)
+	return !ignoredMessage
+}
+
+
+def configure() {
+	String zigbeeEui = swapEndianHex(device.hub.zigbeeEui)
+	log.debug "${device.deviceNetworkId}"
+    def endpointId = 1
+    log.debug "${device.zigbeeId}"
+    log.debug "${zigbeeEui}"
+	def configCmds = [
+			//battery reporting and heartbeat
+			"zdo bind 0x${device.deviceNetworkId} 1 ${endpointId} 1 {${device.zigbeeId}} {}", "delay 200",
+			"zcl global send-me-a-report 1 0x20 0x20 600 3600 {01}", "delay 200",
+			"send 0x${device.deviceNetworkId} 1 ${endpointId}", "delay 1500",
+
+
+			// Writes CIE attribute on end device to direct reports to the hub's EUID
+			"zcl global write 0x500 0x10 0xf0 {${zigbeeEui}}", "delay 200",
+			"send 0x${device.deviceNetworkId} 1 1", "delay 500",
+	]
+
+	log.debug "configure: Write IAS CIE"
+	return configCmds
+}
+
+def enrollResponse() {
+	log.debug "Enrolling device into the IAS Zone"
+	[
+			// Enrolling device into the IAS Zone
+			"raw 0x500 {01 23 00 00 00}", "delay 200",
+			"send 0x${device.deviceNetworkId} 1 1"
+	]
+}
+
+def refresh() {
+	log.debug "Refreshing Battery"
+    def endpointId = 0x01
+	[
+	    "st rattr 0x${device.deviceNetworkId} ${endpointId} 0x0000 0x0000", "delay 200"
+//	    "st rattr 0x${device.deviceNetworkId} ${endpointId} 0x0000", "delay 200"
+	] //+ enrollResponse()
+}
+
+private Map parseReportAttributeMessage(String description) {
+	Map descMap = (description - "read attr - ").split(",").inject([:]) { map, param ->
+		def nameAndValue = param.split(":")
+		map += [(nameAndValue[0].trim()):nameAndValue[1].trim()]
+	}
+	//log.debug "Desc Map: $descMap"
+ 
+	Map resultMap = [:]
+    def now = new Date().format("yyyy MMM dd EEE h:mm:ss a", location.timeZone)
+   
+	if (descMap.cluster == "0001" && descMap.attrId == "0020") {
+		resultMap = getBatteryResult(Integer.parseInt(descMap.value, 16))
+	}
+    else if (descMap.cluster == "0406" && descMap.attrId == "0000") {
+    	def value = descMap.value.endsWith("01") ? "active" : "inactive"
+	    sendEvent(name: "lastMotion", value: now)
+        if (settings.motionReset == null || settings.motionReset == "" ) settings.motionReset = 120
+        if (value == "active") runIn(settings.motionReset, stopMotion)
+    	resultMap = getMotionResult(value)
+    } 
+	return resultMap
+}
+ 
+private Map parseCustomMessage(String description) {
+	Map resultMap = [:]
+	return resultMap
+}
+
+private Map parseIasMessage(String description) {
+    List parsedMsg = description.split(' ')
+    String msgCode = parsedMsg[2]
+    
+    Map resultMap = [:]
+    switch(msgCode) {
+        case '0x0020': // Closed/No Motion/Dry
+        	resultMap = getMotionResult('inactive')
+            break
+
+        case '0x0021': // Open/Motion/Wet
+        	resultMap = getMotionResult('active')
+            break
+
+        case '0x0022': // Tamper Alarm
+        	log.debug 'motion with tamper alarm'
+        	resultMap = getMotionResult('active')
+            break
+
+        case '0x0023': // Battery Alarm
+            break
+
+        case '0x0024': // Supervision Report
+        	log.debug 'no motion with tamper alarm'
+        	resultMap = getMotionResult('inactive')
+            break
+
+        case '0x0025': // Restore Report
+            break
+
+        case '0x0026': // Trouble/Failure
+        	log.debug 'motion with failure alarm'
+        	resultMap = getMotionResult('active')
+            break
+
+        case '0x0028': // Test Mode
+            break
+    }
+    return resultMap
+}
+
+
+private Map getMotionResult(value) {
+	log.debug 'motion'
+	String linkText = getLinkText(device)
+	String descriptionText = value == 'active' ? "${linkText} detected motion" : "${linkText} motion has stopped"
+	def commands = [
+		name: 'motion',
+		value: value,
+		descriptionText: descriptionText
+	] 
+    return commands
+}
+
+private byte[] reverseArray(byte[] array) {
+    byte tmp;
+    tmp = array[1];
+    array[1] = array[0];
+    array[0] = tmp;
+    return array
+}
+
+private String swapEndianHex(String hex) {
+    reverseArray(hex.decodeHex()).encodeHex()
+}
+
+def stopMotion() {
+   sendEvent(name:"motion", value:"inactive")
+}
+
+def reset() {
+	sendEvent(name:"motion", value:"inactive")
+}
+
+def installed() {
+// Device wakes up every 1 hour, this interval allows us to miss one wakeup notification before marking offline
+	log.debug "Configured health checkInterval when installed()"
+	sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 2 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
+}
+
+def updated() {
+// Device wakes up every 1 hours, this interval allows us to miss one wakeup notification before marking offline
+	log.debug "Configured health checkInterval when updated()"
+	sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 2 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
+}