Merge pull request #1109 from SmartThingsCommunity/staging

Rolling up staging to production for deploy

devicetypes/smartthings/bose-soundtouch.src/bose-soundtouch.groovy

@@ -64,8 +64,10 @@ metadata {
     }
 
     standardTile("switch", "device.switch", width: 1, height: 1, canChangeIcon: true) {
-        state "off", label: '${name}', action: "switch.on", icon: "st.Electronics.electronics16", backgroundColor: "#ffffff"
+        state "on", label: '${name}', action: "switch.off", icon: "st.Electronics.electronics16", backgroundColor: "#79b821", nextState:"turningOff"
-        state "on", label: '${name}', action: "switch.off", icon: "st.Electronics.electronics16", backgroundColor: "#79b821"
+        state "turningOff", label:'TURNING OFF', icon:"st.Electronics.electronics16", backgroundColor:"#ffffff"
+        state "off", label: '${name}', action: "switch.on", icon: "st.Electronics.electronics16", backgroundColor: "#ffffff", nextState:"turningOn"
+        state "turningOn", label:'TURNING ON', icon:"st.Electronics.electronics16", backgroundColor:"#79b821"
     }
     valueTile("1", "device.station1", decoration: "flat", canChangeIcon: false) {
         state "station1", label:'${currentValue}', action:"preset1"
@@ -747,8 +749,16 @@ def cb_boseSetInput(xml, input) {
  */
 def boseSetPowerState(boolean enable) {
     log.info "boseSetPowerState(${enable})"
-    queueCallback('nowPlaying', "cb_boseSetPowerState", enable ? "POWERON" : "POWEROFF")
+    // Fix to get faster update of power status back from speaker after sending on/off
-    return boseRefreshNowPlaying()
+    // Instead of queuing the command to be sent after the refresh send it directly via sendHubCommand
+    // Note: This is a temporary hack that should be replaced by a re-design of the
+    // DTH to use sendHubCommand for all commands
+    sendHubCommand(bosePOST("/key", "<key state=\"press\" sender=\"Gabbo\">POWER</key>")) 
+    sendHubCommand(bosePOST("/key", "<key state=\"release\" sender=\"Gabbo\">POWER</key>"))
+    sendHubCommand(boseGET("/now_playing"))
+    if (enable) {
+        queueCallback('nowPlaying', "cb_boseConfirmPowerOn", 5)
+    }
 }
 
 /**
@@ -787,10 +797,11 @@ def cb_boseSetPowerState(xml, state) {
  */
 def cb_boseConfirmPowerOn(xml, tries) {
     def result = []
-    log.warn "boseConfirmPowerOn() attempt #" + tries
+    def attempt = tries as Integer
-    if (xml.attributes()['source'] == "STANDBY" && tries > 0) {
+    log.warn "boseConfirmPowerOn() attempt #$attempt"
+    if (xml.attributes()['source'] == "STANDBY" && attempt > 0) {
         result << boseRefreshNowPlaying()
-        queueCallback('nowPlaying', "cb_boseConfirmPowerOn", tries-1)
+        queueCallback('nowPlaying', "cb_boseConfirmPowerOn", attempt-1)
     }
     return result
 }

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

@@ -1,7 +1,8 @@
 /**
- *  ZigBee Button
+ *  Iris Smart Fob
  *
  *  Copyright 2015 Mitch Pond
+ *	Presence code adapted from SmartThings Arrival Sensor HA device type
  *
  *  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:
@@ -13,235 +14,181 @@
  *  for the specific language governing permissions and limitations under the License.
  *
  */
-
 metadata {
-    definition (name: "ZigBee Button", namespace: "smartthings", author: "Mitch Pond") {
+	definition (name: "ZigBee Button", namespace: "smartthings", author: "Mitch Pond") {
-        capability "Actuator"
+		capability "Battery"
-        capability "Battery"
+		capability "Button"
-        capability "Button"
         capability "Configuration"
-        capability "Refresh"
+		capability "Presence Sensor"
-        capability "Sensor"
+		capability "Sensor"
-
+        
-        command "enrollResponse"
+		//fingerprint endpointId: "01", profileId: "0104", inClusters: "0000,0001,0003,0007,0020,0B05", outClusters: "0003,0006,0019", model:"3450-L", manufacturer: "CentraLite"
-
+	}
-        fingerprint inClusters: "0000, 0001, 0003, 0020, 0402, 0B05", outClusters: "0003, 0006, 0008, 0019", manufacturer: "OSRAM", model: "LIGHTIFY Dimming Switch", deviceJoinName: "OSRAM LIGHTIFY Dimming Switch"
+    
-        //fingerprint inClusters: "0000, 0001, 0003, 0020, 0500", outClusters: "0003,0019", manufacturer: "CentraLite", model: "3455-L", deviceJoinName: "Iris Care Pendant"
+    preferences{
-        //fingerprint inClusters: "0000, 0001, 0003, 0007, 0020, 0402, 0B05", outClusters: "0003, 0006, 0019", manufacturer: "CentraLite", model: "3460-L", deviceJoinName: "Iris Smart Button"
+	    input ("holdTime", "number", title: "Minimum time in seconds for a press to count as \"held\"",
-        //fingerprint inClusters: "0000, 0001, 0003, 0007, 0020, 0B05", outClusters: "0003, 0006, 0019", manufacturer: "CentraLite", model:"3450-L", deviceJoinName: "Iris KeyFob"
+    		defaultValue: 3, displayDuringSetup: false)
+        input "checkInterval", "enum", title: "Presence timeout (minutes)",
+            defaultValue:"2", options: ["2", "3", "5"], displayDuringSetup: false
+        input "logging", "bool", title: "Enable debug logging",
+            defaultValue: false, displayDuringSetup: false
     }
 
-    simulator {}
+	tiles(scale: 2) {
-
+    	standardTile("presence", "device.presence", width: 4, height: 4, canChangeBackground: true) {
-    preferences {
+            state "present", label: "Present", labelIcon:"st.presence.tile.present", backgroundColor:"#53a7c0"
-        section {
+            state "not present", labelIcon:"st.presence.tile.not-present", backgroundColor:"#ffffff"
-            input ("holdTime", "number", title: "Minimum time in seconds for a press to count as \"held\"", defaultValue: 1, displayDuringSetup: false)
         }
-    }
+    	standardTile("button", "device.button", decoration: "flat", width: 2, height: 2) {
-
+        	state "default", icon: "st.unknown.zwave.remote-controller", backgroundColor: "#ffffff"
-    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: "#79b821"
         }
+		valueTile("battery", "device.battery", decoration: "flat", width: 2, height: 2) {
+			state "battery", label:'${currentValue}% battery', unit:""
+		}
 
-        valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false) {
+		main (["presence"])
-            state "battery", label:'${currentValue}% battery', unit:""
+		details(["presence","button","battery"])
-        }
+	}
-
-        standardTile("refresh", "device.refresh", inactiveLabel: false, decoration: "flat") {
-            state "default", action:"refresh.refresh", icon:"st.secondary.refresh"
-        }
-        main (["button"])
-        details(["button", "battery", "refresh"])
-    }
 }
 
 def parse(String description) {
-    log.debug "description is $description"
+    def descMap = zigbee.parseDescriptionAsMap(description)
-    def event = zigbee.getEvent(description)
+    logIt descMap
-    if (event) {
+    state.lastCheckin = now()
-        sendEvent(event)
+    logIt "lastCheckin = ${state.lastCheckin}"
-    }
+    handlePresenceEvent(true)
-    else {
+    
-        if ((description?.startsWith("catchall:")) || (description?.startsWith("read attr -"))) {
+	def results = []
-            def descMap = zigbee.parseDescriptionAsMap(description)
+    if (description?.startsWith('catchall:'))
-            if (descMap.clusterInt == 0x0001 && descMap.attrInt == 0x0020) {
+		results = parseCatchAllMessage(descMap)
-                event = getBatteryResult(zigbee.convertHexToInt(descMap.value))
+	else if (description?.startsWith('read attr -'))
-            }
+		results = parseReportAttributeMessage(descMap)
-            else if (descMap.clusterInt == 0x0006 || descMap.clusterInt == 0x0008) {
+    else logIt(descMap, "trace")
-                event = parseNonIasButtonMessage(descMap)
+        
-            }
+	return results;
-        }
-        else if (description?.startsWith('zone status')) {
-            event = parseIasButtonMessage(description)
-        }
-
-        log.debug "Parse returned $event"
-        def result = event ? createEvent(event) : []
-
-        if (description?.startsWith('enroll request')) {
-            List cmds = enrollResponse()
-            result = cmds?.collect { new physicalgraph.device.HubAction(it) }
-        }
-        return result
-    }
-}
-
-private Map parseIasButtonMessage(String description) {
-    int zoneInt = Integer.parseInt((description - "zone status 0x"), 16)
-    if (zoneInt & 0x02) {
-        resultMap = getButtonResult('press')
-    } else {
-        resultMap = getButtonResult('release')
-    }
-
-    return resultMap
-}
-
-private Map getBatteryResult(rawValue) {
-    log.debug 'Battery'
-    def volts = rawValue / 10
-    if (volts > 3.0 || volts == 0 || rawValue == 0xFF) {
-        return [:]
-    }
-    else {
-        def result = [
-                name: 'battery'
-        ]
-        def minVolts = 2.1
-        def maxVolts = 3.0
-        def pct = (volts - minVolts) / (maxVolts - minVolts)
-        result.value = Math.min(100, (int) pct * 100)
-        def linkText = getLinkText(device)
-        result.descriptionText = "${linkText} battery was ${result.value}%"
-        return result
-    }
-}
-
-private Map parseNonIasButtonMessage(Map descMap){
-    def buttonState = ""
-    def buttonNumber = 0
-    if (((device.getDataValue("model") == "3460-L") || (device.getDataValue("model") == "3450-L"))
-            &&(descMap.clusterInt == 0x0006)) {
-        if (descMap.command == "01") {
-            getButtonResult("press")
-        }
-        else if (descMap.command == "00") {
-            getButtonResult("release")
-        }
-    }
-    else if (descMap.clusterInt == 0x0006) {
-        buttonState = "pushed"
-        if (descMap.command == "01") {
-            buttonNumber = 1
-        }
-        else if (descMap.command == "00") {
-            buttonNumber = 2
-        }
-        if (buttonNumber !=0) {
-            def descriptionText = "$device.displayName button $buttonNumber was $buttonState"
-            return createEvent(name: "button", value: buttonState, data: [buttonNumber: buttonNumber], descriptionText: descriptionText, isStateChange: true)
-        }
-        else {
-            return [:]
-        }
-    }
-    else if (descMap.clusterInt == 0x0008) {
-        if (descMap.command == "05") {
-            state.buttonNumber = 1
-            getButtonResult("press", 1)
-        }
-        else if (descMap.command == "01") {
-            state.buttonNumber = 2
-            getButtonResult("press", 2)
-        }
-        else if (descMap.command == "03") {
-            getButtonResult("release", state.buttonNumber)
-        }
-    }
-}
-
-def refresh() {
-    log.debug "Refreshing Battery"
-
-    return zigbee.readAttribute(0x0001, 0x20) +
-            zigbee.enrollResponse()
-}
-
-def configure() {
-    log.debug "Configuring Reporting, IAS CIE, and Bindings."
-    def cmds = []
-    if (device.getDataValue("model") == "3450-L") {
-        cmds << [
-                "zdo bind 0x${device.deviceNetworkId} 1 1 6 {${device.zigbeeId}} {}", "delay 300",
-                "zdo bind 0x${device.deviceNetworkId} 2 1 6 {${device.zigbeeId}} {}", "delay 300",
-                "zdo bind 0x${device.deviceNetworkId} 3 1 6 {${device.zigbeeId}} {}", "delay 300",
-                "zdo bind 0x${device.deviceNetworkId} 4 1 6 {${device.zigbeeId}} {}", "delay 300"
-        ]
-    }
-    return zigbee.onOffConfig() +
-            zigbee.levelConfig() +
-            zigbee.configureReporting(0x0001, 0x20, 0x20, 30, 21600, 0x01) +
-            zigbee.enrollResponse() +
-            zigbee.readAttribute(0x0001, 0x20) +
-            cmds
-
-}
-
-private Map getButtonResult(buttonState, buttonNumber = 1) {
-    if (buttonState == 'release') {
-        log.debug "Button was value : $buttonState"
-        def timeDiff = now() - state.pressTime
-        log.info "timeDiff: $timeDiff"
-        def holdPreference = holdTime ?: 1
-        log.info "holdp1 : $holdPreference"
-        holdPreference = (holdPreference as int) * 1000
-        log.info "holdp2 : $holdPreference"
-        if (timeDiff > 10000) {         //timeDiff>10sec check for refresh sending release value causing actions to be executed
-            return [:]
-        }
-        else {
-            if (timeDiff < holdPreference) {
-                buttonState = "pushed"
-            }
-            else {
-                buttonState = "held"
-            }
-            def descriptionText = "$device.displayName button $buttonNumber was $buttonState"
-            return createEvent(name: "button", value: buttonState, data: [buttonNumber: buttonNumber], descriptionText: descriptionText, isStateChange: true)
-        }
-    }
-    else if (buttonState == 'press') {
-        log.debug "Button was value : $buttonState"
-        state.pressTime = now()
-        log.info "presstime: ${state.pressTime}"
-        return [:]
-    }
-}
-
-def installed() {
-    initialize()
 }
 
 def updated() {
-    initialize()
+	startTimer()
+    configure()
 }
 
-def initialize() {
+def configure(){
-    if ((device.getDataValue("manufacturer") == "OSRAM") && (device.getDataValue("model") == "LIGHTIFY Dimming Switch")) {
+	logIt "Configuring Smart Fob..."
-        sendEvent(name: "numberOfButtons", value: 2)
+	[
-    }
+	"zdo bind 0x${device.deviceNetworkId} 1 1 6 {${device.zigbeeId}} {}", "delay 200",
-    else if ((device.getDataValue("manufacturer") == "CentraLite") &&
+    "zdo bind 0x${device.deviceNetworkId} 2 1 6 {${device.zigbeeId}} {}", "delay 200",
-            ((device.getDataValue("model") == "3455-L") || (device.getDataValue("model") == "3460-L"))) {
+    "zdo bind 0x${device.deviceNetworkId} 3 1 6 {${device.zigbeeId}} {}", "delay 200",
-        sendEvent(name: "numberOfButtons", value: 1)
+    "zdo bind 0x${device.deviceNetworkId} 4 1 6 {${device.zigbeeId}} {}", "delay 200",
-    }
+    "zdo bind 0x${device.deviceNetworkId} 1 1 1 {${device.zigbeeId}} {}", "delay 200"
-    else if ((device.getDataValue("manufacturer") == "CentraLite") && (device.getDataValue("model") == "3450-L")) {
+    ] +
-        sendEvent(name: "numberOfButtons", value: 4)
+    zigbee.configureReporting(0x0001,0x0020,0x20,20,20,0x01)
-    }
-    else {
-        //default. can be changed
-        sendEvent(name: "numberOfButtons", value: 4)
-    }
-
 }
+
+def parseCatchAllMessage(descMap) {
+    if (descMap?.clusterId == "0006" && descMap?.command == "01") 		//button pressed
+    	handleButtonPress(descMap.sourceEndpoint as int)
+    else if (descMap?.clusterId == "0006" && descMap?.command == "00") 	//button released
+    	handleButtonRelease(descMap.sourceEndpoint as int)
+    else logIt("Parse: Unhandled message: ${descMap}","trace")
+}
+
+def parseReportAttributeMessage(descMap) {
+	if (descMap?.cluster == "0001" && descMap?.attrId == "0020") createBatteryEvent(getBatteryLevel(descMap.value))
+    else logIt descMap
+}
+
+private createBatteryEvent(percent) {
+	logIt "Battery level at " + percent
+	return createEvent([name: "battery", value: percent])
+}
+
+//this method determines if a press should count as a push or a hold and returns the relevant event type
+private handleButtonRelease(button) {
+	logIt "lastPress state variable: ${state.lastPress}"
+    def sequenceError = {logIt("Uh oh...missed a message? Dropping this event.", "error"); state.lastPress = null; return []}	
+    
+    if (!state.lastPress) return sequenceError()
+	else if (state.lastPress.button != button) return sequenceError()
+    
+    def currentTime = now()
+    def startOfPress = state.lastPress?.time
+    def timeDif = currentTime - startOfPress
+    def holdTimeMillisec = (settings.holdTime?:3).toInteger() * 1000
+    
+    state.lastPress = null	//we're done with this. clear it to make error conditions easier to catch
+    
+    if (timeDif < 0) 
+    //likely a message sequence issue or dropped packet. Drop this press and wait for another.
+    	return sequenceError()
+    else if (timeDif < holdTimeMillisec)
+    	return createButtonEvent(button,"pushed")
+    else 
+    	return createButtonEvent(button,"held")
+}
+
+private handleButtonPress(button) {
+	state.lastPress = [button: button, time: now()]
+}
+
+private createButtonEvent(button,action) {
+	logIt "Button ${button} ${action}"
+	return createEvent([
+    	name: "button",
+        value: action, 
+        data:[buttonNumber: button], 
+        descriptionText: "${device.displayName} button ${button} was ${action}",
+        isStateChange: true, 
+        displayed: true])
+}
+
+private getBatteryLevel(rawValue) {
+	def intValue = Integer.parseInt(rawValue,16)
+	def min = 2.1
+    def max = 3.0
+    def vBatt = intValue / 10
+    return ((vBatt - min) / (max - min) * 100) as int
+}
+
+private handlePresenceEvent(present) {
+    def wasPresent = device.currentState("presence")?.value == "present"
+    if (!wasPresent && present) {
+        logIt "Sensor is present"
+        startTimer()
+    } else if (!present) {
+        logIt "Sensor is not present"
+        stopTimer()
+    }
+    def linkText = getLinkText(device)
+    def eventMap = [
+        name: "presence",
+        value: present ? "present" : "not present",
+        linkText: linkText,
+        descriptionText: "${linkText} has ${present ? 'arrived' : 'left'}",
+    ]
+    logIt "Creating presence event: ${eventMap}"
+    sendEvent(eventMap)
+}
+
+private startTimer() {
+    logIt "Scheduling periodic timer"
+    schedule("0 * * * * ?", checkPresenceCallback)
+}
+
+private stopTimer() {
+    logIt "Stopping periodic timer"
+    unschedule()
+}
+
+def checkPresenceCallback() {
+    def timeSinceLastCheckin = (now() - state.lastCheckin) / 1000
+    def theCheckInterval = (checkInterval ? checkInterval as int : 2) * 60
+    logIt "Sensor checked in ${timeSinceLastCheckin} seconds ago"
+    if (timeSinceLastCheckin >= theCheckInterval) {
+        handlePresenceEvent(false)
+    }
+}
+
+// ****** Utility functions ******
+
+private logIt(str, logLevel = 'debug') {if (settings.logging) log."$logLevel"(str) }

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

@@ -20,6 +20,7 @@ metadata {
         capability "Switch"
 
         fingerprint profileId: "0104", inClusters: "0000, 0003, 0004, 0005, 0006"
+        fingerprint profileId: "0104", inClusters: "0000, 0003, 0006", outClusters: "0003, 0006, 0019, 0406", manufacturer: "Leviton", model: "ZSS-10", deviceJoinName: "Leviton Switch"
     }
 
     // simulator metadata