/** * SmartSense Open/Closed Sensor * * Copyright 2014 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. * * Version: v1 * * Updates: * ------- * 02-27-2016 : Initial commit. Device handler for an Iris or SmartSense open/close sensor to be used as a doorbell. * 03-17-2016 : Due to ST's v2.1.0 app totally hosing up SECONDARY_CONTROL, implemented a workaround to display that info in a separate tile. * */ metadata { definition (name: "My SmartSense Doorbell Sensor", namespace: "jscgs350", author: "SmartThings") { capability "Battery" capability "Configuration" capability "Contact Sensor" capability "Refresh" capability "Temperature Measurement" command "enrollResponse" } preferences { input title: "Temperature Offset", description: "This feature allows you to correct any temperature variations by selecting an offset. Ex: If your sensor consistently reports a temp that's 5 degrees too warm, you'd enter \"-5\". If 3 degrees too cold, enter \"+3\".", displayDuringSetup: false, type: "paragraph", element: "paragraph" input "tempOffset", "number", title: "Degrees", description: "Adjust temperature by this many degrees", range: "*..*", displayDuringSetup: false } tiles(scale: 2) { multiAttributeTile(name:"contact", type: "lighting", width: 6, height: 4){ tileAttribute ("device.contact", key: "PRIMARY_CONTROL") { attributeState "open", label:'Ding Dong', icon:"st.Home.home30", backgroundColor: "#53a7c0" attributeState "closed", label:'Ding Dong', icon:"st.Home.home30", backgroundColor: "#53a7c0" } // tileAttribute ("statusText", key: "SECONDARY_CONTROL") { // attributeState "statusText", label:'${currentValue}' // } } valueTile("temperature", "device.temperature", inactiveLabel: false, width: 2, height: 2) { state "temperature", label:'${currentValue}°', backgroundColors:[ [value: 31, color: "#153591"], [value: 44, color: "#1e9cbb"], [value: 59, color: "#90d2a7"], [value: 74, color: "#44b621"], [value: 84, color: "#f1d801"], [value: 95, color: "#d04e00"], [value: 96, color: "#bc2323"] ] } 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" } valueTile("statusText", "statusText", inactiveLabel: false, decoration: "flat", width: 6, height: 2) { state "statusText", label:'${currentValue}', backgroundColor:"#ffffff" } main (["contact", "temperature"]) details(["contact","temperature","battery","refresh","statusText"]) } } def parse(String description) { log.debug "description: $description" Map map = [:] if (description?.startsWith('catchall:')) { map = parseCatchAllMessage(description) } else if (description?.startsWith('read attr -')) { map = parseReportAttributeMessage(description) } else if (description?.startsWith('temperature: ')) { map = parseCustomMessage(description) } else if (description?.startsWith('zone status')) { map = parseIasMessage(description) } log.debug "Parse returned $map" def result = map ? createEvent(map) : null 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 parseCatchAllMessage(String description) { Map resultMap = [:] def cluster = zigbee.parse(description) if (shouldProcessMessage(cluster)) { switch(cluster.clusterId) { case 0x0001: resultMap = getBatteryResult(cluster.data.last()) 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 } private int getHumidity(value) { return Math.round(Double.parseDouble(value)) } 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 = [:] if (descMap.cluster == "0402" && descMap.attrId == "0000") { def value = getTemperature(descMap.value) resultMap = getTemperatureResult(value) } else if (descMap.cluster == "0001" && descMap.attrId == "0020") { resultMap = getBatteryResult(Integer.parseInt(descMap.value, 16)) } return resultMap } private Map parseCustomMessage(String description) { Map resultMap = [:] if (description?.startsWith('temperature: ')) { def value = zigbee.parseHATemperatureValue(description, "temperature: ", getTemperatureScale()) resultMap = getTemperatureResult(value) } 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 = getContactResult('closed') break case '0x0021': // Open/Motion/Wet resultMap = getContactResult('open') break case '0x0022': // Tamper Alarm break case '0x0023': // Battery Alarm break case '0x0024': // Supervision Report resultMap = getContactResult('closed') break case '0x0025': // Restore Report resultMap = getContactResult('open') break case '0x0026': // Trouble/Failure break case '0x0028': // Test Mode break } return resultMap } def getTemperature(value) { def celsius = Integer.parseInt(value, 16).shortValue() / 100 if(getTemperatureScale() == "C"){ return celsius } else { return celsiusToFahrenheit(celsius) as Integer } } private Map getBatteryResult(rawValue) { log.debug 'Battery' def linkText = getLinkText(device) def result = [ name: 'battery' ] def volts = rawValue / 10 def descriptionText if (volts > 3.5) { result.descriptionText = "${linkText} battery has too much power (${volts} volts)." } else { def minVolts = 2.1 def maxVolts = 3.0 def pct = (volts - minVolts) / (maxVolts - minVolts) result.value = Math.min(100, (int) pct * 100) result.descriptionText = "${linkText} battery was ${result.value}%" } return result } private Map getTemperatureResult(value) { log.debug 'TEMP' def linkText = getLinkText(device) if (tempOffset) { def offset = tempOffset as int def v = value as int value = v + offset } def descriptionText = "${linkText} was ${value}°${temperatureScale}" return [ name: 'temperature', value: value, descriptionText: descriptionText ] } private Map getContactResult(value) { log.debug 'Contact Status' def linkText = getLinkText(device) def descriptionText = "${linkText} was ${value == 'open' ? 'opened' : 'closed'}" def statusTextmsg = "" def timeString = new Date().format("MM-dd-yyyy h:mm a", location.timeZone) statusTextmsg = "Doorbell last rang at "+timeString sendEvent("name":"statusText", "value":statusTextmsg) return [ name: 'contact', value: value, descriptionText: descriptionText ] } def refresh() { log.debug "Refreshing Temperature and Battery" def refreshCmds = [ "st rattr 0x${device.deviceNetworkId} 1 0x402 0", "delay 200", "st rattr 0x${device.deviceNetworkId} 1 1 0x20", "delay 200" ] return refreshCmds + enrollResponse() } def configure() { String zigbeeEui = swapEndianHex(device.hub.zigbeeEui) log.debug "Configuring Reporting, IAS CIE, and Bindings." def configCmds = [ "zcl global write 0x500 0x10 0xf0 {${zigbeeEui}}", "delay 200", "send 0x${device.deviceNetworkId} 1 1", "delay 500", "zdo bind 0x${device.deviceNetworkId} ${endpointId} 1 1 {${device.zigbeeId}} {}", "delay 500", "zcl global send-me-a-report 1 0x20 0x20 30 21600 {01}", //checkin time 6 hrs "send 0x${device.deviceNetworkId} 1 1", "delay 500", "zdo bind 0x${device.deviceNetworkId} ${endpointId} 1 0x402 {${device.zigbeeId}} {}", "delay 500", "zcl global send-me-a-report 0x402 0 0x29 30 3600 {6400}", "send 0x${device.deviceNetworkId} 1 1", "delay 500" ] return configCmds + refresh() // send refresh cmds as part of config } def enrollResponse() { log.debug "Sending enroll response" String zigbeeEui = swapEndianHex(device.hub.zigbeeEui) [ //Resending the CIE in case the enroll request is sent before CIE is written "zcl global write 0x500 0x10 0xf0 {${zigbeeEui}}", "delay 200", "send 0x${device.deviceNetworkId} 1 ${endpointId}", "delay 500", //Enroll Response "raw 0x500 {01 23 00 00 00}", "send 0x${device.deviceNetworkId} 1 1", "delay 200" ] } private getEndpointId() { new BigInteger(device.endpointId, 16).toString() } private hex(value) { new BigInteger(Math.round(value).toString()).toString(16) } private String swapEndianHex(String hex) { reverseArray(hex.decodeHex()).encodeHex() } 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 }