Merge pull request SmartThingsCommunity#11453 from SmartThingsCommunity/acceptance

Rolling up acceptance to production for deploy

Author: greens

devicetypes/smartthings/ikea-button.src/ikea-button.groovy

@@ -0,0 +1,310 @@
+/**
+ *  Ikea Button
+ *
+ *  Copyright 2018
+ *
+ *  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.
+ *
+ */
+
+import groovy.json.JsonOutput
+import physicalgraph.zigbee.zcl.DataType
+
+metadata {
+	definition (name: "Ikea Button", namespace: "smartthings", author: "SmartThings", ocfDeviceType: "x.com.st.d.remotecontroller", mcdSync: true) {
+		capability "Actuator"
+		capability "Battery"
+		capability "Button"
+		capability "Holdable Button"
+		capability "Configuration"
+		capability "Sensor"
+		capability "Health Check"
+
+		fingerprint inClusters: "0000, 0001, 0003, 0009, 0B05, 1000", outClusters: "0003, 0004, 0005, 0006, 0008, 0019, 1000", manufacturer: "IKEA of Sweden", model: "TRADFRI remote control", deviceJoinName: "IKEA TRÅDFRI Remote", mnmn: "SmartThings", vid: "SmartThings-smartthings-IKEA_TRADFRI_Remote_Control"
+		fingerprint inClusters: "0000, 0001, 0003, 0009, 0102, 1000, FC7C", outClusters: "0003, 0004, 0006, 0008, 0019, 0102, 1000", manufacturer:"IKEA of Sweden", model: "TRADFRI on/off switch", deviceJoinName: "IKEA TRÅDFRI On/Off switch", mnmn: "SmartThings", vid: "SmartThings-smartthings-IKEA_TRADFRI_On/Off_Switch"
+	}
+
+	tiles {
+		standardTile("button", "device.button", width: 2, height: 2) {
+			state "default", label: "", icon: "st.unknown.zwave.remote-controller", backgroundColor: "#ffffff"
+			state "button 1 pushed", label: "pushed #1", icon: "st.unknown.zwave.remote-controller", backgroundColor: "#00A0DC"
+		}
+
+		valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false) {
+			state "battery", label:'${currentValue}% battery', unit:""
+		}
+
+		main (["button"])
+		details(["button", "battery"])
+	}
+}
+
+private getCLUSTER_GROUPS() { 0x0004 }
+private getCLUSTER_SCENES() { 0x0005 }
+
+private getREMOTE_BUTTONS() {
+	[TOP:1,
+	 RIGHT:2,
+	 BOTTOM:3,
+	 LEFT:4,
+	 MIDDLE:5]
+}
+
+private getONOFFSWITCH_BUTTONS() {
+	[TOP:2,
+	 BOTTOM:1]
+}
+
+private channelNumber(String dni) {
+	dni.split(":")[-1] as Integer
+}
+
+private getIkeaRemoteControlNames() {
+	[
+		"top button", //"Increase brightness button",
+		"right button", //"Right button",
+		"bottom button", //"Decrease brightness button",
+		"left button", //"Left button",
+		"middle button" //"On/Off button"
+	]
+}
+private getIkeaOnOffSwitchNames() {
+	[
+		"bottom button", //"On button",
+		"top button" //"Off button"
+	]
+}
+
+private getButtonLabel(buttonNum) {
+	def label = "Button ${buttonNum}"
+
+	if (isIkeaRemoteControl()) {
+		label = ikeaRemoteControlNames[buttonNum - 1]
+	} else if (isIkeaOnOffSwitch()) {
+		label = ikeaOnOffSwitchNames[buttonNum - 1]
+	}
+
+	return label
+}
+
+private getButtonName(buttonNum) {
+	return "${device.displayName} " + getButtonLabel(buttonNum)
+}
+
+private void createChildButtonDevices(numberOfButtons) {
+	state.oldLabel = device.label
+
+	log.debug "Creating $numberOfButtons children"
+
+	for (i in 1..numberOfButtons) {
+		log.debug "Creating child $i"
+		def supportedButtons = (isIkeaRemoteControl() && i == REMOTE_BUTTONS.MIDDLE) ? ["pushed"] : ["pushed", "held"]
+		def child = addChildDevice("Child Button", "${device.deviceNetworkId}:${i}", device.hubId,
+				[completedSetup: true, label: getButtonName(i),
+				 isComponent: true, componentName: "button$i", componentLabel: getButtonLabel(i)])
+
+		child.sendEvent(name: "supportedButtonValues", value: supportedButtons.encodeAsJSON(), displayed: false)
+		child.sendEvent(name: "numberOfButtons", value: 1, displayed: false)
+		child.sendEvent(name: "button", value: "pushed", data: [buttonNumber: 1], displayed: false)
+	}
+}
+
+def installed() {
+	def numberOfButtons = 1
+
+	if (isIkeaRemoteControl()) {
+		numberOfButtons = 5
+	} else if (isIkeaOnOffSwitch()) {
+		numberOfButtons = 2
+	}
+
+	if (numberOfButtons > 1) {
+		createChildButtonDevices(numberOfButtons)
+	}
+
+	sendEvent(name: "supportedButtonValues", value: ["pushed", "held"].encodeAsJSON(), displayed: false)
+	sendEvent(name: "numberOfButtons", value: numberOfButtons, displayed: false)
+	numberOfButtons.times {
+		sendEvent(name: "button", value: "pushed", data: [buttonNumber: it+1], displayed: false)
+	}
+
+	// These devices don't report regularly so they should only go OFFLINE when Hub is OFFLINE
+	sendEvent(name: "DeviceWatch-Enroll", value: JsonOutput.toJson([protocol: "zigbee", scheme:"untracked"]), displayed: false)
+}
+
+def updated() {
+	if (childDevices && device.label != state.oldLabel) {
+		childDevices.each {
+			def newLabel = getButtonName(channelNumber(it.deviceNetworkId))
+			it.setLabel(newLabel)
+		}
+		state.oldLabel = device.label
+	}
+}
+
+def configure() {
+	log.debug "Configuring device ${device.getDataValue("model")}"
+
+	def cmds = zigbee.configureReporting(zigbee.POWER_CONFIGURATION_CLUSTER, 0x21, DataType.UINT8, 30, 21600, 0x01) +
+			zigbee.readAttribute(zigbee.POWER_CONFIGURATION_CLUSTER, 0x21) +
+			zigbee.addBinding(zigbee.ONOFF_CLUSTER) +
+			readDeviceBindingTable() // Need to read the binding table to see what group it's using
+
+	cmds
+}
+
+def parse(String description) {
+	log.debug "Parsing message from device: '$description'"
+	def event = zigbee.getEvent(description)
+	if (event) {
+		log.debug "Creating event: ${event}"
+		sendEvent(event)
+	} else {
+		if ((description?.startsWith("catchall:")) || (description?.startsWith("read attr -"))) {
+			def descMap = zigbee.parseDescriptionAsMap(description)
+			if (descMap.clusterInt == zigbee.POWER_CONFIGURATION_CLUSTER && descMap.attrInt == 0x0021) {
+				event = getBatteryEvent(zigbee.convertHexToInt(descMap.value))
+			} else if (descMap.clusterInt == CLUSTER_SCENES ||
+					 descMap.clusterInt == zigbee.ONOFF_CLUSTER ||
+					 descMap.clusterInt == zigbee.LEVEL_CONTROL_CLUSTER) {
+				event = getButtonEvent(descMap)
+			}
+		}
+
+		def result = []
+		if (event) {
+			log.debug "Creating event: ${event}"
+			result = createEvent(event)
+		} else if (isBindingTableMessage(description)) {
+			Integer groupAddr = getGroupAddrFromBindingTable(description)
+			if (groupAddr != null) {
+				List cmds = addHubToGroup(groupAddr)
+				result = cmds?.collect { new physicalgraph.device.HubAction(it) }
+			} else {
+				groupAddr = 0x0000
+				List cmds = addHubToGroup(groupAddr) +
+						zigbee.command(CLUSTER_GROUPS, 0x00, "${zigbee.swapEndianHex(zigbee.convertToHexString(groupAddr, 4))} 00")
+				result = cmds?.collect { new physicalgraph.device.HubAction(it) }
+			}
+		}
+
+		return result
+	}
+}
+
+private Map getBatteryEvent(value) {
+	def result = [:]
+	result.value = value
+	result.name = 'battery'
+	result.descriptionText = "${device.displayName} battery was ${result.value}%"
+	return result
+}
+
+private sendButtonEvent(buttonNumber, buttonState) {
+	def child = childDevices?.find { channelNumber(it.deviceNetworkId) == buttonNumber }
+
+	if (child) {
+		def descriptionText = "$child.displayName was $buttonState" // TODO: Verify if this is needed, and if capability template already has it handled
+
+		child?.sendEvent([name: "button", value: buttonState, data: [buttonNumber: 1], descriptionText: descriptionText, isStateChange: true])
+	} else {
+		log.debug "Child device $buttonNumber not found!"
+	}
+}
+
+private Map getButtonEvent(Map descMap) {
+	Map ikeaRemoteControlMapping = [
+			(zigbee.ONOFF_CLUSTER):
+					[0x02: { [state: "pushed", buttonNumber: REMOTE_BUTTONS.MIDDLE] }],
+			(zigbee.LEVEL_CONTROL_CLUSTER):
+					[0x01: { [state: "held", buttonNumber: REMOTE_BUTTONS.BOTTOM] },
+					 0x02: { [state: "pushed", buttonNumber: REMOTE_BUTTONS.BOTTOM] },
+					 0x03: { [state: "", buttonNumber: 0] },
+					 0x04: { [state: "", buttonNumber: 0] },
+					 0x05: { [state: "held", buttonNumber: REMOTE_BUTTONS.TOP] },
+					 0x06: { [state: "pushed", buttonNumber: REMOTE_BUTTONS.TOP] },
+					 0x07: { [state: "", buttonNumber: 0] }],
+			(CLUSTER_SCENES):
+					[0x07: { it == "00"
+								? [state: "pushed", buttonNumber: REMOTE_BUTTONS.RIGHT]
+								: [state: "pushed", buttonNumber: REMOTE_BUTTONS.LEFT] },
+					 0x08: { it == "00"
+								? [state: "held", buttonNumber: REMOTE_BUTTONS.RIGHT]
+								: [state: "held", buttonNumber: REMOTE_BUTTONS.LEFT] },
+					 0x09: { [state: "", buttonNumber: 0] }]
+	]
+
+	def buttonState = ""
+	def buttonNumber = 0
+	Map result = [:]
+
+	if (isIkeaRemoteControl()) {
+		Map event = ikeaRemoteControlMapping[descMap.clusterInt][descMap.commandInt](descMap.data[0])
+		buttonState = event.state
+		buttonNumber = event.buttonNumber
+	} else if (isIkeaOnOffSwitch()) {
+		if (descMap.clusterInt == zigbee.ONOFF_CLUSTER) {
+			buttonState = "pushed"
+			if (descMap.commandInt == 0x00) {
+				buttonNumber = ONOFFSWITCH_BUTTONS.BOTTOM
+			} else if (descMap.commandInt == 0x01) {
+				buttonNumber = ONOFFSWITCH_BUTTONS.TOP
+			}
+		} else if (descMap.clusterInt == zigbee.LEVEL_CONTROL_CLUSTER) {
+			buttonState = "held"
+			if (descMap.commandInt == 0x01) {
+				buttonNumber = ONOFFSWITCH_BUTTONS.BOTTOM
+			} else if (descMap.commandInt == 0x05) {
+				buttonNumber = ONOFFSWITCH_BUTTONS.TOP
+			}
+		}
+	}
+
+	if (buttonNumber != 0) {
+		// Create old style
+		def descriptionText = "${getButtonName(buttonNumber)} was $buttonState"
+		result = [name: "button", value: buttonState, data: [buttonNumber: buttonNumber], descriptionText: descriptionText, isStateChange: true]
+
+		// Create and send component event
+		sendButtonEvent(buttonNumber, buttonState)
+	}
+	result
+}
+
+private boolean isIkeaRemoteControl() {
+	device.getDataValue("model") == "TRADFRI remote control"
+}
+
+private boolean isIkeaOnOffSwitch() {
+	device.getDataValue("model") == "TRADFRI on/off switch"
+}
+
+private Integer getGroupAddrFromBindingTable(description) {
+	log.info "Parsing binding table - '$description'"
+	def btr = zigbee.parseBindingTableResponse(description)
+	def groupEntry = btr?.table_entries?.find { it.dstAddrMode == 1 }
+	if (groupEntry != null) {
+		log.info "Found group binding in the binding table: ${groupEntry}"
+		Integer.parseInt(groupEntry.dstAddr, 16)
+	} else {
+		log.info "The binding table does not contain a group binding"
+		null
+	}
+}
+
+private List addHubToGroup(Integer groupAddr) {
+	["st cmd 0x0000 0x01 ${CLUSTER_GROUPS} 0x00 {${zigbee.swapEndianHex(zigbee.convertToHexString(groupAddr,4))} 00}",
+	 "delay 200"]
+}
+
+private List readDeviceBindingTable() {
+	["zdo mgmt-bind 0x${device.deviceNetworkId} 0",
+	 "delay 200"]
+}