I ended up modifing the Centralite keypad device handler created by mitchpond to work with the Xfinity XHK1-UE Keypad.
/**
* Xfinity UEI Keypad
*
* Copyright 2015-2016 Mitch Pond, Zack Cornelius
*
* 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.
*
*/
metadata {
definition (name: "UEI Keypad", namespace: "mitchpond", author: "Mitch Pond") {
capability "Battery"
capability "Configuration"
capability "Motion Sensor"
capability "Sensor"
capability "Temperature Measurement"
capability "Refresh"
capability "Lock Codes"
capability "Tamper Alert"
capability "Tone"
capability "button"
capability "polling"
capability "Contact Sensor"
attribute "armMode", "String"
attribute "lastUpdate", "String"
command "setDisarmed"
command "setArmedAway"
command "setArmedStay"
command "setArmedNight"
command "setExitDelay", ['number']
command "setEntryDelay", ['number']
command "testCmd"
command "sendInvalidKeycodeResponse"
command "acknowledgeArmRequest"
fingerprint endpointId: "01", profileId: "0104", deviceId: "0401", inClusters: "0000,0001,0003,0020,0402,0500,0B05", outClusters: "0003,0019,0501", manufacturer: "Universal Electronics Inc", model: "URC4450BC0-X-R", deviceJoinName: "Xfinity XHK1-UE Keypad"
}
preferences{
input ("tempOffset", "number", title: "Enter an offset to adjust the reported temperature",
defaultValue: 0, displayDuringSetup: false)
input ("beepLength", "number", title: "Enter length of beep in seconds",
defaultValue: 1, displayDuringSetup: false)
input ("motionTime", "number", title: "Time in seconds for Motion to become Inactive (Default:10, 0=disabled)", defaultValue: 10, displayDuringSetup: false)
}
tiles (scale: 2) {
multiAttributeTile(name: "keypad", type:"generic", width:6, height:4, canChangeIcon: true) {
tileAttribute ("device.armMode", key: "PRIMARY_CONTROL") {
attributeState("disarmed", label:'${currentValue}', icon:"st.Home.home2", backgroundColor:"#44b621")
attributeState("armedStay", label:'ARMED/STAY', icon:"st.Home.home3", backgroundColor:"#ffa81e")
attributeState("armedAway", label:'ARMED/AWAY', icon:"st.nest.nest-away", backgroundColor:"#d04e00")
}
tileAttribute("device.lastUpdate", key: "SECONDARY_CONTROL") {
attributeState("default", label:'Updated: ${currentValue}')
}
/*
tileAttribute("device.battery", key: "SECONDARY_CONTROL") {
attributeState("default", label:'Battery: ${currentValue}%', unit:"%")
}
tileAttribute("device.battery", key: "VALUE_CONTROL") {
attributeState "VALUE_UP", action: "refresh"
attributeState "VALUE_DOWN", action: "refresh"
}
*/
tileAttribute("device.temperature", key: "VALUE_CONTROL") {
attributeState "VALUE_UP", action: "refresh"
attributeState "VALUE_DOWN", action: "refresh"
}
}
valueTile("temperature", "device.temperature", 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"]
]
}
standardTile("motion", "device.motion", decoration: "flat", canChangeBackground: true, width: 2, height: 2) {
state "active", label:'motion',icon:"st.motion.motion.active", backgroundColor:"#53a7c0"
state "inactive", label:'no motion',icon:"st.motion.motion.inactive", backgroundColor:"#ffffff"
}
standardTile("tamper", "device.tamper", decoration: "flat", canChangeBackground: true, width: 2, height: 2) {
state "clear", label: 'Tamper', icon:"st.motion.acceleration.inactive", backgroundColor: "#ffffff"
state "detected", label: 'Tamper', icon:"st.motion.acceleration.active", backgroundColor:"#cc5c5c"
}
standardTile("Panic", "device.contact", decoration: "flat", canChangeBackground: true, width: 2, height: 2) {
state "open", label: 'Panic', icon:"st.security.alarm.alarm", backgroundColor: "#ffffff"
state "closed", label: 'Panic', icon:"st.security.alarm.clear", backgroundColor:"#bc2323"
}
standardTile("Mode", "device.armMode", decoration: "flat", canChangeBackground: true, width: 2, height: 2) {
state "disarmed", label:'OFF', icon:"st.Home.home2", backgroundColor:"#44b621"
state "armedStay", label:'OFF', icon:"st.Home.home3", backgroundColor:"#ffffff"
state "armedAway", label:'OFF', icon:"st.net.nest-away", backgroundColor:"#ffffff"
}
standardTile("beep", "device.beep", decoration: "flat", width: 2, height: 2) {
state "default", action:"tone.beep", icon:"st.secondary.beep", backgroundColor:"#ffffff"
}
valueTile("battery", "device.battery", decoration: "flat", 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, decoration: "flat", width: 2, height: 2) {
state "default", action:"configuration.configure", icon:"st.secondary.configure"
}
valueTile("armMode", "device.armMode", decoration: "flat", width: 2, height: 2) {
state "armMode", label: '${currentValue}'
}
main (["keypad"])
details (["keypad","motion","tamper","Panic","Mode","beep","refresh","battery"])
}
}
// parse events into attributes
def parse(String description) {
log.debug "Parsing '${description}'";
def results = [];
//------Miscellaneous Zigbee message------//
if (description?.startsWith('catchall:')) {
//log.debug zigbee.parse(description);
def message = zigbee.parse(description);
//------Profile-wide command (rattr responses, errors, etc.)------//
if (message?.isClusterSpecific == false) {
//------Default response------//
if (message?.command == 0x0B) {
if (message?.data[1] == 0x81)
log.error "Device: unrecognized command: "+description;
else if (message?.data[1] == 0x80)
log.error "Device: malformed command: "+description;
}
//------Read attributes responses------//
else if (message?.command == 0x01) {
if (message?.clusterId == 0x0402) {
log.debug "Device: read attribute response: "+description;
results = parseTempAttributeMsg(message)
}}
else
log.debug "Unhandled profile-wide command: "+description;
}
//------Cluster specific commands------//
else if (message?.isClusterSpecific) {
//------IAS ACE------//
if (message?.clusterId == 0x0501) {
if (message?.command == 0x07) {
motionON()
}
else if (message?.command == 0x04) {
results = createEvent(name: "button", value: "pushed", data: [buttonNumber: 1], descriptionText: "$device.displayName panic button was pushed", isStateChange: true)
panicContact()
}
else if (message?.command == 0x00) {
results = handleArmRequest(message)
log.trace results
}
}
else log.debug "Unhandled cluster-specific command: "+description
}
}
//------IAS Zone Enroll request------//
else if (description?.startsWith('enroll request')) {
log.debug "Sending IAS enroll response..."
results = zigbee.enrollResponse()
}
//------Read Attribute response------//
else if (description?.startsWith('read attr -')) {
results = parseReportAttributeMessage(description)
}
//------Temperature Report------//
else if (description?.startsWith('temperature: ')) {
log.debug "Got ST-style temperature report.."
results = createEvent(getTemperatureResult(zigbee.parseHATemperatureValue(description, "temperature: ", getTemperatureScale())))
log.debug results
}
else if (description?.startsWith('zone status ')) {
results = parseIasMessage(description)
}
return results
}
def configure() {
log.debug "--- Configure Called"
String hubZigbeeId = swapEndianHex(device.hub.zigbeeEui)
def cmd = [
//------IAS Zone/CIE setup------//
"zcl global write 0x500 0x10 0xf0 {${hubZigbeeId}}", "delay 100",
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", "delay 200",
//------Set up binding------//
"zdo bind 0x${device.deviceNetworkId} 1 1 0x500 {${device.zigbeeId}} {}", "delay 200",
"zdo bind 0x${device.deviceNetworkId} 1 1 0x501 {${device.zigbeeId}} {}", "delay 200",
] +
zigbee.batteryConfig(3600, 43200, 0x01) +
zigbee.temperatureConfig(30, 3600, 0x0064)
runIn(10, refresh)
return cmd
}
def poll() {
refresh()
}
def refresh() {
return sendStatusToDevice() +
zigbee.readAttribute(zigbee.POWER_CONFIGURATION_CLUSTER, 0x20) + // Battery Volts
zigbee.readAttribute(zigbee.TEMPERATURE_MEASUREMENT_CLUSTER, 0x00) // Temperature
}
private formatLocalTime(time, format = "EEE, MMM d yyyy @ h:mm a z") {
if (time instanceof Long) {
time = new Date(time)
}
if (time instanceof String) {
//get UTC time
time = timeToday(time, location.timeZone)
}
if (!(time instanceof Date)) {
return null
}
def formatter = new java.text.SimpleDateFormat(format)
formatter.setTimeZone(location.timeZone)
return formatter.format(time)
}
private 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"
def results = []
if (descMap.cluster == "0001" && descMap.attrId == "0020") {
log.debug "Received battery level report"
results = createEvent(getBatteryResult(Integer.parseInt(descMap.value, 16)))
}
else if (descMap.cluster == "0001" && descMap.attrId == "0034")
{
log.debug "Received Battery Rated Voltage: ${descMap.value}"
}
else if (descMap.cluster == "0001" && descMap.attrId == "0036")
{
log.debug "Received Battery Alarm Voltage: ${descMap.value}"
}
else if (descMap.cluster == "0402" && descMap.attrId == "0000") {
def value = getTemperature(descMap.value)
results = createEvent(getTemperatureResult(value))
}
return results
}
private parseTempAttributeMsg(message) {
byte[] temp = message.data[-2..-1].reverse()
createEvent(getTemperatureResult(getTemperature(temp.encodeHex() as String)))
}
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
case '0x0000':
resultMap = createEvent(name: "tamper", value: "clear", isStateChange: true, displayed: false)
break
case '0x0004':
resultMap = createEvent(name: "tamper", value: "detected", isStateChange: true, displayed: false)
break;
default:
log.debug "Invalid message code in IAS message: ${msgCode}"
}
return resultMap
}
private Map getMotionResult(value) {
String linkText = getLinkText(device)
String descriptionText = value == 'active' ? "${linkText} detected motion" : "${linkText} motion has stopped"
return [
name: 'motion',
value: value,
descriptionText: descriptionText
]
}
def motionON() {
log.debug "--- Motion Detected"
sendEvent(name: "motion", value: "active", displayed:true, isStateChange: true)
//-- Calculate Inactive timeout value
def motionTimeRun = (settings.motionTime?:0).toInteger()
//-- If Inactive timeout was configured
if (motionTimeRun > 0) {
log.debug "--- Will become inactive in $motionTimeRun seconds"
runIn(motionTimeRun, "motionOFF")
}
}
def motionOFF() {
log.debug "--- Motion Inactive (OFF)"
sendEvent(name: "motion", value: "inactive", displayed:true, isStateChange: true)
}
def panicContact() {
log.debug "--- Panic button hit"
sendEvent(name: "contact", value: "open", displayed: true, isStateChange: true)
runIn(3, "panicContactClose")
}
def panicContactClose()
{
sendEvent(name: "contact", value: "closed", displayed: true, isStateChange: true)
}
//Converts the battery level response into a percentage to display in ST
//and creates appropriate message for given level
private getBatteryResult(rawValue) {
def linkText = getLinkText(device)
def result = [name: 'battery']
def volts = rawValue / 10
def descriptionText
if (volts > 7.2) {
result.descriptionText = "${linkText} battery has too much power (${volts} volts)."
}
else {
def minVolts = 5.2
def maxVolts = 6.8
def pct = (volts - minVolts) / (maxVolts - minVolts)
result.value = Math.min(100, Math.round(pct * 100))
result.descriptionText = "${linkText} battery was ${result.value}%"
}
return result
}
private getTemperature(value) {
def celcius = Integer.parseInt(value, 16).shortValue() / 100
if(getTemperatureScale() == "C"){
return celcius
} else {
return celsiusToFahrenheit(celcius) as Integer
}
}
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
]
}
//------Command handlers------//
private handleArmRequest(message){
def keycode = new String(message.data[2..-2] as byte[],'UTF-8')
def reqArmMode = message.data[0]
//state.lastKeycode = keycode
log.debug "Received arm command with keycode/armMode: ${keycode}/${reqArmMode}"
//Acknowledge the command. This may not be *technically* correct, but it works
/*List cmds = [
"raw 0x501 {09 01 00 0${reqArmMode}}", "delay 200",
"send 0x${device.deviceNetworkId} 1 1", "delay 500"
]
def results = cmds?.collect { new physicalgraph.device.HubAction(it) } + createCodeEntryEvent(keycode, reqArmMode)
*/
def results = createCodeEntryEvent(keycode, reqArmMode)
log.trace "Method: handleArmRequest(message): "+results
return results
}
def createCodeEntryEvent(keycode, armMode) {
createEvent(name: "codeEntered", value: keycode as String, data: armMode as String,
isStateChange: true, displayed: false)
}
//
//The keypad seems to be expecting responses that are not in-line with the HA 1.2 spec. Maybe HA 1.3 or Zigbee 3.0??
//
private sendStatusToDevice() {
log.debug 'Sending status to device...'
def armMode = device.currentValue("armMode")
log.trace 'Arm mode: '+armMode
def status = ''
if (armMode == null || armMode == 'disarmed') status = 0
else if (armMode == 'armedAway') status = 3
else if (armMode == 'armedStay') status = 1
else if (armMode == 'armedNight') status = 2
// If we're not in one of the 4 basic modes, don't update the status, don't want to override beep timings, exit delay is dependent on it being correct
if (status != '')
{
return sendRawStatus(status)
}
else
{
return []
}
}
// Statuses:
// 00 - Disarmed
// 01 - Armed partial
// 02 - Armed partial
// 03 - Armed Away
// 04 - ?
// 05 - Fast beep (1 per second)
// 05 - Entry delay (Uses seconds) Appears to keep the status lights as it was
// 06 - Amber status blink (Ignores seconds)
// 07 - ?
// 08 - Red status blink
// 09 - ?
// 10 - Exit delay Slow beep (2 per second, accelerating to 1 beep per second for the last 10 seconds) - With red flashing status - Uses seconds
// 11 - ?
// 12 - ?
// 13 - ?
private sendRawStatus(status, seconds = 00) {
log.debug "Sending Status ${zigbee.convertToHexString(status)}${zigbee.convertToHexString(seconds)} to device..."
// Seems to require frame control 9, which indicates a "Server to client" cluster specific command (which seems backward? I thought the keypad was the server)
List cmds = ["raw 0x501 {09 01 04 ${zigbee.convertToHexString(status)}${zigbee.convertToHexString(seconds)}}",
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", 'delay 100']
def results = cmds?.collect { new physicalgraph.device.HubAction(it) };
return results
}
def notifyPanelStatusChanged(status) {
//TODO: not yet implemented. May not be needed.
}
//------------------------//
def setDisarmed() { setModeHelper("disarmed",0) }
def setArmedAway(def delay=0) { setModeHelper("armedAway",delay) }
def setArmedStay(def delay=0) { setModeHelper("armedStay",delay) }
def setArmedNight(def delay=0) { setModeHelper("armedNight",delay) }
def setEntryDelay(delay) {
setModeHelper("entryDelay", delay)
sendRawStatus(5, delay) // Entry delay beeps
}
def setExitDelay(delay) {
setModeHelper("exitDelay", delay)
sendRawStatus(10, delay) // Exit delay
}
private setModeHelper(String armMode, delay) {
sendEvent([name: "armMode", value: armMode, data: [delay: delay as int], isStateChange: true])
def lastUpdate = formatLocalTime(now())
sendEvent(name: "lastUpdate", value: lastUpdate, displayed: false)
sendStatusToDevice()
}
private setKeypadArmMode(armMode){
Map mode = [disarmed: '00', armedAway: '03', armedStay: '01', armedNight: '02', entryDelay: '', exitDelay: '']
if (mode[armMode] != '')
{
return ["raw 0x501 {09 01 04 ${mode[armMode]}00}",
"send 0x${device.deviceNetworkId} 1 1", 'delay 100']
}
}
def acknowledgeArmRequest(armMode){
List cmds = [
"raw 0x501 {09 01 00 0${armMode}}",
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", "delay 100"
]
def results = cmds?.collect { new physicalgraph.device.HubAction(it) }
log.trace "Method: acknowledgeArmRequest(armMode): "+results
return results
}
def sendInvalidKeycodeResponse(){
List cmds = [
"raw 0x501 {09 01 00 04}",
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", "delay 100"
]
log.trace 'Method: sendInvalidKeycodeResponse(): '+cmds
return (cmds?.collect { new physicalgraph.device.HubAction(it) }) + sendStatusToDevice()
}
def beep(def beepLength = settings.beepLength) {
if ( beepLength == null )
{
beepLength = 0
}
def len = zigbee.convertToHexString(beepLength, 2)
List cmds = ["raw 0x501 {09 01 04 05${len}}", 'delay 200',
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", 'delay 500']
runIn(beepLen, beepOff) // UEI keypad beep needs to be turned off
cmds
}
def beepOff() {
List cmds = ["raw 0x501 {09 01 04 0000}", 'delay 200',
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", 'delay 500']
cmds
}
//------Utility methods------//
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
}
//------------------------//
private testCmd(){
//log.trace zigbee.parse('catchall: 0104 0501 01 01 0140 00 4F2D 01 00 0000 07 00 ')
//beep(10)
//test exit delay
//log.debug device.zigbeeId
//testingTesting()
//discoverCmds()
//zigbee.configureReporting(1,0x20,0x20,3600,43200,0x01) //battery reporting
//["raw 0x0001 {00 00 06 00 2000 20 100E FEFF 01}",
//"send 0x${device.deviceNetworkId} 1 1"]
//zigbee.command(0x0003, 0x00, "0500") //Identify: blinks connection light
//log.debug //temperature reporting
return zigbee.readAttribute(0x0020,0x01) +
zigbee.readAttribute(0x0020,0x02) +
zigbee.readAttribute(0x0020,0x03)
}
private discoverCmds(){
List cmds = ["raw 0x0501 {08 01 11 0011}", 'delay 200',
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", 'delay 500']
cmds
}
private testingTesting() {
log.debug "Delay: "+device.currentState("armMode").toString()
List cmds = ["raw 0x501 {09 01 04 050A}", 'delay 200',
"send 0x${device.deviceNetworkId} ${device.endpointId as int} 1", 'delay 500']
cmds
}
I have this working with the SHM Delay Version 2.0 smartapp.
I’ve actually stopping using the keypad because it didn’t really fit into how I want to use smartthings. So I am probably going to list it on ebay again in the near future.
