MSA-907: Care Pendant

Fix fan mode notifications

devicetypes/mitchpond/iris-care-pendant.src/iris-care-pendant.groovy

@@ -0,0 +1,225 @@
+/**
+ *  Iris Care Pendant
+ *	
+ *  Copyright 2015 Mitch Pond
+ *
+ *  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: "Iris Care Pendant", namespace: "mitchpond", author: "Mitch Pond") {
+    	capability "Sensor"
+    	capability "Battery"
+		capability "Configuration"
+        capability "Button"
+        
+        command "enrollResponse"
+
+		fingerprint endpointId: "01", inClusters: "0000,0001,0003,0020,0500", outClusters: "0003,0019", manufacturer: "CentraLite", model: "3455-L"
+	}
+
+	preferences {}
+ 
+	tiles(scale: 2) {
+    	standardTile("button", "device.button", decoration: "flat", width: 2, height:2) {
+        	state "default", icon: "st.unknown.zwave.remote-controller", backgroundColor: "#ffffff"
+            state "pushed", backgroundColor: "#79b821"
+        }
+		valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
+			state "battery", label:'${currentValue}% battery', unit:""
+		}
+
+		main (["battery"])
+		details(["button","battery"])
+	}
+}
+ 
+def parse(String description) {
+	//log.debug "description: $description"
+    
+	def results = []
+	if (description?.startsWith('catchall:')) {
+		results = parseCatchAllMessage(description)
+	}
+	else if (description?.startsWith('read attr -')) {
+		results = parseReportAttributeMessage(description)
+	}
+    else if (description?.startsWith('zone status')) {
+    	results = parseIasMessage(description)
+    }
+    
+    if (description?.startsWith('enroll request')) {
+    	List cmds = enrollResponse()
+        log.debug "enroll response: ${cmds}"
+        results = cmds?.collect { new physicalgraph.device.HubAction(it) }
+    }
+    return results
+}
+ 
+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
+        }
+    }
+
+    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 parseReportAttributeMessage(String description) {
+	Map descMap = (description - "read attr - ").split(",").inject([:]) { map, param ->
+		def nameAndValue = param.split(":")
+		map += [(nameAndValue[0].trim()):nameAndValue[1].trim()]
+	}
+
+	def results = []
+    
+	if (descMap.cluster == "0001" && descMap.attrId == "0020") {
+		log.debug "Received battery level report"
+		results = createEvent(getBatteryResult(Integer.parseInt(descMap.value, 16)))
+	}
+
+	return results
+}
+
+private parseIasMessage(String description) {
+	List parsedMsg = description.split(' ')
+	String msgCode = parsedMsg[2]
+	int status = Integer.decode(msgCode)
+	def linkText = getLinkText(device)
+
+	def results = []
+	//log.debug(description)
+	if (status & 0b00000010) {results << createEvent(getButtonResult('pushed'))}
+	else if (~status & 0b00000010) results << createEvent(getButtonResult('released'))
+
+	if (status & 0b00000100) {
+    	//tampered
+	}
+	else if (~status & 0b00000100) {
+		//not tampered
+	}
+	
+	if (status & 0b00001000) {
+	}
+	else if (~status & 0b00001000) {
+		//log.debug "${linkText} battery OK"
+	}
+	//log.debug results
+	return results
+}
+
+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 getButtonResult(value) {
+	//log.debug 'Button Status'
+	def linkText = getLinkText(device)
+	def descriptionText = "${linkText} was ${value == 'pushed' ? 'pushed' : 'released'}"
+	return [
+		name: 'button',
+		value: value,
+        data: [buttonNumber: 1],
+		descriptionText: descriptionText,
+        displayed: true,
+        isStateChange: true
+	]
+}
+
+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 100",
+		"send 0x${device.deviceNetworkId} 1 1", "delay 500",
+
+		"zdo bind 0x${device.deviceNetworkId} ${endpointId} 1 1 {${device.zigbeeId}} {}", "delay 200",
+		"zcl global send-me-a-report 1 0x20 0x20 3600 21600 {01}",		//checkin time 6 hrs
+		"send 0x${device.deviceNetworkId} 1 1", "delay 500",
+        "st rattr 0x${device.deviceNetworkId} 1 1 0x20"
+	]
+    return configCmds
+}
+
+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
+}

devicetypes/smartthings/arrival-sensor.src/arrival-sensor.groovy

@@ -1,294 +1,294 @@
-/**
- *  Copyright 2015 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.
- *
- */
-metadata {
-	definition (name: "Arrival Sensor", namespace: "smartthings", author: "SmartThings") {
-		capability "Tone"
-		capability "Actuator"
-		capability "Signal Strength"
-		capability "Presence Sensor"
-		capability "Sensor"
-		capability "Battery"
-
-		fingerprint profileId: "FC01", deviceId: "019A"
-		fingerprint profileId: "FC01", deviceId: "0131", inClusters: "0000,0003", outClusters: "0003"
-		fingerprint profileId: "FC01", deviceId: "0131", inClusters: "0000", outClusters: "0006"
-	}
-
-	simulator {
-		status "present": "presence: 1"
-		status "not present": "presence: 0"
-		status "battery": "battery: 27, batteryDivisor: 0A, rssi: 100, lqi: 64"
-	}
-
-	preferences {
-		section {
-			image(name: 'educationalcontent', multiple: true, images: [
-				"http://cdn.device-gse.smartthings.com/Arrival/Arrival1.jpg",
-				"http://cdn.device-gse.smartthings.com/Arrival/Arrival2.jpg"
-				])
-		}
-	}
-
-	tiles {
-		standardTile("presence", "device.presence", width: 2, height: 2, canChangeBackground: true) {
-			state "present", labelIcon:"st.presence.tile.present", backgroundColor:"#53a7c0"
-			state "not present", labelIcon:"st.presence.tile.not-present", backgroundColor:"#ebeef2"
-		}
-		standardTile("beep", "device.beep", decoration: "flat") {
-			state "beep", label:'', action:"tone.beep", icon:"st.secondary.beep", backgroundColor:"#ffffff"
-		}
-		valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false) {
-			state "battery", label:'${currentValue}% battery', unit:""/*, backgroundColors:[
-				[value: 5, color: "#BC2323"],
-				[value: 10, color: "#D04E00"],
-				[value: 15, color: "#F1D801"],
-				[value: 16, color: "#FFFFFF"]
-			]*/
-		}
-		/*
-		valueTile("lqi", "device.lqi", decoration: "flat", inactiveLabel: false) {
-			state "lqi", label:'${currentValue}% signal', unit:""
-		}
-		*/
-		
-		main "presence"
-		details(["presence", "beep", "battery"/*, "lqi"*/])
-	}
-}
-
-def beep() {
-	/*
-	You can make the speaker turn on for 0.5-second beeps by sending some CLI commands:
-
-		Command: send raw, wait 7, send raw, wait 7, send raw
-		Future: new packet type "st.beep"
-
-		raw 0xFC05 {15 0A 11 00 00 15 01}
-		send 0x2F7F 2 2
-
-	where "0xABCD" is the node ID of the Smart Tag, everything else above is a constant. Except
-	the "15 01" at the end of the first raw command, that sets the speaker's period (reciprocal
-	of frequency). You can play with this value up or down to experiment with loudness as the
-	loudness will be strongly dependent upon frequency and the enclosure that it's in. Note that
-	"15 01" represents the hex number 0x0115 so a lower frequency is "16 01" (longer period) and
-	a higher frequency is "14 01" (shorter period). Note that since the tag only checks its parent
-	for messages every 5 seconds (while at rest) or every 3 seconds (while in motion) it will take
-	up to this long from the time you send the message to the time you hear a sound.
-	*/
-
-	[
-		"raw 0xFC05 {15 0A 11 00 00 15 01}",
-		"delay 7000",
-		"raw 0xFC05 {15 0A 11 00 00 15 01}",
-		"delay 7000",
-		"raw 0xFC05 {15 0A 11 00 00 15 01}",
-		"delay 7000",
-		"raw 0xFC05 {15 0A 11 00 00 15 01}",
-		"delay 7000",
-		"raw 0xFC05 {15 0A 11 00 00 15 01}"
-	]
-}
-
-def parse(String description) {
-	def results
-	if (isBatteryMessage(description)) {
-		results = parseBatteryMessage(description)
-	}
-	else {
-		results = parsePresenceMessage(description)
-	}
-
-	log.debug "Parse returned $results.descriptionText"
-	results
-}
-
-private Map parsePresenceMessage(String description) {
-	def name = parseName(description)
-	def value = parseValue(description)
-	def linkText = getLinkText(device)
-	def descriptionText = parseDescriptionText(linkText, value, description)
-	def handlerName = getState(value)
-	def isStateChange = isStateChange(device, name, value)
-
-	def results = [
-		name: name,
-		value: value,
-		unit: null,
-		linkText: linkText,
-		descriptionText: descriptionText,
-		handlerName: handlerName,
-		isStateChange: isStateChange,
-		displayed: displayed(description, isStateChange)
-	]
-
-	results
-}
-
-private String parseName(String description) {
-	if (description?.startsWith("presence: ")) {
-		return "presence"
-	}
-	null
-}
-
-private String parseValue(String description) {
-	if (description?.startsWith("presence: "))
-	{
-		if (description?.endsWith("1"))
-		{
-			return "present"
-		}
-		else if (description?.endsWith("0"))
-		{
-			return "not present"
-		}
-	}
-
-	description
-}
-
-private parseDescriptionText(String linkText, String value, String description) {
-	switch(value) {
-		case "present": return "$linkText has arrived"
-		case "not present": return "$linkText has left"
-		default: return value
-	}
-}
-
-private getState(String value) {
-	def state = value
-	if (value == "present") {
-		state = "arrived"
-	}
-	else if (value == "not present") {
-		state = "left"
-	}
-
-	state
-}
-
-private Boolean isBatteryMessage(String description) {
-	// "raw:36EF1C, dni:36EF, battery:1B, rssi:, lqi:"
-	description ==~ /.*battery:.*rssi:.*lqi:.*/
-}
-
-private List parseBatteryMessage(String description) {
-	def results = []
-	def parts = description.split(',')
-	parts.each { part ->
-		part = part.trim()
-		if (part.startsWith('battery:')) {
-			def batteryResult = getBatteryResult(part, description)
-			if (batteryResult) {
-				results << batteryResult
-			}
-		}
-		else if (part.startsWith('rssi:')) {
-			def rssiResult = getRssiResult(part, description)
-			if (rssiResult) {
-				results << rssiResult
-			}
-		}
-		else if (part.startsWith('lqi:')) {
-			def lqiResult = getLqiResult(part, description)
-			if (lqiResult) {
-				results << lqiResult
-			}
-		}
-	}
-
-	results
-}
-
-private getBatteryResult(part, description) {
-	def batteryDivisor = description.split(",").find {it.split(":")[0].trim() == "batteryDivisor"} ? description.split(",").find {it.split(":")[0].trim() == "batteryDivisor"}.split(":")[1].trim() : null
-	def name = "battery"
-	def value = zigbee.parseSmartThingsBatteryValue(part, batteryDivisor)
-	def unit = "%"
-	def linkText = getLinkText(device)
-	def descriptionText = "$linkText battery was ${value}${unit}"
-	def isStateChange = isStateChange(device, name, value)
-
-	[
-		name: name,
-		value: value,
-		unit: unit,
-		linkText: linkText,
-		descriptionText: descriptionText,
-		handlerName: name,
-		isStateChange: isStateChange,
-		//displayed: displayed(description, isStateChange)
-		displayed: false
-	]
-}
-
-private getRssiResult(part, description) {
-	def name = "rssi"
-	def parts = part.split(":")
-	if (parts.size() != 2) return null
-
-	def valueString = parts[1].trim()
-	def valueInt = Integer.parseInt(valueString, 16)
-	def value = (valueInt - 128).toString()
-	def linkText = getLinkText(device)
-	def descriptionText = "$linkText was $value dBm"
-	def isStateChange = isStateChange(device, name, value)
-
-	[
-		name: name,
-		value: value,
-		unit: "dBm",
-		linkText: linkText,
-		descriptionText: descriptionText,
-		handlerName: null,
-		isStateChange: isStateChange,
-		//displayed: displayed(description, isStateChange)
-		displayed: false
-	]
-}
-
-/**
- * Use LQI (Link Quality Indicator) as a measure of signal strength. The values
- * are 0 to 255 (0x00 to 0xFF) and higher values represent higher signal
- * strength. Return as a percentage of 255.
- *
- * Note: To make the signal strength indicator more accurate, we could combine
- * LQI with RSSI.
- */
-private getLqiResult(part, description) {
-	def name = "lqi"
-	def parts = part.split(":")
-	if (parts.size() != 2) return null
-
-	def valueString = parts[1].trim()
-	def valueInt = Integer.parseInt(valueString, 16)
-	def percentageOf = 255
-	def value = Math.round((valueInt / percentageOf * 100)).toString()
-	def unit = "%"
-	def linkText = getLinkText(device)
-	def descriptionText = "$linkText Signal (LQI) was ${value}${unit}"
-	def isStateChange = isStateChange(device, name, value)
-
-	[
-		name: name,
-		value: value,
-		unit: unit,
-		linkText: linkText,
-		descriptionText: descriptionText,
-		handlerName: null,
-		isStateChange: isStateChange,
-		//displayed: displayed(description, isStateChange)
-		displayed: false
-	]
-}
+/**
+ *  Copyright 2015 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.
+ *
+ */
+metadata {
+	definition (name: "Arrival Sensor", namespace: "smartthings", author: "SmartThings") {
+		capability "Tone"
+		capability "Actuator"
+		capability "Signal Strength"
+		capability "Presence Sensor"
+		capability "Sensor"
+		capability "Battery"
+
+		fingerprint profileId: "FC01", deviceId: "019A"
+		fingerprint profileId: "FC01", deviceId: "0131", inClusters: "0000,0003", outClusters: "0003"
+		fingerprint profileId: "FC01", deviceId: "0131", inClusters: "0000", outClusters: "0006"
+	}
+
+	simulator {
+		status "present": "presence: 1"
+		status "not present": "presence: 0"
+		status "battery": "battery: 27, batteryDivisor: 0A, rssi: 100, lqi: 64"
+	}
+
+	preferences {
+		section {
+			image(name: 'educationalcontent', multiple: true, images: [
+				"http://cdn.device-gse.smartthings.com/Arrival/Arrival1.jpg",
+				"http://cdn.device-gse.smartthings.com/Arrival/Arrival2.jpg"
+				])
+		}
+	}
+
+	tiles {
+		standardTile("presence", "device.presence", width: 2, height: 2, canChangeBackground: true) {
+			state "present", labelIcon:"st.presence.tile.present", backgroundColor:"#53a7c0"
+			state "not present", labelIcon:"st.presence.tile.not-present", backgroundColor:"#ebeef2"
+		}
+		standardTile("beep", "device.beep", decoration: "flat") {
+			state "beep", label:'', action:"tone.beep", icon:"st.secondary.beep", backgroundColor:"#ffffff"
+		}
+		valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false) {
+			state "battery", label:'${currentValue}% battery', unit:""/*, backgroundColors:[
+				[value: 5, color: "#BC2323"],
+				[value: 10, color: "#D04E00"],
+				[value: 15, color: "#F1D801"],
+				[value: 16, color: "#FFFFFF"]
+			]*/
+		}
+		/*
+		valueTile("lqi", "device.lqi", decoration: "flat", inactiveLabel: false) {
+			state "lqi", label:'${currentValue}% signal', unit:""
+		}
+		*/
+		
+		main "presence"
+		details(["presence", "beep", "battery"/*, "lqi"*/])
+	}
+}
+
+def beep() {
+	/*
+	You can make the speaker turn on for 0.5-second beeps by sending some CLI commands:
+
+		Command: send raw, wait 7, send raw, wait 7, send raw
+		Future: new packet type "st.beep"
+
+		raw 0xFC05 {15 0A 11 00 00 15 01}
+		send 0x2F7F 2 2
+
+	where "0xABCD" is the node ID of the Smart Tag, everything else above is a constant. Except
+	the "15 01" at the end of the first raw command, that sets the speaker's period (reciprocal
+	of frequency). You can play with this value up or down to experiment with loudness as the
+	loudness will be strongly dependent upon frequency and the enclosure that it's in. Note that
+	"15 01" represents the hex number 0x0115 so a lower frequency is "16 01" (longer period) and
+	a higher frequency is "14 01" (shorter period). Note that since the tag only checks its parent
+	for messages every 5 seconds (while at rest) or every 3 seconds (while in motion) it will take
+	up to this long from the time you send the message to the time you hear a sound.
+	*/
+
+	[
+		"raw 0xFC05 {15 0A 11 00 00 15 01}",
+		"delay 7000",
+		"raw 0xFC05 {15 0A 11 00 00 15 01}",
+		"delay 7000",
+		"raw 0xFC05 {15 0A 11 00 00 15 01}",
+		"delay 7000",
+		"raw 0xFC05 {15 0A 11 00 00 15 01}",
+		"delay 7000",
+		"raw 0xFC05 {15 0A 11 00 00 15 01}"
+	]
+}
+
+def parse(String description) {
+	def results
+	if (isBatteryMessage(description)) {
+		results = parseBatteryMessage(description)
+	}
+	else {
+		results = parsePresenceMessage(description)
+	}
+
+	log.debug "Parse returned $results.descriptionText"
+	results
+}
+
+private Map parsePresenceMessage(String description) {
+	def name = parseName(description)
+	def value = parseValue(description)
+	def linkText = getLinkText(device)
+	def descriptionText = parseDescriptionText(linkText, value, description)
+	def handlerName = getState(value)
+	def isStateChange = isStateChange(device, name, value)
+
+	def results = [
+		name: name,
+		value: value,
+		unit: null,
+		linkText: linkText,
+		descriptionText: descriptionText,
+		handlerName: handlerName,
+		isStateChange: isStateChange,
+		displayed: displayed(description, isStateChange)
+	]
+
+	results
+}
+
+private String parseName(String description) {
+	if (description?.startsWith("presence: ")) {
+		return "presence"
+	}
+	null
+}
+
+private String parseValue(String description) {
+	if (description?.startsWith("presence: "))
+	{
+		if (description?.endsWith("1"))
+		{
+			return "present"
+		}
+		else if (description?.endsWith("0"))
+		{
+			return "not present"
+		}
+	}
+
+	description
+}
+
+private parseDescriptionText(String linkText, String value, String description) {
+	switch(value) {
+		case "present": return "$linkText has arrived"
+		case "not present": return "$linkText has left"
+		default: return value
+	}
+}
+
+private getState(String value) {
+	def state = value
+	if (value == "present") {
+		state = "arrived"
+	}
+	else if (value == "not present") {
+		state = "left"
+	}
+
+	state
+}
+
+private Boolean isBatteryMessage(String description) {
+	// "raw:36EF1C, dni:36EF, battery:1B, rssi:, lqi:"
+	description ==~ /.*battery:.*rssi:.*lqi:.*/
+}
+
+private List parseBatteryMessage(String description) {
+	def results = []
+	def parts = description.split(',')
+	parts.each { part ->
+		part = part.trim()
+		if (part.startsWith('battery:')) {
+			def batteryResult = getBatteryResult(part, description)
+			if (batteryResult) {
+				results << batteryResult
+			}
+		}
+		else if (part.startsWith('rssi:')) {
+			def rssiResult = getRssiResult(part, description)
+			if (rssiResult) {
+				results << rssiResult
+			}
+		}
+		else if (part.startsWith('lqi:')) {
+			def lqiResult = getLqiResult(part, description)
+			if (lqiResult) {
+				results << lqiResult
+			}
+		}
+	}
+
+	results
+}
+
+private getBatteryResult(part, description) {
+	def batteryDivisor = description.split(",").find {it.split(":")[0].trim() == "batteryDivisor"} ? description.split(",").find {it.split(":")[0].trim() == "batteryDivisor"}.split(":")[1].trim() : null
+	def name = "battery"
+	def value = zigbee.parseSmartThingsBatteryValue(part, batteryDivisor)
+	def unit = "%"
+	def linkText = getLinkText(device)
+	def descriptionText = "$linkText battery was ${value}${unit}"
+	def isStateChange = isStateChange(device, name, value)
+
+	[
+		name: name,
+		value: value,
+		unit: unit,
+		linkText: linkText,
+		descriptionText: descriptionText,
+		handlerName: name,
+		isStateChange: isStateChange,
+		//displayed: displayed(description, isStateChange)
+		displayed: false
+	]
+}
+
+private getRssiResult(part, description) {
+	def name = "rssi"
+	def parts = part.split(":")
+	if (parts.size() != 2) return null
+
+	def valueString = parts[1].trim()
+	def valueInt = Integer.parseInt(valueString, 16)
+	def value = (valueInt - 128).toString()
+	def linkText = getLinkText(device)
+	def descriptionText = "$linkText was $value dBm"
+	def isStateChange = isStateChange(device, name, value)
+
+	[
+		name: name,
+		value: value,
+		unit: "dBm",
+		linkText: linkText,
+		descriptionText: descriptionText,
+		handlerName: null,
+		isStateChange: isStateChange,
+		//displayed: displayed(description, isStateChange)
+		displayed: false
+	]
+}
+
+/**
+ * Use LQI (Link Quality Indicator) as a measure of signal strength. The values
+ * are 0 to 255 (0x00 to 0xFF) and higher values represent higher signal
+ * strength. Return as a percentage of 255.
+ *
+ * Note: To make the signal strength indicator more accurate, we could combine
+ * LQI with RSSI.
+ */
+private getLqiResult(part, description) {
+	def name = "lqi"
+	def parts = part.split(":")
+	if (parts.size() != 2) return null
+
+	def valueString = parts[1].trim()
+	def valueInt = Integer.parseInt(valueString, 16)
+	def percentageOf = 255
+	def value = Math.round((valueInt / percentageOf * 100)).toString()
+	def unit = "%"
+	def linkText = getLinkText(device)
+	def descriptionText = "$linkText Signal (LQI) was ${value}${unit}"
+	def isStateChange = isStateChange(device, name, value)
+
+	[
+		name: name,
+		value: value,
+		unit: unit,
+		linkText: linkText,
+		descriptionText: descriptionText,
+		handlerName: null,
+		isStateChange: isStateChange,
+		//displayed: displayed(description, isStateChange)
+		displayed: false
+	]
+}

devicetypes/smartthings/ecobee-thermostat.src/ecobee-thermostat.groovy

@@ -395,7 +395,7 @@ def generateModeEvent(mode) {
 }
 
 def generateFanModeEvent(fanMode) {
-	sendEvent(name: "thermostatFanMode", value: fanMode, descriptionText: "$device.displayName fan is in ${mode} mode", displayed: true)
+	sendEvent(name: "thermostatFanMode", value: fanMode, descriptionText: "$device.displayName fan is in ${fanMode} mode", displayed: true)
 }
 
 def generateOperatingStateEvent(operatingState) {
@@ -493,7 +493,7 @@ def fanOn() {
 	} else {
 		log.debug "Error setting new mode."
 		def currentFanMode = device.currentState("thermostatFanMode")?.value
-		generateModeEvent(currentFanMode) // reset the tile back
+		generateFanModeEvent(currentFanMode) // reset the tile back
 	}
 }
 
@@ -514,7 +514,7 @@ def fanAuto() {
 	} else {
 		log.debug "Error setting new mode."
 		def currentFanMode = device.currentState("thermostatFanMode")?.value
-		generateModeEvent(currentFanMode) // reset the tile back
+		generateFanModeEvent(currentFanMode) // reset the tile back
 	}
 }
 

devicetypes/smartthings/zigbee-lock.src/zigbee-lock.groovy

@@ -23,22 +23,14 @@
         capability "Battery"
         capability "Configuration"
 
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019",
-                        manufacturer: "Kwikset", model: "SMARTCODE_DEADBOLT_5", deviceJoinName: "Kwikset 5-Button Deadbolt"
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019",
-                        manufacturer: "Kwikset", model: "SMARTCODE_LEVER_5", deviceJoinName: "Kwikset 5-Button Lever"
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019",
-                        manufacturer: "Kwikset", model: "SMARTCODE_DEADBOLT_10", deviceJoinName: "Kwikset 10-Button Deadbolt"
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019",
-                        manufacturer: "Kwikset", model: "SMARTCODE_DEADBOLT_10T", deviceJoinName: "Kwikset 10-Button Touch Deadbolt"
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019",
-                        manufacturer: "Yale", model: "YRL220 TS LL", deviceJoinName: "Yale Touch Screen Lever Lock"
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019",
-                        manufacturer: "Yale", model: "YRD210 PB DB", deviceJoinName: "Yale Push Button Deadbolt Lock"
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019",
-                        manufacturer: "Yale", model: "YRD220/240 TSDB", deviceJoinName: "Yale Touch Screen Deadbolt Lock"
-        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019",
-                        manufacturer: "Yale", model: "YRL210 PB LL", deviceJoinName: "Yale Push Button Lever Lock"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019", manufacturer: "Kwikset", model: "SMARTCODE_DEADBOLT_5", deviceJoinName: "Kwikset 5-Button Deadbolt"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019", manufacturer: "Kwikset", model: "SMARTCODE_LEVER_5", deviceJoinName: "Kwikset 5-Button Lever"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019", manufacturer: "Kwikset", model: "SMARTCODE_DEADBOLT_10", deviceJoinName: "Kwikset 10-Button Deadbolt"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0004,0005,0009,0020,0101,0402,0B05,FDBD", outClusters: "000A,0019", manufacturer: "Kwikset", model: "SMARTCODE_DEADBOLT_10T", deviceJoinName: "Kwikset 10-Button Touch Deadbolt"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019", manufacturer: "Yale", model: "YRL220 TS LL", deviceJoinName: "Yale Touch Screen Lever Lock"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019", manufacturer: "Yale", model: "YRD210 PB DB", deviceJoinName: "Yale Push Button Deadbolt Lock"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019", manufacturer: "Yale", model: "YRD220/240 TSDB", deviceJoinName: "Yale Touch Screen Deadbolt Lock"
+        fingerprint profileId: "0104", inClusters: "0000,0001,0003,0009,000A,0101,0020", outClusters: "000A,0019", manufacturer: "Yale", model: "YRL210 PB LL", deviceJoinName: "Yale Push Button Lever Lock"
     }
 
     tiles(scale: 2) {

smartapps/mitchpond/3400-x-keypad-manager.src/3400-x-keypad-manager.groovy

@@ -0,0 +1,129 @@
+/**
+ *  3400-X Keypad Manager
+ *
+ *  Copyright 2015 Mitch Pond
+ *
+ *  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.
+ *
+ */
+definition(
+    name: "3400-X Keypad Manager",
+    namespace: "mitchpond",
+    author: "Mitch Pond",
+    description: "Service manager for Centralite 3400-X security keypad. Keeps keypad state in sync with Smart Home Monitor",
+    category: "My Apps",
+    iconUrl: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience.png",
+    iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience@2x.png",
+    iconX3Url: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience@2x.png",
+    singleInstance: false)
+
+
+preferences {
+	page(name: "setupPage")
+}
+
+def setupPage() {
+	dynamicPage(name: "setupPage",title: "3400-X Keypad Manager", install: true, uninstall: true) {
+        section("Settings") {
+            input(name: "keypad", title: "Keypad", type: "capability.lockCodes", multiple: false, required: true)
+            input(name: "pin"	, title: "PIN code", type: "number", range: "0000..9999", required: true)
+            paragraph "PIN should be four digits. Shorter PINs will be padded with leading zeroes. (42 becomes 0042)"
+            label(title: "Assign a name", required: false)
+        }
+        def routines = location.helloHome?.getPhrases()*.label
+        routines?.sort()
+        section("Routines", hideable: true, hidden: true) {
+        	input(name: "armRoutine", title: "Arm/Away routine", type: "enum", options: routines, required: false)
+            input(name: "disarmRoutine", title: "Disarm routine", type: "enum", options: routines, required: false)
+            input(name: "stayRoutine", title: "Arm/Stay routine", type: "enum", options: routines, required: false)
+            //input(name: "nightRoutine", title: "Arm/Night routine", type: "enum", options: routines, required: false)
+        }
+    }
+}
+
+def installed() {
+	log.debug "Installed with settings: ${settings}"
+
+	initialize()
+}
+
+def updated() {
+	log.debug "Updated with settings: ${settings}"
+
+	unsubscribe()
+	initialize()
+}
+
+def initialize() {
+	// TODO: subscribe to attributes, devices, locations, etc.
+    subscribe(location,"alarmSystemStatus",alarmStatusHandler)
+    subscribe(keypad,"codeEntered",codeEntryHandler)   
+
+    //initialize keypad to correct state
+    def event = [name:"alarmSystemStatus", value: location.currentState("alarmSystemStatus").value, 
+    			displayed: true, description: "System Status is ${shmState}"]
+    alarmStatusHandler(event)
+}
+
+//Returns the PIN padded with zeroes to 4 digits
+private String getPIN(){
+	return settings.pin.value.toString().padLeft(4,'0')
+}
+
+// TODO: implement event handlers
+def alarmStatusHandler(event) {
+	log.debug "Keypad manager caught alarm status change: "+event.value
+    if (event.value == "off") keypad?.setDisarmed()
+    else if (event.value == "away") keypad?.setArmedAway()
+    else if (event.value == "stay") keypad?.setArmedStay()
+}
+
+private sendSHMEvent(String shmState){
+	def event = [name:"alarmSystemStatus", value: shmState, 
+    			displayed: true, description: "System Status is ${shmState}"]
+    sendLocationEvent(event)
+}
+
+private execRoutine(armMode) {
+	if (armMode == 'away') location.helloHome?.execute(settings.armRoutine)
+    else if (armMode == 'stay') location.helloHome?.execute(settings.stayRoutine)
+    else if (armMode == 'off') location.helloHome?.execute(settings.disarmRoutine)    
+}
+
+def codeEntryHandler(evt){
+	//do stuff
+    log.debug "Caught code entry event! ${evt.value.value}"
+    
+    def codeEntered = evt.value as String
+    def correctCode = getPIN()
+    def data = evt.data as String
+    def armMode = ''
+    
+    if (data == '0') armMode = 'off'
+    else if (data == '3') armMode = 'away'
+    else if (data == '1') armMode = 'stay'
+    else if (data == '2') armMode = 'stay'	//Currently no separate night mode for SHM, set to 'stay'
+    else {
+    	log.error "${app.label}: Unexpected arm mode sent by keypad!: "+data
+        return []
+        }
+    
+    if (codeEntered == correctCode) {
+    	log.debug "Correct PIN entered. Change SHM state to ${armMode}"
+        keypad.acknowledgeArmRequest(data)
+        sendSHMEvent(armMode)
+		execRoutine(armMode)
+    }
+    else {
+    	log.debug "Invalid PIN"
+        //Could also call acknowledgeArmRequest() with a parameter of 4 to report invalid code. Opportunity to simplify code?
+    	keypad.sendInvalidKeycodeResponse()
+    }
+}

smartapps/smartthings/button-controller.src/button-controller.groovy

@@ -1,322 +1,322 @@
-/**
- *  Copyright 2015 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.
- *
- *	Button Controller
- *
- *	Author: SmartThings
- *	Date: 2014-5-21
- */
-definition(
-    name: "Button Controller",
-    namespace: "smartthings",
-    author: "SmartThings",
-    description: "Control devices with buttons like the Aeon Labs Minimote",
-    category: "Convenience",
-    iconUrl: "https://s3.amazonaws.com/smartapp-icons/MyApps/Cat-MyApps.png",
-    iconX2Url: "https://s3.amazonaws.com/smartapp-icons/MyApps/Cat-MyApps@2x.png"
-)
-
-preferences {
-	page(name: "selectButton")
-	page(name: "configureButton1")
-	page(name: "configureButton2")
-	page(name: "configureButton3")
-	page(name: "configureButton4")
-
-	page(name: "timeIntervalInput", title: "Only during a certain time") {
-		section {
-			input "starting", "time", title: "Starting", required: false
-			input "ending", "time", title: "Ending", required: false
-		}
-	}
-}
-
-def selectButton() {
-	dynamicPage(name: "selectButton", title: "First, select your button device", nextPage: "configureButton1", uninstall: configured()) {
-		section {
-			input "buttonDevice", "capability.button", title: "Button", multiple: false, required: true
-		}
-
-		section(title: "More options", hidden: hideOptionsSection(), hideable: true) {
-
-			def timeLabel = timeIntervalLabel()
-
-			href "timeIntervalInput", title: "Only during a certain time", description: timeLabel ?: "Tap to set", state: timeLabel ? "complete" : null
-
-			input "days", "enum", title: "Only on certain days of the week", multiple: true, required: false,
-				options: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
-
-			input "modes", "mode", title: "Only when mode is", multiple: true, required: false
-		}
-	}
-}
-
-def configureButton1() {
-	dynamicPage(name: "configureButton1", title: "Now let's decide how to use the first button",
-		nextPage: "configureButton2", uninstall: configured(), getButtonSections(1))
-}
-def configureButton2() {
-	dynamicPage(name: "configureButton2", title: "If you have a second button, set it up here",
-		nextPage: "configureButton3", uninstall: configured(), getButtonSections(2))
-}
-
-def configureButton3() {
-	dynamicPage(name: "configureButton3", title: "If you have a third button, you can do even more here",
-		nextPage: "configureButton4", uninstall: configured(), getButtonSections(3))
-}
-def configureButton4() {
-	dynamicPage(name: "configureButton4", title: "If you have a fourth button, you rule, and can set it up here",
-		install: true, uninstall: true, getButtonSections(4))
-}
-
-def getButtonSections(buttonNumber) {
-	return {
-		section("Lights") {
-			input "lights_${buttonNumber}_pushed", "capability.switch", title: "Pushed", multiple: true, required: false
-			input "lights_${buttonNumber}_held", "capability.switch", title: "Held", multiple: true, required: false
-		}
-		section("Locks") {
-			input "locks_${buttonNumber}_pushed", "capability.lock", title: "Pushed", multiple: true, required: false
-			input "locks_${buttonNumber}_held", "capability.lock", title: "Held", multiple: true, required: false
-		}
-		section("Sonos") {
-			input "sonos_${buttonNumber}_pushed", "capability.musicPlayer", title: "Pushed", multiple: true, required: false
-			input "sonos_${buttonNumber}_held", "capability.musicPlayer", title: "Held", multiple: true, required: false
-		}
-		section("Modes") {
-			input "mode_${buttonNumber}_pushed", "mode", title: "Pushed", required: false
-			input "mode_${buttonNumber}_held", "mode", title: "Held", required: false
-		}
-		def phrases = location.helloHome?.getPhrases()*.label
-		if (phrases) {
-			section("Hello Home Actions") {
-				log.trace phrases
-				input "phrase_${buttonNumber}_pushed", "enum", title: "Pushed", required: false, options: phrases
-				input "phrase_${buttonNumber}_held", "enum", title: "Held", required: false, options: phrases
-			}
-		}
-        section("Sirens") {
-            input "sirens_${buttonNumber}_pushed","capability.alarm" ,title: "Pushed", multiple: true, required: false
-            input "sirens_${buttonNumber}_held", "capability.alarm", title: "Held", multiple: true, required: false
-        }
-
-		section("Custom Message") {
-			input "textMessage_${buttonNumber}", "text", title: "Message", required: false
-		}
-
-        section("Push Notifications") {
-            input "notifications_${buttonNumber}_pushed","bool" ,title: "Pushed", required: false, defaultValue: false
-            input "notifications_${buttonNumber}_held", "bool", title: "Held", required: false, defaultValue: false
-        }
-
-        section("Sms Notifications") {
-            input "phone_${buttonNumber}_pushed","phone" ,title: "Pushed", required: false
-            input "phone_${buttonNumber}_held", "phone", title: "Held", required: false
-        }
-	}
-}
-
-def installed() {
-	initialize()
-}
-
-def updated() {
-	unsubscribe()
-	initialize()
-}
-
-def initialize() {
-	subscribe(buttonDevice, "button", buttonEvent)
-}
-
-def configured() {
-	return buttonDevice || buttonConfigured(1) || buttonConfigured(2) || buttonConfigured(3) || buttonConfigured(4)
-}
-
-def buttonConfigured(idx) {
-	return settings["lights_$idx_pushed"] ||
-		settings["locks_$idx_pushed"] ||
-		settings["sonos_$idx_pushed"] ||
-		settings["mode_$idx_pushed"] ||
-        settings["notifications_$idx_pushed"] ||
-        settings["sirens_$idx_pushed"] ||
-        settings["notifications_$idx_pushed"]   ||
-        settings["phone_$idx_pushed"]
-}
-
-def buttonEvent(evt){
-	if(allOk) {
-		def buttonNumber = evt.data // why doesn't jsonData work? always returning [:]
-		def value = evt.value
-		log.debug "buttonEvent: $evt.name = $evt.value ($evt.data)"
-		log.debug "button: $buttonNumber, value: $value"
-
-		def recentEvents = buttonDevice.eventsSince(new Date(now() - 3000)).findAll{it.value == evt.value && it.data == evt.data}
-		log.debug "Found ${recentEvents.size()?:0} events in past 3 seconds"
-
-		if(recentEvents.size <= 1){
-			switch(buttonNumber) {
-				case ~/.*1.*/:
-					executeHandlers(1, value)
-					break
-				case ~/.*2.*/:
-					executeHandlers(2, value)
-					break
-				case ~/.*3.*/:
-					executeHandlers(3, value)
-					break
-				case ~/.*4.*/:
-					executeHandlers(4, value)
-					break
-			}
-		} else {
-			log.debug "Found recent button press events for $buttonNumber with value $value"
-		}
-	}
-}
-
-def executeHandlers(buttonNumber, value) {
-	log.debug "executeHandlers: $buttonNumber - $value"
-
-	def lights = find('lights', buttonNumber, value)
-	if (lights != null) toggle(lights)
-
-	def locks = find('locks', buttonNumber, value)
-	if (locks != null) toggle(locks)
-
-	def sonos = find('sonos', buttonNumber, value)
-	if (sonos != null) toggle(sonos)
-
-	def mode = find('mode', buttonNumber, value)
-	if (mode != null) changeMode(mode)
-
-	def phrase = find('phrase', buttonNumber, value)
-	if (phrase != null) location.helloHome.execute(phrase)
-
-	def textMessage = findMsg('textMessage', buttonNumber)
-
-	def notifications = find('notifications', buttonNumber, value)
-	if (notifications?.toBoolean()) sendPush(textMessage ?: "Button $buttonNumber was pressed" )
-
-	def phone = find('phone', buttonNumber, value)
-	if (phone != null) sendSms(phone, textMessage ?:"Button $buttonNumber was pressed")
-
-    def sirens = find('sirens', buttonNumber, value)
-    if (sirens != null) toggle(sirens)
-}
-
-def find(type, buttonNumber, value) {
-	def preferenceName = type + "_" + buttonNumber + "_" + value
-	def pref = settings[preferenceName]
-	if(pref != null) {
-		log.debug "Found: $pref for $preferenceName"
-	}
-
-	return pref
-}
-
-def findMsg(type, buttonNumber) {
-	def preferenceName = type + "_" + buttonNumber
-	def pref = settings[preferenceName]
-	if(pref != null) {
-		log.debug "Found: $pref for $preferenceName"
-	}
-
-	return pref
-}
-
-def toggle(devices) {
-	log.debug "toggle: $devices = ${devices*.currentValue('switch')}"
-
-	if (devices*.currentValue('switch').contains('on')) {
-		devices.off()
-	}
-	else if (devices*.currentValue('switch').contains('off')) {
-		devices.on()
-	}
-	else if (devices*.currentValue('lock').contains('locked')) {
-		devices.unlock()
-	}
-	else if (devices*.currentValue('lock').contains('unlocked')) {
-		devices.lock()
-	}
-	else if (devices*.currentValue('alarm').contains('off')) {
-        devices.siren()
-    }
-	else {
-		devices.on()
-	}
-}
-
-def changeMode(mode) {
-	log.debug "changeMode: $mode, location.mode = $location.mode, location.modes = $location.modes"
-
-	if (location.mode != mode && location.modes?.find { it.name == mode }) {
-		setLocationMode(mode)
-	}
-}
-
-// execution filter methods
-private getAllOk() {
-	modeOk && daysOk && timeOk
-}
-
-private getModeOk() {
-	def result = !modes || modes.contains(location.mode)
-	log.trace "modeOk = $result"
-	result
-}
-
-private getDaysOk() {
-	def result = true
-	if (days) {
-		def df = new java.text.SimpleDateFormat("EEEE")
-		if (location.timeZone) {
-			df.setTimeZone(location.timeZone)
-		}
-		else {
-			df.setTimeZone(TimeZone.getTimeZone("America/New_York"))
-		}
-		def day = df.format(new Date())
-		result = days.contains(day)
-	}
-	log.trace "daysOk = $result"
-	result
-}
-
-private getTimeOk() {
-	def result = true
-	if (starting && ending) {
-		def currTime = now()
-		def start = timeToday(starting).time
-		def stop = timeToday(ending).time
-		result = start < stop ? currTime >= start && currTime <= stop : currTime <= stop || currTime >= start
-	}
-	log.trace "timeOk = $result"
-	result
-}
-
-private hhmm(time, fmt = "h:mm a")
-{
-	def t = timeToday(time, location.timeZone)
-	def f = new java.text.SimpleDateFormat(fmt)
-	f.setTimeZone(location.timeZone ?: timeZone(time))
-	f.format(t)
-}
-
-private hideOptionsSection() {
-	(starting || ending || days || modes) ? false : true
-}
-
-private timeIntervalLabel() {
-	(starting && ending) ? hhmm(starting) + "-" + hhmm(ending, "h:mm a z") : ""
-}
+/**
+ *  Copyright 2015 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.
+ *
+ *	Button Controller
+ *
+ *	Author: SmartThings
+ *	Date: 2014-5-21
+ */
+definition(
+    name: "Button Controller",
+    namespace: "smartthings",
+    author: "SmartThings",
+    description: "Control devices with buttons like the Aeon Labs Minimote",
+    category: "Convenience",
+    iconUrl: "https://s3.amazonaws.com/smartapp-icons/MyApps/Cat-MyApps.png",
+    iconX2Url: "https://s3.amazonaws.com/smartapp-icons/MyApps/Cat-MyApps@2x.png"
+)
+
+preferences {
+	page(name: "selectButton")
+	page(name: "configureButton1")
+	page(name: "configureButton2")
+	page(name: "configureButton3")
+	page(name: "configureButton4")
+
+	page(name: "timeIntervalInput", title: "Only during a certain time") {
+		section {
+			input "starting", "time", title: "Starting", required: false
+			input "ending", "time", title: "Ending", required: false
+		}
+	}
+}
+
+def selectButton() {
+	dynamicPage(name: "selectButton", title: "First, select your button device", nextPage: "configureButton1", uninstall: configured()) {
+		section {
+			input "buttonDevice", "capability.button", title: "Button", multiple: false, required: true
+		}
+
+		section(title: "More options", hidden: hideOptionsSection(), hideable: true) {
+
+			def timeLabel = timeIntervalLabel()
+
+			href "timeIntervalInput", title: "Only during a certain time", description: timeLabel ?: "Tap to set", state: timeLabel ? "complete" : null
+
+			input "days", "enum", title: "Only on certain days of the week", multiple: true, required: false,
+				options: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
+
+			input "modes", "mode", title: "Only when mode is", multiple: true, required: false
+		}
+	}
+}
+
+def configureButton1() {
+	dynamicPage(name: "configureButton1", title: "Now let's decide how to use the first button",
+		nextPage: "configureButton2", uninstall: configured(), getButtonSections(1))
+}
+def configureButton2() {
+	dynamicPage(name: "configureButton2", title: "If you have a second button, set it up here",
+		nextPage: "configureButton3", uninstall: configured(), getButtonSections(2))
+}
+
+def configureButton3() {
+	dynamicPage(name: "configureButton3", title: "If you have a third button, you can do even more here",
+		nextPage: "configureButton4", uninstall: configured(), getButtonSections(3))
+}
+def configureButton4() {
+	dynamicPage(name: "configureButton4", title: "If you have a fourth button, you rule, and can set it up here",
+		install: true, uninstall: true, getButtonSections(4))
+}
+
+def getButtonSections(buttonNumber) {
+	return {
+		section("Lights") {
+			input "lights_${buttonNumber}_pushed", "capability.switch", title: "Pushed", multiple: true, required: false
+			input "lights_${buttonNumber}_held", "capability.switch", title: "Held", multiple: true, required: false
+		}
+		section("Locks") {
+			input "locks_${buttonNumber}_pushed", "capability.lock", title: "Pushed", multiple: true, required: false
+			input "locks_${buttonNumber}_held", "capability.lock", title: "Held", multiple: true, required: false
+		}
+		section("Sonos") {
+			input "sonos_${buttonNumber}_pushed", "capability.musicPlayer", title: "Pushed", multiple: true, required: false
+			input "sonos_${buttonNumber}_held", "capability.musicPlayer", title: "Held", multiple: true, required: false
+		}
+		section("Modes") {
+			input "mode_${buttonNumber}_pushed", "mode", title: "Pushed", required: false
+			input "mode_${buttonNumber}_held", "mode", title: "Held", required: false
+		}
+		def phrases = location.helloHome?.getPhrases()*.label
+		if (phrases) {
+			section("Hello Home Actions") {
+				log.trace phrases
+				input "phrase_${buttonNumber}_pushed", "enum", title: "Pushed", required: false, options: phrases
+				input "phrase_${buttonNumber}_held", "enum", title: "Held", required: false, options: phrases
+			}
+		}
+        section("Sirens") {
+            input "sirens_${buttonNumber}_pushed","capability.alarm" ,title: "Pushed", multiple: true, required: false
+            input "sirens_${buttonNumber}_held", "capability.alarm", title: "Held", multiple: true, required: false
+        }
+
+		section("Custom Message") {
+			input "textMessage_${buttonNumber}", "text", title: "Message", required: false
+		}
+
+        section("Push Notifications") {
+            input "notifications_${buttonNumber}_pushed","bool" ,title: "Pushed", required: false, defaultValue: false
+            input "notifications_${buttonNumber}_held", "bool", title: "Held", required: false, defaultValue: false
+        }
+
+        section("Sms Notifications") {
+            input "phone_${buttonNumber}_pushed","phone" ,title: "Pushed", required: false
+            input "phone_${buttonNumber}_held", "phone", title: "Held", required: false
+        }
+	}
+}
+
+def installed() {
+	initialize()
+}
+
+def updated() {
+	unsubscribe()
+	initialize()
+}
+
+def initialize() {
+	subscribe(buttonDevice, "button", buttonEvent)
+}
+
+def configured() {
+	return buttonDevice || buttonConfigured(1) || buttonConfigured(2) || buttonConfigured(3) || buttonConfigured(4)
+}
+
+def buttonConfigured(idx) {
+	return settings["lights_$idx_pushed"] ||
+		settings["locks_$idx_pushed"] ||
+		settings["sonos_$idx_pushed"] ||
+		settings["mode_$idx_pushed"] ||
+        settings["notifications_$idx_pushed"] ||
+        settings["sirens_$idx_pushed"] ||
+        settings["notifications_$idx_pushed"]   ||
+        settings["phone_$idx_pushed"]
+}
+
+def buttonEvent(evt){
+	if(allOk) {
+		def buttonNumber = evt.data // why doesn't jsonData work? always returning [:]
+		def value = evt.value
+		log.debug "buttonEvent: $evt.name = $evt.value ($evt.data)"
+		log.debug "button: $buttonNumber, value: $value"
+
+		def recentEvents = buttonDevice.eventsSince(new Date(now() - 3000)).findAll{it.value == evt.value && it.data == evt.data}
+		log.debug "Found ${recentEvents.size()?:0} events in past 3 seconds"
+
+		if(recentEvents.size <= 1){
+			switch(buttonNumber) {
+				case ~/.*1.*/:
+					executeHandlers(1, value)
+					break
+				case ~/.*2.*/:
+					executeHandlers(2, value)
+					break
+				case ~/.*3.*/:
+					executeHandlers(3, value)
+					break
+				case ~/.*4.*/:
+					executeHandlers(4, value)
+					break
+			}
+		} else {
+			log.debug "Found recent button press events for $buttonNumber with value $value"
+		}
+	}
+}
+
+def executeHandlers(buttonNumber, value) {
+	log.debug "executeHandlers: $buttonNumber - $value"
+
+	def lights = find('lights', buttonNumber, value)
+	if (lights != null) toggle(lights)
+
+	def locks = find('locks', buttonNumber, value)
+	if (locks != null) toggle(locks)
+
+	def sonos = find('sonos', buttonNumber, value)
+	if (sonos != null) toggle(sonos)
+
+	def mode = find('mode', buttonNumber, value)
+	if (mode != null) changeMode(mode)
+
+	def phrase = find('phrase', buttonNumber, value)
+	if (phrase != null) location.helloHome.execute(phrase)
+
+	def textMessage = findMsg('textMessage', buttonNumber)
+
+	def notifications = find('notifications', buttonNumber, value)
+	if (notifications?.toBoolean()) sendPush(textMessage ?: "Button $buttonNumber was pressed" )
+
+	def phone = find('phone', buttonNumber, value)
+	if (phone != null) sendSms(phone, textMessage ?:"Button $buttonNumber was pressed")
+
+    def sirens = find('sirens', buttonNumber, value)
+    if (sirens != null) toggle(sirens)
+}
+
+def find(type, buttonNumber, value) {
+	def preferenceName = type + "_" + buttonNumber + "_" + value
+	def pref = settings[preferenceName]
+	if(pref != null) {
+		log.debug "Found: $pref for $preferenceName"
+	}
+
+	return pref
+}
+
+def findMsg(type, buttonNumber) {
+	def preferenceName = type + "_" + buttonNumber
+	def pref = settings[preferenceName]
+	if(pref != null) {
+		log.debug "Found: $pref for $preferenceName"
+	}
+
+	return pref
+}
+
+def toggle(devices) {
+	log.debug "toggle: $devices = ${devices*.currentValue('switch')}"
+
+	if (devices*.currentValue('switch').contains('on')) {
+		devices.off()
+	}
+	else if (devices*.currentValue('switch').contains('off')) {
+		devices.on()
+	}
+	else if (devices*.currentValue('lock').contains('locked')) {
+		devices.unlock()
+	}
+	else if (devices*.currentValue('lock').contains('unlocked')) {
+		devices.lock()
+	}
+	else if (devices*.currentValue('alarm').contains('off')) {
+        devices.siren()
+    }
+	else {
+		devices.on()
+	}
+}
+
+def changeMode(mode) {
+	log.debug "changeMode: $mode, location.mode = $location.mode, location.modes = $location.modes"
+
+	if (location.mode != mode && location.modes?.find { it.name == mode }) {
+		setLocationMode(mode)
+	}
+}
+
+// execution filter methods
+private getAllOk() {
+	modeOk && daysOk && timeOk
+}
+
+private getModeOk() {
+	def result = !modes || modes.contains(location.mode)
+	log.trace "modeOk = $result"
+	result
+}
+
+private getDaysOk() {
+	def result = true
+	if (days) {
+		def df = new java.text.SimpleDateFormat("EEEE")
+		if (location.timeZone) {
+			df.setTimeZone(location.timeZone)
+		}
+		else {
+			df.setTimeZone(TimeZone.getTimeZone("America/New_York"))
+		}
+		def day = df.format(new Date())
+		result = days.contains(day)
+	}
+	log.trace "daysOk = $result"
+	result
+}
+
+private getTimeOk() {
+	def result = true
+	if (starting && ending) {
+		def currTime = now()
+		def start = timeToday(starting).time
+		def stop = timeToday(ending).time
+		result = start < stop ? currTime >= start && currTime <= stop : currTime <= stop || currTime >= start
+	}
+	log.trace "timeOk = $result"
+	result
+}
+
+private hhmm(time, fmt = "h:mm a")
+{
+	def t = timeToday(time, location.timeZone)
+	def f = new java.text.SimpleDateFormat(fmt)
+	f.setTimeZone(location.timeZone ?: timeZone(time))
+	f.format(t)
+}
+
+private hideOptionsSection() {
+	(starting || ending || days || modes) ? false : true
+}
+
+private timeIntervalLabel() {
+	(starting && ending) ? hhmm(starting) + "-" + hhmm(ending, "h:mm a z") : ""
+}