MSA-971: Added Device Handler for Fibaro Wall Plug ZW5

devicetypes/fibargroup/fibaro-wall-plug-zw5.src/fibaro-wall-plug-zw5.groovy

@@ -0,0 +1,254 @@
+/**
+ *  Fibaro Wall Plug ZW5
+ *
+ *  Copyright 2016 Fibar Group S.A.
+ *
+ *  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: "Fibaro Wall Plug ZW5", namespace: "fibargroup", author: "Fibar Group S.A.") {
+		capability "Actuator"
+		capability "Configuration"
+		capability "Energy Meter"
+		capability "Power Meter"
+		capability "Refresh"
+		capability "Sensor"
+		capability "Switch"
+
+		command "reset"
+        
+        fingerprint deviceId: "0x1001", inClusters: "0x5E, 0x22, 0x85, 0x59, 0x70, 0x56, 0x5A, 0x7A, 0x72, 0x32, 0x8E, 0x71, 0x73, 0x98, 0x31, 0x25, 0x86", outClusters: ""
+	}
+
+	simulator {
+		
+	}
+
+	tiles(scale: 2) {
+    	multiAttributeTile(name:"FGWP", type:"lighting", width:6, height:4) {//with generic type secondary control text is not displayed in Android app
+        	tileAttribute("device.switch", key:"PRIMARY_CONTROL") {
+            	attributeState("on", label: '${name}', action: "switch.off", icon:"st.switches.switch.on", backgroundColor:"#79b821")
+            	attributeState("off", label: '${name}', action: "switch.on", icon:"st.switches.switch.off", backgroundColor:"#ffffff")   
+            }
+            
+            tileAttribute("device.power", key:"SECONDARY_CONTROL") {
+				attributeState("default", label:'${currentValue} W', backgroundColor:"#ffffff")
+			}
+        }
+        
+		valueTile("energy", "device.energy", width: 2, height: 2) {
+			state "default", label:'${currentValue} kWh'
+		}
+		standardTile("reset", "device.energy", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
+			state "default", label:'reset kWh', action:"reset"
+		}
+		standardTile("refresh", "device.power", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
+			state "default", label:'', action:"refresh.refresh", icon:"st.secondary.refresh"
+		}
+                
+        main "FGWP"
+        details(["FGWP", "energy", "reset", "refresh"])
+	}
+}
+
+// parse events into attributes
+def parse(String description) {
+	log.debug "Parsing '${description}'"
+
+	if (description.startsWith("Err 106")) {
+		if (state.sec) {
+			result = createEvent(descriptionText:description, displayed:false)
+		} else {
+			result = createEvent(
+				descriptionText: "FGK failed to complete the network security key exchange. If you are unable to receive data from it, you must remove it from your network and add it again.",
+				eventType: "ALERT",
+				name: "secureInclusion",
+				value: "failed",
+				displayed: true,
+			)
+		}
+	} else if (description == "updated") {
+		return null
+	} else {
+    	def cmd = zwave.parse(description, [0x25: 1, 0x31: 5, 0x32: 1, 0x5A: 1, 0x71: 3, 0x72: 2, 0x86: 1])
+    
+    	if (cmd) {
+    		log.debug "Parsed '${cmd}'"
+        	zwaveEvent(cmd)
+    	}
+    }
+}
+
+//security
+def zwaveEvent(physicalgraph.zwave.commands.securityv1.SecurityMessageEncapsulation cmd) {
+	def encapsulatedCommand = cmd.encapsulatedCommand([0x25: 1, 0x5A: 1])
+	if (encapsulatedCommand) {
+		return zwaveEvent(encapsulatedCommand)
+	} else {
+		log.warn "Unable to extract encapsulated cmd from $cmd"
+		createEvent(descriptionText: cmd.toString())
+	}
+}
+
+//crc16
+def zwaveEvent(physicalgraph.zwave.commands.crc16encapv1.Crc16Encap cmd)
+{
+    def versions = [0x31: 5, 0x32: 1, 0x71: 3, 0x72: 2, 0x86: 1]
+	def version = versions[cmd.commandClass as Integer]
+	def ccObj = version ? zwave.commandClass(cmd.commandClass, version) : zwave.commandClass(cmd.commandClass)
+	def encapsulatedCommand = ccObj?.command(cmd.command)?.parse(cmd.data)
+	if (!encapsulatedCommand) {
+		log.debug "Could not extract command from $cmd"
+	} else {
+		zwaveEvent(encapsulatedCommand)
+	}
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.meterv1.MeterReport cmd) {
+	if (cmd.scale == 0) {
+		createEvent(name: "energy", value: cmd.scaledMeterValue, unit: "kWh")
+	} else if (cmd.scale == 2) {
+		createEvent(name: "power", value: Math.round(cmd.scaledMeterValue), unit: "W")
+	}
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.manufacturerspecificv2.ManufacturerSpecificReport cmd) { 
+	log.debug "manufacturerId:   ${cmd.manufacturerId}"
+    log.debug "manufacturerName: ${cmd.manufacturerName}"
+    log.debug "productId:        ${cmd.productId}"
+    log.debug "productTypeId:    ${cmd.productTypeId}"
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.manufacturerspecificv2.DeviceSpecificReport cmd) { 
+	log.debug "deviceIdData:                ${cmd.deviceIdData}"
+    log.debug "deviceIdDataFormat:          ${cmd.deviceIdDataFormat}"
+    log.debug "deviceIdDataLengthIndicator: ${cmd.deviceIdDataLengthIndicator}"
+    log.debug "deviceIdType:                ${cmd.deviceIdType}"
+    
+    if (cmd.deviceIdType == 1 && cmd.deviceIdDataFormat == 1) {//serial number in binary format
+		String serialNumber = "h'"
+        
+        cmd.deviceIdData.each{ data ->
+        	serialNumber += "${String.format("%02X", data)}"
+        }
+        
+        updateDataValue("serialNumber", serialNumber)
+        log.debug "${device.displayName} - serial number: ${serialNumber}"
+    }
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.versionv1.VersionReport cmd) {	
+    updateDataValue("version", "${cmd.applicationVersion}.${cmd.applicationSubVersion}")
+    log.debug "applicationVersion:      ${cmd.applicationVersion}"
+    log.debug "applicationSubVersion:   ${cmd.applicationSubVersion}"
+    log.debug "zWaveLibraryType:        ${cmd.zWaveLibraryType}"
+    log.debug "zWaveProtocolVersion:    ${cmd.zWaveProtocolVersion}"
+    log.debug "zWaveProtocolSubVersion: ${cmd.zWaveProtocolSubVersion}"
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.sensormultilevelv5.SensorMultilevelReport cmd) {
+	def map = [ displayed: true ]
+    if (cmd.sensorType == 4) {
+    	createEvent(name: "power", value: Math.round(cmd.scaledSensorValue), unit: "W")
+    }
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.switchbinaryv1.SwitchBinaryReport cmd) {
+	createEvent(name: "switch", value: cmd.value ? "on" : "off", type: "digital")
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.deviceresetlocallyv1.DeviceResetLocallyNotification cmd) {
+	log.info "${device.displayName}: received command: $cmd - device has reset itself"
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.notificationv3.NotificationReport cmd)
+{
+	if (cmd.notificationType == 0x08) {
+    	if (cmd.event == 0x06) {
+        	createEvent(descriptionText: "Warning: $device.displayName detected over-current", isStateChange: true)	
+        } else if (cmd.event == 0x08) {
+        	createEvent(descriptionText: "Warning: $device.displayName detected over-load", isStateChange: true)
+        }
+    }
+}
+
+def zwaveEvent(physicalgraph.zwave.Command cmd) {
+	log.debug "$device.displayName: Unhandled: $cmd"
+	[:]
+}
+
+// handle commands
+def configure() {
+	log.debug "Executing 'configure'"
+	
+    def cmds = []
+
+    cmds += zwave.manufacturerSpecificV1.manufacturerSpecificGet()
+    cmds += zwave.manufacturerSpecificV2.deviceSpecificGet()
+    cmds += zwave.versionV1.versionGet()
+    cmds += zwave.associationV2.associationSet(groupingIdentifier:1, nodeId:[zwaveHubNodeId])
+    cmds += zwave.meterV2.meterGet(scale:0)
+    cmds += zwave.meterV2.meterGet(scale:2)
+    cmds += zwave.switchBinaryV1.switchBinaryGet()
+    
+    encapSequence(cmds, 500)
+}
+
+def refresh() {
+	log.debug "Executing 'refresh'"
+	
+    def cmds = []
+    cmds += zwave.meterV2.meterGet(scale:0)
+    cmds += zwave.meterV2.meterGet(scale:2)
+    cmds += zwave.switchBinaryV1.switchBinaryGet()
+    
+    encapSequence(cmds, 500)
+}
+
+def on() {
+	log.debug "Executing 'on'"
+	encap(zwave.switchBinaryV1.switchBinarySet(switchValue: 0xFF))
+}
+
+def off() {
+	log.debug "Executing 'off'"
+	encap(zwave.switchBinaryV1.switchBinarySet(switchValue: 0x00))
+}
+
+def reset() {
+	log.debug "Executing 'reset'"
+    encap(zwave.meterV2.meterReset())
+}
+
+private secure(physicalgraph.zwave.Command cmd) {
+	zwave.securityV1.securityMessageEncapsulation().encapsulate(cmd).format()
+}
+
+private crc16(physicalgraph.zwave.Command cmd) {
+	//zwave.crc16encapV1.crc16Encap().encapsulate(cmd).format()
+    "5601${cmd.format()}0000"
+}
+
+private encapSequence(commands, delay=200) {
+	delayBetween(commands.collect{ encap(it) }, delay)
+}
+
+private encap(physicalgraph.zwave.Command cmd) {
+	def secureClasses = [0x25, 0x5A, 0x70, 0x85, 0x8E]
+
+	//todo: check if secure inclusion was successful
+    //if not do not send security-encapsulated command
+	if (secureClasses.find{ it == cmd.commandClassId }) {
+    	secure(cmd)
+    } else {
+    	crc16(cmd)
+    }
+}

devicetypes/smartthings/hue-bridge.src/hue-bridge.groovy

@@ -17,13 +17,16 @@ metadata {
 
 	tiles(scale: 2) {
      	multiAttributeTile(name:"rich-control"){
-			tileAttribute ("", key: "PRIMARY_CONTROL") {
+			tileAttribute ("device.switch", key: "PRIMARY_CONTROL") {
 	            attributeState "default", label: "Hue Bridge", action: "", icon: "st.Lighting.light99-hue", backgroundColor: "#F3C200"
-			}
+			}    
 	        tileAttribute ("serialNumber", key: "SECONDARY_CONTROL") {
 	            attributeState "default", label:'SN: ${currentValue}'
-			}
+			}    
-        }
+        }    
+		standardTile("icon", "icon", width: 1, height: 1, canChangeIcon: false, inactiveLabel: true, canChangeBackground: false) {
+			state "default", label: "Hue Bridge", action: "", icon: "st.Lighting.light99-hue", backgroundColor: "#FFFFFF"
+		}
 		valueTile("serialNumber", "device.serialNumber", decoration: "flat", height: 1, width: 2, inactiveLabel: false) {
 			state "default", label:'SN: ${currentValue}'
 		}
@@ -31,7 +34,7 @@ metadata {
 			state "default", label:'${currentValue}', height: 1, width: 2, inactiveLabel: false
 		}
 
-		main (["rich-control"])
+		main (["icon"])
 		details(["rich-control", "networkAddress"])
 	}
 }
@@ -72,7 +75,6 @@ def parse(description) {
 				}
 				else if (contentType?.contains("xml")) {
 					log.debug "HUE BRIDGE ALREADY PRESENT"
-                    parent.hubVerification(device.hub.id, msg.body)
 				}
 			}
 		}

devicetypes/smartthings/hue-bulb.src/hue-bulb.groovy

@@ -103,104 +103,62 @@ void nextLevel() {
 }
 
 void setLevel(percent) {
-    log.debug "Executing 'setLevel'"
+	log.debug "Executing 'setLevel'"
-    if (verifyPercent(percent)) {
+	parent.setLevel(this, percent)
-        parent.setLevel(this, percent)
+	sendEvent(name: "level", value: percent, descriptionText: "Level has changed to ${percent}%")
-        sendEvent(name: "level", value: percent, descriptionText: "Level has changed to ${percent}%")
-        sendEvent(name: "switch", value: "on")
-    }
 }
 
 void setSaturation(percent) {
-    log.debug "Executing 'setSaturation'"
+	log.debug "Executing 'setSaturation'"
-    if (verifyPercent(percent)) {
+	parent.setSaturation(this, percent)
-        parent.setSaturation(this, percent)
+	sendEvent(name: "saturation", value: percent, displayed: false)
-        sendEvent(name: "saturation", value: percent, displayed: false)
-    }
 }
 
 void setHue(percent) {
-    log.debug "Executing 'setHue'"
+	log.debug "Executing 'setHue'"
-    if (verifyPercent(percent)) {
+	parent.setHue(this, percent)
-        parent.setHue(this, percent)
+	sendEvent(name: "hue", value: percent, displayed: false)
-        sendEvent(name: "hue", value: percent, displayed: false)
-    }
 }
 
 void setColor(value) {
-    log.debug "setColor: ${value}, $this"
+	log.debug "setColor: ${value}, $this"
-    def events = []
+	parent.setColor(this, value)
-    def validValues = [:]
+	if (value.hue) { sendEvent(name: "hue", value: value.hue, displayed: false)}
-
+	if (value.saturation) { sendEvent(name: "saturation", value: value.saturation, displayed: false)}
-    if (verifyPercent(value.hue)) {
+	if (value.hex) { sendEvent(name: "color", value: value.hex)}
-        events << createEvent(name: "hue", value: value.hue, displayed: false)
+	if (value.level) { sendEvent(name: "level", value: value.level, descriptionText: "Level has changed to ${value.level}%")}
-        validValues.hue = value.hue
+	sendEvent(name: "switch", value: "on")
-    }
-    if (verifyPercent(value.saturation)) {
-        events << createEvent(name: "saturation", value: value.saturation, displayed: false)
-        validValues.saturation = value.saturation
-    }
-    if (value.hex != null) {
-        if (value.hex ==~ /^\#([A-Fa-f0-9]){6}$/) {
-            events << createEvent(name: "color", value: value.hex)
-            validValues.hex = value.hex
-        } else {
-            log.warn "$value.hex is not a valid color"
-        }
-    }
-    if (verifyPercent(value.level)) {
-        events << createEvent(name: "level", value: value.level, descriptionText: "Level has changed to ${value.level}%")
-        validValues.level = value.level
-    }
-    if (value.switch == "off" || (value.level != null && value.level <= 0)) {
-        events << createEvent(name: "switch", value: "off")
-        validValues.switch = "off"
-    } else {
-        events << createEvent(name: "switch", value: "on")
-        validValues.switch = "on"
-    }
-    if (!events.isEmpty()) {
-        parent.setColor(this, validValues)
-    }
-    events.each {
-        sendEvent(it)
-    }
 }
 
 void reset() {
-    log.debug "Executing 'reset'"
+	log.debug "Executing 'reset'"
     def value = [level:100, saturation:56, hue:23]
     setAdjustedColor(value)
-    parent.poll()
+	parent.poll()
 }
 
 void setAdjustedColor(value) {
-    if (value) {
+	if (value) {
         log.trace "setAdjustedColor: ${value}"
         def adjusted = value + [:]
         adjusted.hue = adjustOutgoingHue(value.hue)
         // Needed because color picker always sends 100
         adjusted.level = null
         setColor(adjusted)
-    } else {
-        log.warn "Invalid color input"
     }
 }
 
 void setColorTemperature(value) {
-    if (value) {
+	if (value) {
         log.trace "setColorTemperature: ${value}k"
         parent.setColorTemperature(this, value)
         sendEvent(name: "colorTemperature", value: value)
-        sendEvent(name: "switch", value: "on")
+	}
-    } else {
-        log.warn "Invalid color temperature"
-    }
 }
 
 void refresh() {
-    log.debug "Executing 'refresh'"
+	log.debug "Executing 'refresh'"
-    parent.manualRefresh()
+	parent.manualRefresh()
 }
 
 def adjustOutgoingHue(percent) {
@@ -219,14 +177,3 @@ def adjustOutgoingHue(percent) {
 	log.info "percent: $percent, adjusted: $adjusted"
 	adjusted
 }
-
-def verifyPercent(percent) {
-    if (percent == null)
-        return false
-    else if (percent >= 0 && percent <= 100) {
-        return true
-    } else {
-        log.warn "$percent is not 0-100"
-        return false
-    }
-}

devicetypes/smartthings/hue-lux-bulb.src/hue-lux-bulb.groovy

@@ -79,12 +79,8 @@ void off() {
 
 void setLevel(percent) {
 	log.debug "Executing 'setLevel'"
-    if (percent != null && percent >= 0 && percent <= 100) {
+	parent.setLevel(this, percent)
-		parent.setLevel(this, percent)
+	sendEvent(name: "level", value: percent)
-		sendEvent(name: "level", value: percent)
-	} else {
-    	log.warn "$percent is not 0-100"
-    }
 }
 
 void refresh() {

devicetypes/smartthings/smartsense-multi.src/smartsense-multi.groovy

@@ -203,7 +203,7 @@ private List parseContactMessage(String description) {
 	parts.each { part ->
 		part = part.trim()
 		if (part.startsWith('contactState:')) {
-			results.addAll(getContactResult(part, description))
+			results << getContactResult(part, description)
 		}
 		else if (part.startsWith('accelerationState:')) {
 			results << getAccelerationResult(part, description)
@@ -316,7 +316,7 @@ private List getContactResult(part, description) {
 	results
 }
 
-private Map getAccelerationResult(part, description) {
+private getAccelerationResult(part, description) {
 	def name = "acceleration"
 	def value = part.endsWith("1") ? "active" : "inactive"
 	def linkText = getLinkText(device)
@@ -335,7 +335,7 @@ private Map getAccelerationResult(part, description) {
 	]
 }
 
-private Map getTempResult(part, description) {
+private getTempResult(part, description) {
 	def name = "temperature"
 	def temperatureScale = getTemperatureScale()
 	def value = zigbee.parseSmartThingsTemperatureValue(part, "temp: ", temperatureScale)
@@ -360,7 +360,7 @@ private Map getTempResult(part, description) {
 	]
 }
 
-private Map getXyzResult(results, description) {
+private getXyzResult(results, description) {
 	def name = "threeAxis"
 	def value = "${results.x},${results.y},${results.z}"
 	def linkText = getLinkText(device)
@@ -379,7 +379,7 @@ private Map getXyzResult(results, description) {
 	]
 }
 
-private Map getBatteryResult(part, description) {
+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)
@@ -400,7 +400,7 @@ private Map getBatteryResult(part, description) {
 	]
 }
 
-private Map getRssiResult(part, description, lastHop=false) {
+private getRssiResult(part, description, lastHop=false) {
 	def name = lastHop ? "lastHopRssi" : "rssi"
 	def valueString = part.split(":")[1].trim()
 	def value = (Integer.parseInt(valueString) - 128).toString()
@@ -431,7 +431,7 @@ private Map getRssiResult(part, description, lastHop=false) {
  * Note: To make the signal strength indicator more accurate, we could combine
  * LQI with RSSI.
  */
-private Map getLqiResult(part, description, lastHop=false) {
+private getLqiResult(part, description, lastHop=false) {
 	def name = lastHop ? "lastHopLqi" : "lqi"
 	def valueString = part.split(":")[1].trim()
 	def percentageOf = 255

devicetypes/smartthings/zigbee-dimmer-power.src/zigbee-dimmer-power.groovy

@@ -56,17 +56,21 @@ metadata {
 def parse(String description) {
     log.debug "description is $description"
 
-    def event = zigbee.getEvent(description)
+    def resultMap = zigbee.getKnownDescription(description)
-    if (event) {
+    if (resultMap) {
-        log.info event
+        log.info resultMap
-        if (event.name == "power") {
+        if (resultMap.type == "update") {
+            log.info "$device updates: ${resultMap.value}"
+        }
+        else if (resultMap.type == "power") {
+            def powerValue
             if (device.getDataValue("manufacturer") != "OSRAM") {       //OSRAM devices do not reliably update power
-                event.value = (event.value as Integer) / 10             //TODO: The divisor value needs to be set as part of configuration
+                powerValue = (resultMap.value as Integer)/10            //TODO: The divisor value needs to be set as part of configuration
-                sendEvent(event)
+                sendEvent(name: "power", value: powerValue)
             }
         }
         else {
-            sendEvent(event)
+            sendEvent(name: resultMap.type, value: resultMap.value)
         }
     }
     else {

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

@@ -51,9 +51,15 @@ metadata {
 def parse(String description) {
     log.debug "description is $description"
 
-    def event = zigbee.getEvent(description)
+    def resultMap = zigbee.getKnownDescription(description)
-    if (event) {
+    if (resultMap) {
-        sendEvent(event)
+        log.info resultMap
+        if (resultMap.type == "update") {
+            log.info "$device updates: ${resultMap.value}"
+        }
+        else {
+            sendEvent(name: resultMap.type, value: resultMap.value)
+        }
     }
     else {
         log.warn "DID NOT PARSE MESSAGE for description : $description"

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

@@ -83,19 +83,32 @@ def uninstalled() {
 }
 
 def configure() {
+    /*
     def cmds =
-        zigbee.configureReporting(CLUSTER_DOORLOCK, DOORLOCK_ATTR_LOCKSTATE,
+        zigbee.configSetup("${CLUSTER_DOORLOCK}", "${DOORLOCK_ATTR_LOCKSTATE}",
-                                  TYPE_ENUM8, 0, 3600, null) +
+                           "${TYPE_ENUM8}", 0, 3600, "{01}") +
-        zigbee.configureReporting(CLUSTER_POWER, POWER_ATTR_BATTERY_PERCENTAGE_REMAINING,
+        zigbee.configSetup("${CLUSTER_POWER}", "${POWER_ATTR_BATTERY_PERCENTAGE_REMAINING}",
-                                  TYPE_U8, 600, 21600, 0x01)
+                           "${TYPE_U8}", 600, 21600, "{01}")
+    */
+    def zigbeeId = device.zigbeeId
+    def cmds =
+        [
+            "zdo bind 0x${device.deviceNetworkId} 0x${device.endpointId} 1 ${CLUSTER_DOORLOCK} {$zigbeeId} {}", "delay 200",
+            "zcl global send-me-a-report ${CLUSTER_DOORLOCK} ${DOORLOCK_ATTR_LOCKSTATE} ${TYPE_ENUM8} 0 3600 {01}", "delay 200",
+            "send 0x${device.deviceNetworkId} 1 0x${device.endpointId}", "delay 200",
+
+            "zdo bind 0x${device.deviceNetworkId} 0x${device.endpointId} 1 ${CLUSTER_POWER} {$zigbeeId} {}", "delay 200",
+            "zcl global send-me-a-report ${CLUSTER_POWER} ${POWER_ATTR_BATTERY_PERCENTAGE_REMAINING} ${TYPE_U8} 600 21600 {01}", "delay 200",
+            "send 0x${device.deviceNetworkId} 1 0x${device.endpointId}", "delay 200",
+        ]
     log.info "configure() --- cmds: $cmds"
     return cmds + refresh() // send refresh cmds as part of config
 }
 
 def refresh() {
     def cmds =
-        zigbee.readAttribute(CLUSTER_DOORLOCK, DOORLOCK_ATTR_LOCKSTATE) +
+        zigbee.refreshData("${CLUSTER_DOORLOCK}", "${DOORLOCK_ATTR_LOCKSTATE}") +
-        zigbee.readAttribute(CLUSTER_POWER, POWER_ATTR_BATTERY_PERCENTAGE_REMAINING)
+        zigbee.refreshData("${CLUSTER_POWER}", "${POWER_ATTR_BATTERY_PERCENTAGE_REMAINING}")
     log.info "refresh() --- cmds: $cmds"
     return cmds
 }
@@ -108,27 +121,34 @@ def parse(String description) {
         map = parseReportAttributeMessage(description)
     }
 
+    log.debug "parse() --- Parse returned $map"
     def result = map ? createEvent(map) : null
-    log.debug "parse() --- returned: $result"
     return result
 }
 
 // Lock capability commands
 def lock() {
-    def cmds = zigbee.command(CLUSTER_DOORLOCK, DOORLOCK_CMD_LOCK_DOOR)
+    //def cmds = zigbee.zigbeeCommand("${CLUSTER_DOORLOCK}", "${DOORLOCK_CMD_LOCK_DOOR}", "{}")
-    log.info "lock() -- cmds: $cmds"
+    //log.info "lock() -- cmds: $cmds"
-    return cmds
+    //return cmds
+    "st cmd 0x${device.deviceNetworkId} 0x${device.endpointId} ${CLUSTER_DOORLOCK} ${DOORLOCK_CMD_LOCK_DOOR} {}"
 }
 
 def unlock() {
-    def cmds = zigbee.command(CLUSTER_DOORLOCK, DOORLOCK_CMD_UNLOCK_DOOR)
+    //def cmds = zigbee.zigbeeCommand("${CLUSTER_DOORLOCK}", "${DOORLOCK_CMD_UNLOCK_DOOR}", "{}")
-    log.info "unlock() -- cmds: $cmds"
+    //log.info "unlock() -- cmds: $cmds"
-    return cmds
+    //return cmds
+    "st cmd 0x${device.deviceNetworkId} 0x${device.endpointId} ${CLUSTER_DOORLOCK} ${DOORLOCK_CMD_UNLOCK_DOOR} {}"
 }
 
 // Private methods
 private Map parseReportAttributeMessage(String description) {
+    log.trace "parseReportAttributeMessage() --- description: $description"
+
     Map descMap = zigbee.parseDescriptionAsMap(description)
+
+    log.debug "parseReportAttributeMessage() --- descMap: $descMap"
+
     Map resultMap = [:]
     if (descMap.clusterInt == CLUSTER_POWER && descMap.attrInt == POWER_ATTR_BATTERY_PERCENTAGE_REMAINING) {
         resultMap.name = "battery"
@@ -136,24 +156,18 @@ private Map parseReportAttributeMessage(String description) {
         if (device.getDataValue("manufacturer") == "Yale") {            //Handling issue with Yale locks incorrect battery reporting
             resultMap.value = Integer.parseInt(descMap.value, 16)
         }
+        log.info "parseReportAttributeMessage() --- battery: ${resultMap.value}"
     }
     else if (descMap.clusterInt == CLUSTER_DOORLOCK && descMap.attrInt == DOORLOCK_ATTR_LOCKSTATE) {
         def value = Integer.parseInt(descMap.value, 16)
-        def linkText = getLinkText(device)
         resultMap.name = "lock"
-        if (value == 0) {
+        resultMap.putAll([0:["value":"unknown",
-            resultMap.value = "unknown"
+                             "descriptionText":"Not fully locked"],
-            resultMap.descriptionText = "${linkText} is not fully locked"
+                          1:["value":"locked"],
-        } else if (value == 1) {
+                          2:["value":"unlocked"]].get(value,
-            resultMap.value = "locked"
+                                                      ["value":"unknown",
-            resultMap.descriptionText = "${linkText} is locked"
+                                                       "descriptionText":"Unknown lock state"]))
-        } else if (value == 2) {
+        log.info "parseReportAttributeMessage() --- lock: ${resultMap.value}"
-            resultMap.value = "unlocked"
-            resultMap.descriptionText = "${linkText} is unlocked"
-        } else {
-            resultMap.value = "unknown"
-            resultMap.descriptionText = "${linkText} is in unknown lock state"
-        }
     }
     else {
         log.debug "parseReportAttributeMessage() --- ignoring attribute"

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

@@ -51,15 +51,22 @@ metadata {
 // Parse incoming device messages to generate events
 def parse(String description) {
     log.debug "description is $description"
-    def event = zigbee.getEvent(description)
+
-    if (event) {
+    def resultMap = zigbee.getKnownDescription(description)
-        if (event.name == "power") {
+    if (resultMap) {
+        log.info resultMap
+        if (resultMap.type == "update") {
+            log.info "$device updates: ${resultMap.value}"
+        }
+        else if (resultMap.type == "power") {
             def powerValue
-            powerValue = (event.value as Integer)/10            //TODO: The divisor value needs to be set as part of configuration
+            if (device.getDataValue("manufacturer") != "OSRAM") {       //OSRAM devices do not reliably update power
-            sendEvent(name: "power", value: powerValue)
+                powerValue = (resultMap.value as Integer)/10            //TODO: The divisor value needs to be set as part of configuration
+                sendEvent(name: "power", value: powerValue)
+            }
         }
         else {
-            sendEvent(event)
+            sendEvent(name: resultMap.type, value: resultMap.value)
         }
     }
     else {

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

@@ -53,9 +53,16 @@ metadata {
 // Parse incoming device messages to generate events
 def parse(String description) {
     log.debug "description is $description"
-    def event = zigbee.getEvent(description)
+
-    if (event) {
+    def resultMap = zigbee.getKnownDescription(description)
-        sendEvent(event)
+    if (resultMap) {
+        log.info resultMap
+        if (resultMap.type == "update") {
+            log.info "$device updates: ${resultMap.value}"
+        }
+        else {
+            sendEvent(name: resultMap.type, value: resultMap.value)
+        }
     }
     else {
         log.warn "DID NOT PARSE MESSAGE for description : $description"

devicetypes/smartthings/zigbee-white-color-temperature-bulb.src/zigbee-white-color-temperature-bulb.groovy

@@ -73,9 +73,16 @@ metadata {
 // Parse incoming device messages to generate events
 def parse(String description) {
     log.debug "description is $description"
-    def event = zigbee.getEvent(description)
+
-    if (event) {
+    def finalResult = zigbee.getKnownDescription(description)
-        sendEvent(event)
+    if (finalResult) {
+        log.info finalResult
+        if (finalResult.type == "update") {
+            log.info "$device updates: ${finalResult.value}"
+        }
+        else {
+            sendEvent(name: finalResult.type, value: finalResult.value)
+        }
     }
     else {
         log.warn "DID NOT PARSE MESSAGE for description : $description"

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

@@ -41,7 +41,6 @@ metadata {
 				attributeState "locked", label:'locked', action:"lock.unlock", icon:"st.locks.lock.locked", backgroundColor:"#79b821", nextState:"unlocking"
 				attributeState "unlocked", label:'unlocked', action:"lock.lock", icon:"st.locks.lock.unlocked", backgroundColor:"#ffffff", nextState:"locking"
 				attributeState "unknown", label:"unknown", action:"lock.lock", icon:"st.locks.lock.unknown", backgroundColor:"#ffffff", nextState:"locking"
-				attributeState "jammed", label:"jammed", action:"lock.lock", icon:"st.locks.lock.unknown", backgroundColor:"#ffffff", nextState:"locking"
 				attributeState "locking", label:'locking', icon:"st.locks.lock.locked", backgroundColor:"#79b821"
 				attributeState "unlocking", label:'unlocking', icon:"st.locks.lock.unlocked", backgroundColor:"#ffffff"
 			}
@@ -131,7 +130,7 @@ def zwaveEvent(DoorLockOperationReport cmd) {
 	if (cmd.doorLockMode == 0xFF) {
 		map.value = "locked"
 	} else if (cmd.doorLockMode >= 0x40) {
-		map.value = "unknown" // XXX: Jammed?
+		map.value = "unknown"
 	} else if (cmd.doorLockMode & 1) {
 		map.value = "unlocked with timeout"
 	} else {
@@ -181,7 +180,7 @@ def zwaveEvent(physicalgraph.zwave.commands.alarmv2.AlarmReport cmd) {
 				map = [ name: "lock", value: "unknown", descriptionText: "$device.displayName was not locked fully" ]
 				break
 			case 0xB:
-				map = [ name: "lock", value: "jammed", descriptionText: "$device.displayName is jammed", displayed: true, eventType: "ALERT" ]
+				map = [ name: "lock", value: "unknown", descriptionText: "$device.displayName is jammed" ]
 				break
 			case 0xC:
 				map = [ name: "codeChanged", value: "all", descriptionText: "$device.displayName: all user codes deleted", isStateChange: true ]
@@ -267,7 +266,7 @@ def zwaveEvent(physicalgraph.zwave.commands.alarmv2.AlarmReport cmd) {
 		case 17:
 		case 23:
 		case 26:
-			map = [ name: "lock", value: "jammed", descriptionText: "$device.displayName bolt is jammed", displayed: true, eventType: "ALERT" ]
+			map = [ name: "lock", value: "unknown", descriptionText: "$device.displayName bolt is jammed" ]
 			break
 		case 13:
 			map = [ name: "codeChanged", value: cmd.alarmLevel, descriptionText: "$device.displayName code $cmd.alarmLevel was added", isStateChange: true ]

devicetypes/smartthings/zwave-motion-sensor.src/zwave-motion-sensor.groovy

@@ -57,7 +57,7 @@ def parse(String description) {
 	return result
 }
 
-def sensorValueEvent(value) {
+def sensorValueEvent(Short value) {
 	if (value) {
 		createEvent(name: "motion", value: "active", descriptionText: "$device.displayName detected motion")
 	} else {
@@ -94,24 +94,24 @@ def zwaveEvent(physicalgraph.zwave.commands.notificationv3.NotificationReport cm
 {
 	def result = []
 	if (cmd.notificationType == 0x07) {
-		if (cmd.v1AlarmType == 0x07) {  // special case for nonstandard messages from Monoprice ensors
+		if (cmd.event == 0x01 || cmd.event == 0x02) {
-			result << sensorValueEvent(cmd.v1AlarmLevel)
-		} else if (cmd.event == 0x01 || cmd.event == 0x02 || cmd.event == 0x07 || cmd.event == 0x08) {
 			result << sensorValueEvent(1)
-		} else if (cmd.event == 0x00) {
-			result << sensorValueEvent(0)
 		} else if (cmd.event == 0x03) {
-			result << createEvent(name: "tamper", value: "detected", descriptionText: "$device.displayName covering was removed", isStateChange: true)
+			result << createEvent(descriptionText: "$device.displayName covering was removed", isStateChange: true)
-			result << response(zwave.batteryV1.batteryGet())
+			result << response(zwave.wakeUpV1.wakeUpIntervalSet(seconds:4*3600, nodeid:zwaveHubNodeId))
+			if(!state.MSR) result << response(zwave.manufacturerSpecificV2.manufacturerSpecificGet())
 		} else if (cmd.event == 0x05 || cmd.event == 0x06) {
 			result << createEvent(descriptionText: "$device.displayName detected glass breakage", isStateChange: true)
+		} else if (cmd.event == 0x07) {
+			if(!state.MSR) result << response(zwave.manufacturerSpecificV2.manufacturerSpecificGet())
+			result << sensorValueEvent(1)
 		}
 	} else if (cmd.notificationType) {
 		def text = "Notification $cmd.notificationType: event ${([cmd.event] + cmd.eventParameter).join(", ")}"
-		result << createEvent(name: "notification$cmd.notificationType", value: "$cmd.event", descriptionText: text, isStateChange: true, displayed: false)
+		result << createEvent(name: "notification$cmd.notificationType", value: "$cmd.event", descriptionText: text, displayed: false)
 	} else {
 		def value = cmd.v1AlarmLevel == 255 ? "active" : cmd.v1AlarmLevel ?: "inactive"
-		result << createEvent(name: "alarm $cmd.v1AlarmType", value: value, isStateChange: true, displayed: false)
+		result << createEvent(name: "alarm $cmd.v1AlarmType", value: value, displayed: false)
 	}
 	result
 }

devicetypes/smartthings/zwave-smoke-alarm.src/zwave-smoke-alarm.groovy

@@ -61,44 +61,37 @@ def parse(String description) {
 			zwaveEvent(cmd, results)
 		}
 	}
-	log.debug "'$description' parsed to ${results.inspect()}"
+	// log.debug "\"$description\" parsed to ${results.inspect()}"
 	return results
 }
 
 
 def createSmokeOrCOEvents(name, results) {
 	def text = null
-	switch (name) {
+	if (name == "smoke") {
-		case "smoke":
+		text = "$device.displayName smoke was detected!"
-			text = "$device.displayName smoke was detected!"
+		// these are displayed:false because the composite event is the one we want to see in the app
-			// these are displayed:false because the composite event is the one we want to see in the app
+		results << createEvent(name: "smoke",          value: "detected", descriptionText: text, displayed: false)
-			results << createEvent(name: "smoke",          value: "detected", descriptionText: text, displayed: false)
+	} else if (name == "carbonMonoxide") {
-			break
+		text = "$device.displayName carbon monoxide was detected!"
-		case "carbonMonoxide":
+		results << createEvent(name: "carbonMonoxide", value: "detected", descriptionText: text, displayed: false)
-			text = "$device.displayName carbon monoxide was detected!"
+	} else if (name == "tested") {
-			results << createEvent(name: "carbonMonoxide", value: "detected", descriptionText: text, displayed: false)
+		text = "$device.displayName was tested"
-			break
+		results << createEvent(name: "smoke",          value: "tested", descriptionText: text, displayed: false)
-		case "tested":
+		results << createEvent(name: "carbonMonoxide", value: "tested", descriptionText: text, displayed: false)
-			text = "$device.displayName was tested"
+	} else if (name == "smokeClear") {
-			results << createEvent(name: "smoke",          value: "tested", descriptionText: text, displayed: false)
+		text = "$device.displayName smoke is clear"
-			results << createEvent(name: "carbonMonoxide", value: "tested", descriptionText: text, displayed: false)
+		results << createEvent(name: "smoke",          value: "clear", descriptionText: text, displayed: false)
-			break
+		name = "clear"
-		case "smokeClear":
+	} else if (name == "carbonMonoxideClear") {
-			text = "$device.displayName smoke is clear"
+		text = "$device.displayName carbon monoxide is clear"
-			results << createEvent(name: "smoke",          value: "clear", descriptionText: text, displayed: false)
+		results << createEvent(name: "carbonMonoxide", value: "clear", descriptionText: text, displayed: false)
-			name = "clear"
+		name = "clear"
-			break
+	} else if (name == "testClear") {
-		case "carbonMonoxideClear":
+		text = "$device.displayName smoke is clear"
-			text = "$device.displayName carbon monoxide is clear"
+		results << createEvent(name: "smoke",          value: "clear", descriptionText: text, displayed: false)
-			results << createEvent(name: "carbonMonoxide", value: "clear", descriptionText: text, displayed: false)
+		results << createEvent(name: "carbonMonoxide", value: "clear", displayed: false)
-			name = "clear"
+		name = "clear"
-			break
-		case "testClear":
-			text = "$device.displayName test cleared"
-			results << createEvent(name: "smoke",          value: "clear", descriptionText: text, displayed: false)
-			results << createEvent(name: "carbonMonoxide", value: "clear", displayed: false)
-			name = "clear"
-			break
 	}
 	// This composite event is used for updating the tile
 	results << createEvent(name: "alarmState", value: name, descriptionText: text)
@@ -124,10 +117,8 @@ def zwaveEvent(physicalgraph.zwave.commands.alarmv2.AlarmReport cmd, results) {
 			createSmokeOrCOEvents(cmd.alarmLevel ? "tested" : "testClear", results)
 			break
 		case 13:  // sent every hour -- not sure what this means, just a wake up notification?
-			if (cmd.alarmLevel == 255) {
+			if (cmd.alarmLevel != 255) {
-				results << createEvent(descriptionText: "$device.displayName checked in", isStateChange: false)
+				results << createEvent(descriptionText: "$device.displayName code 13 is $cmd.alarmLevel", displayed: true)
-			} else {
-				results << createEvent(descriptionText: "$device.displayName code 13 is $cmd.alarmLevel", isStateChange:true, displayed:false)
 			}
 			
 			// Clear smoke in case they pulled batteries and we missed the clear msg
@@ -136,8 +127,9 @@ def zwaveEvent(physicalgraph.zwave.commands.alarmv2.AlarmReport cmd, results) {
 			}
 			
 			// Check battery if we don't have a recent battery event
-			if (!state.lastbatt || (now() - state.lastbatt) >= 48*60*60*1000) {
+			def prevBattery = device.currentState("battery")
-				results << response(zwave.batteryV1.batteryGet())
+			if (!prevBattery || (new Date().time - prevBattery.date.time)/60000 >= 60 * 53) {
+				results << new physicalgraph.device.HubAction(zwave.batteryV1.batteryGet().format())
 			}
 			break
 		default:
@@ -166,17 +158,12 @@ def zwaveEvent(physicalgraph.zwave.commands.sensoralarmv1.SensorAlarmReport cmd,
 }
 
 def zwaveEvent(physicalgraph.zwave.commands.wakeupv1.WakeUpNotification cmd, results) {
+	results << new physicalgraph.device.HubAction(zwave.wakeUpV1.wakeUpNoMoreInformation().format())
 	results << createEvent(descriptionText: "$device.displayName woke up", isStateChange: false)
-	if (!state.lastbatt || (now() - state.lastbatt) >= 56*60*60*1000) {
-		results << response(zwave.batteryV1.batteryGet(), "delay 2000", zwave.wakeUpV1.wakeUpNoMoreInformation())
-	} else {
-		results << response(zwave.wakeUpV1.wakeUpNoMoreInformation())
-	}
 }
 
 def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd, results) {
-	def map = [ name: "battery", unit: "%", isStateChange: true ]
+	def map = [ name: "battery", unit: "%" ]
-	state.lastbatt = now()
 	if (cmd.batteryLevel == 0xFF) {
 		map.value = 1
 		map.descriptionText = "$device.displayName battery is low!"

smartapps/smartthings/hue-connect.src/hue-connect.groovy

@@ -68,7 +68,7 @@ def bridgeDiscovery(params=[:])
 	}
 
 	//setup.xml request every 3 seconds except on discoveries
-	if(((bridgeRefreshCount % 3) == 0) && ((bridgeRefreshCount % 5) != 0)) {
+	if(((bridgeRefreshCount % 1) == 0) && ((bridgeRefreshCount % 5) != 0)) {
 		verifyHueBridges()
 	}
 
@@ -175,7 +175,6 @@ private discoverHueBulbs() {
 }
 
 private verifyHueBridge(String deviceNetworkId, String host) {
-	log.trace "Verify Hue Bridge $deviceNetworkId"
 	sendHubCommand(new physicalgraph.device.HubAction([
 		method: "GET",
 		path: "/description.xml",
@@ -603,20 +602,6 @@ def parse(childDevice, description) {
 	}
 }
 
-def hubVerification(bodytext) {
-	log.trace "Bridge sent back description.xml for verification"
-    def body = new XmlSlurper().parseText(bodytext)
-    if (body?.device?.modelName?.text().startsWith("Philips hue bridge")) {
-        def bridges = getHueBridges()
-        def bridge = bridges.find {it?.key?.contains(body?.device?.UDN?.text())}
-        if (bridge) {
-            bridge.value << [name:body?.device?.friendlyName?.text(), serialNumber:body?.device?.serialNumber?.text(), verified: true]
-        } else {
-            log.error "/description.xml returned a bridge that didn't exist"
-        }
-    }
-}
-
 def on(childDevice) {
 	log.debug "Executing 'on'"
 	put("lights/${getId(childDevice)}/state", [on: true])
@@ -657,53 +642,39 @@ def setColorTemperature(childDevice, huesettings) {
 }
 
 def setColor(childDevice, huesettings) {
-    log.debug "Executing 'setColor($huesettings)'"
+	log.debug "Executing 'setColor($huesettings)'"
-    
-    def value = [:]
     def hue = null
     def sat = null
     def xy = null
-    
+    if (huesettings.hex) {
-    if (huesettings.hex != null) {
+    	xy = getHextoXY(huesettings.hex)
-        value.xy = getHextoXY(huesettings.hex)
+    } else if (huesettings.hue && huesettings.saturation) {
-    } else {
+		hue = Math.min(Math.round(huesettings.hue * 65535 / 100), 65535)
-        if (huesettings.hue != null)
+		sat = Math.min(Math.round(huesettings.saturation * 255 / 100), 255)
-            value.hue = Math.min(Math.round(huesettings.hue * 65535 / 100), 65535)
-        if (huesettings.saturation != null)   
-            value.sat = Math.min(Math.round(huesettings.saturation * 255 / 100), 255)
     }
-    
+    def alert = huesettings.alert ? huesettings.alert : "none"
-    // Default behavior is to turn light on 
+    def transition = huesettings.transition ? huesettings.transition : 4
-    value.on = true
 
-    if (huesettings.level != null) {
+	def value = [xy: xy, sat: sat, hue: hue, alert: alert, transitiontime: transition, on: true]
-        if (huesettings.level <= 0)
-            value.on = false
-        else if (huesettings.level == 1)
-            value.bri = 1
-        else 
-            value.bri = Math.min(Math.round(huesettings.level * 255 / 100), 255)
-    }
-    value.alert = huesettings.alert ? huesettings.alert : "none"
-    value.transition = huesettings.transition ? huesettings.transition : 4
 
-    // Make sure to turn off light if requested
+	if (huesettings.level != null) {
-    if (huesettings.switch == "off")
+        if (huesettings.level == 1) value.bri = 1 else value.bri = Math.min(Math.round(huesettings.level * 255 / 100), 255)
-        value.on = false
+		value.on = value.bri > 0
+	}
 
-    log.debug "sending command $value"
+	log.debug "sending command $value"
-    put("lights/${getId(childDevice)}/state", value)
+	put("lights/${getId(childDevice)}/state", value)
-    return "Color set to $value"
 }
 
 def nextLevel(childDevice) {
-    def level = device.latestValue("level") as Integer ?: 0
+	def level = device.latestValue("level") as Integer ?: 0
-    if (level < 100) {
+	if (level < 100) {
-        level = Math.min(25 * (Math.round(level / 25) + 1), 100) as Integer
+		level = Math.min(25 * (Math.round(level / 25) + 1), 100) as Integer
-    } else {
+	}
-        level = 25
+	else {
-    }
+		level = 25
-    setLevel(childDevice,level)
+	}
+	setLevel(childDevice,level)
 }
 
 private getId(childDevice) {
@@ -802,14 +773,16 @@ private getHextoXY(String colorStr) {
 
     // Make green more vivid
     if (normalizedToOne[1] > 0.04045) {
-        green = (float) Math.pow((normalizedToOne[1] + 0.055) / (1.0 + 0.055), 2.4);
+        green = (float) Math.pow((normalizedToOne[1] + 0.055)
+                / (1.0 + 0.055), 2.4);
     } else {
         green = (float) (normalizedToOne[1] / 12.92);
     }
 
     // Make blue more vivid
     if (normalizedToOne[2] > 0.04045) {
-        blue = (float) Math.pow((normalizedToOne[2] + 0.055) / (1.0 + 0.055), 2.4);
+        blue = (float) Math.pow((normalizedToOne[2] + 0.055)
+                / (1.0 + 0.055), 2.4);
     } else {
         blue = (float) (normalizedToOne[2] / 12.92);
     }
@@ -818,8 +791,8 @@ private getHextoXY(String colorStr) {
     float Y = (float) (red * 0.234327 + green * 0.743075 + blue * 0.022598);
     float Z = (float) (red * 0.0000000 + green * 0.053077 + blue * 1.035763);
 
-    float x = (X != 0 ? X / (X + Y + Z) : 0);
+    float x = X / (X + Y + Z);
-    float y = (Y != 0 ? Y / (X + Y + Z) : 0);
+    float y = Y / (X + Y + Z);
 
     double[] xy = new double[2];
     xy[0] = x;

smartapps/tslagle13/vacation-lighting-director.src/vacation-lighting-director.groovy

@@ -1,17 +1,11 @@
 /**
  *  Vacation Lighting Director
  * 
- * Version  2.5 - Moved scheduling over to Cron and added time as a trigger. 
+ *  Version  2.4 - Added information paragraphs
- *				  Cleaned up formatting and some typos.
- *                Updated license.
- *                Made people option optional
- * 				  Added sttement to unschedule on mode change if people option is not selected
- *
- * Version  2.4 - Added information paragraphs
  * 
  *  Source code can be found here: https://github.com/tslagle13/SmartThings/blob/master/smartapps/tslagle13/vacation-lighting-director.groovy
  *
- *  Copyright 2016 Tim Slagle
+ *  Copyright 2015 Tim Slagle
  *
  *  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:
@@ -57,7 +51,8 @@ def pageSetup() {
 	return dynamicPage(pageProperties) {
     	section(""){
         	paragraph "This app can be used to make your home seem occupied anytime you are away from your home. " +
-			"Please use each of the the sections below to setup the different preferences to your liking. " 
+			"Please use each othe the sections below to setup the different preferences to your liking. " +
+			"I recommend this app be used with at least two away modes.  An example would be 'Away Day' 'and Away Night'. " 
         }
         section("Setup Menu") {
             href "Setup", title: "Setup", description: "", state:greyedOut()
@@ -75,7 +70,7 @@ def Setup() {
     def newMode = [
         name:       	"newMode",
         type:       	"mode",
-        title:      	"Modes",
+        title:      	"Which?",
         multiple:   	true,
         required:   	true
     ]
@@ -101,6 +96,14 @@ def Setup() {
         required:	true,
     ]
     
+    def people = [
+        name:       "people",
+        type:       "capability.presenceSensor",
+        title:      "If these people are home do not change light status",
+        required:	true,
+        multiple:	true
+    ]
+    
     def pageName = "Setup"
     
     def pageProperties = [
@@ -113,11 +116,10 @@ def Setup() {
 
 		section(""){            
                     paragraph "In this section you need to setup the deatils of how you want your lighting to be affected while " +
-                    "you are away.  All of these settings are required in order for the simulator to run correctly."
+                    paragraph "you are away.  All of these settings are required in order for the simulator to run correctly."
         }
-        section("Simulator Triggers") {
+        section("Which mode change triggers the simulator? (This app will only run in selected mode(s))") {
-                    input newMode  
+                    input newMode           
-                    href "timeIntervalInput", title: "Times", description: timeIntervalLabel(), refreshAfterSelection:true
         }
         section("Light switches to turn on/off") {
                     input switches           
@@ -128,6 +130,9 @@ def Setup() {
         section("Number of active lights at any given time") {
                     input number_of_active_lights           
         }    
+        section("People") {
+                    input people            
+        }
     }
     
 }
@@ -157,29 +162,18 @@ def Settings() {
         title:      "Settings",
         nextPage:   "pageSetup"
     ]
-    
-    def people = [
-        name:       "people",
-        type:       "capability.presenceSensor",
-        title:      "If these people are home do not change light status",
-        required:	false,
-        multiple:	true
-    ]
 
     return dynamicPage(pageProperties) {
 
 		section(""){              
                     paragraph "In this section you can restrict how your simulator runs.  For instance you can restrict on which days it will run " +
-                    "as well as a delay for the simulator to start after it is in the correct mode.  Delaying the simulator helps with false starts based on a incorrect mode change."
+                    paragraph "as well as a delay for the simulator to start after it is in the correct mode.  Delaying the simulator helps with false starts based on a incorrect mode change."
         }
         section("Delay to start simulator") {
                     input falseAlarmThreshold
         }
-        section("People") {
-        			paragraph "Not using this setting may cause some lights to remain on when you arrive home"
-                    input people            
-        }
         section("More options") {
+                    href "timeIntervalInput", title: "Only during a certain time", description: getTimeLabel(starting, ending), state: greyedOutTime(starting, ending), refreshAfterSelection:true
                     input days
         } 
     }   
@@ -187,24 +181,9 @@ def Settings() {
 
 page(name: "timeIntervalInput", title: "Only during a certain time", refreshAfterSelection:true) {
 		section {
-			input "startTimeType", "enum", title: "Starting at", options: [["time": "A specific time"], ["sunrise": "Sunrise"], ["sunset": "Sunset"]], defaultValue: "time", submitOnChange: true
+			input "starting", "time", title: "Starting", required: false 
-			if (startTimeType in ["sunrise","sunset"]) {
+			input "ending", "time", title: "Ending", required: false 
-				input "startTimeOffset", "number", title: "Offset in minutes (+/-)", range: "*..*", required: false
-			}
-			else {
-				input "starting", "time", title: "Start time", required: false
-			}
 		}
-		section {
-			input "endTimeType", "enum", title: "Ending at", options: [["time": "A specific time"], ["sunrise": "Sunrise"], ["sunset": "Sunset"]], defaultValue: "time", submitOnChange: true
-			if (endTimeType in ["sunrise","sunset"]) {
-				input "endTimeOffset", "number", title: "Offset in minutes (+/-)", range: "*..*", required: false
-			}
-			else {
-				input "ending", "time", title: "End time", required: false
-			}
-		}
-        
 }
 
 def installed() {
@@ -222,13 +201,10 @@ def initialize(){
 	if (newMode != null) {
 		subscribe(location, modeChangeHandler)
     }
-    if (starting != null) {
-    	schedule(starting, modeChangeHandler)
-    }
-    log.debug "Installed with settings: ${settings}"
 }
 
 def modeChangeHandler(evt) {
+	log.debug "Mode change to: ${evt.value}"
 		def delay = (falseAlarmThreshold != null && falseAlarmThreshold != "") ? falseAlarmThreshold * 60 : 2 * 60  
     	runIn(delay, scheduleCheck)
 }
@@ -236,54 +212,48 @@ def modeChangeHandler(evt) {
 
 //Main logic to pick a random set of lights from the large set of lights to turn on and then turn the rest off
 def scheduleCheck(evt) {
-    if(allOk){
+if(allOk){
-        log.debug("Running")
+log.debug("Running")
-        // turn off all the switches
+  // turn off all the switches
-        switches.off()
+  switches.off()
-        
+
-        // grab a random switch
+  // grab a random switch
-        def random = new Random()
+  def random = new Random()
-        def inactive_switches = switches
+  def inactive_switches = switches
-        for (int i = 0 ; i < number_of_active_lights ; i++) {
+  for (int i = 0 ; i < number_of_active_lights ; i++) {
-            // if there are no inactive switches to turn on then let's break
+    // if there are no inactive switches to turn on then let's break
-            if (inactive_switches.size() == 0){
+    if (inactive_switches.size() == 0){
-                break
+      break
-            }
-            
-            // grab a random switch and turn it on
-            def random_int = random.nextInt(inactive_switches.size())
-            inactive_switches[random_int].on()
-            
-            // then remove that switch from the pool off switches that can be turned on
-            inactive_switches.remove(random_int)
-        }
-        
-        // re-run again when the frequency demands it
-        schedule("0 0/${frequency_minutes} * 1/1 * ? *", scheduleCheck)
     }
-    //Check to see if mode is ok but not time/day.  If mode is still ok, check again after frequency period.
+
-    else if (modeOk) {
+    // grab a random switch and turn it on
-        log.debug("mode OK.  Running again")
+    def random_int = random.nextInt(inactive_switches.size())
-        switches.off()
+    inactive_switches[random_int].on()
-    }
+
-    //if none is ok turn off frequency check and turn off lights.
+    // then remove that switch from the pool off switches that can be turned on
-    else {
+    inactive_switches.remove(random_int)
-    	if(people){
+  }
-        	//don't turn off lights if anyone is home
+
-        	if(someoneIsHome()){
+  // re-run again when the frequency demands it
-        	    log.debug("Stopping Check for Light")
+  runIn(frequency_minutes * 60, scheduleCheck)
-        	    unschedule()
+}
-        	}
+//Check to see if mode is ok but not time/day.  If mode is still ok, check again after frequency period.
-        	else{
+else if (modeOk) {
-        	    log.debug("Stopping Check for Light and turning off all lights")
+	log.debug("mode OK.  Running again")
-        	    switches.off()
+	runIn(frequency_minutes * 60, scheduleCheck)
-        	    unschedule()
+    switches.off()
-        	}
+}
+//if none is ok turn off frequency check and turn off lights.
+else if(people){
+    //don't turn off lights if anyone is home
+		if(someoneIsHome()){
+		log.debug("Stopping Check for Light")
     	}
-        else if (!modeOk) {
+        else{
-        	unschedule()
+    log.debug("Stopping Check for Light and turning off all lights")
-        }
+	switches.off()
     }
+}
 }      
 
 
@@ -316,6 +286,26 @@ private getDaysOk() {
 	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
+	}
+    
+    else if (starting){
+    	result = currTime >= start
+    }
+    else if (ending){
+    	result = currTime <= stop
+    }
+    
+	log.trace "timeOk = $result"
+	result
+}
+
 private getHomeIsEmpty() {
   def result = true
 
@@ -340,59 +330,25 @@ private getSomeoneIsHome() {
   return result
 }
 
-private getTimeOk() {
+
-	def result = true
+//gets the label for time restriction. Label phrasing changes depending on if there is both start and stop times or just one start/stop time.
-	def start = timeWindowStart()
+def getTimeLabel(starting, ending){
-	def stop = timeWindowStop()
+
-	if (start && stop && location.timeZone) {
+	def timeLabel = "Tap to set"
-		result = timeOfDayIsBetween(start, stop, new Date(), location.timeZone)
+	
-	}
+    if(starting && ending){
-	log.trace "timeOk = $result"
+    	timeLabel = "Between" + " " + hhmm(starting) + " "  + "and" + " " +  hhmm(ending)
-	result
+    }
-}
+    else if (starting) {
-
+		timeLabel = "Start at" + " " + hhmm(starting)
-private timeWindowStart() {
+    }
-	def result = null
+    else if(ending){
-	if (startTimeType == "sunrise") {
+    timeLabel = "End at" + hhmm(ending)
-		result = location.currentState("sunriseTime")?.dateValue
+    }
-		if (result && startTimeOffset) {
+	timeLabel
-			result = new Date(result.time + Math.round(startTimeOffset * 60000))
-		}
-	}
-	else if (startTimeType == "sunset") {
-		result = location.currentState("sunsetTime")?.dateValue
-		if (result && startTimeOffset) {
-			result = new Date(result.time + Math.round(startTimeOffset * 60000))
-		}
-	}
-	else if (starting && location.timeZone) {
-		result = timeToday(starting, location.timeZone)
-	}
-	log.trace "timeWindowStart = ${result}"
-	result
-}
-
-private timeWindowStop() {
-	def result = null
-	if (endTimeType == "sunrise") {
-		result = location.currentState("sunriseTime")?.dateValue
-		if (result && endTimeOffset) {
-			result = new Date(result.time + Math.round(endTimeOffset * 60000))
-		}
-	}
-	else if (endTimeType == "sunset") {
-		result = location.currentState("sunsetTime")?.dateValue
-		if (result && endTimeOffset) {
-			result = new Date(result.time + Math.round(endTimeOffset * 60000))
-		}
-	}
-	else if (ending && location.timeZone) {
-		result = timeToday(ending, location.timeZone)
-	}
-	log.trace "timeWindowStop = ${result}"
-	result
 }
 
+//fomrats time to readable format for time label
 private hhmm(time, fmt = "h:mm a")
 {
 	def t = timeToday(time, location.timeZone)
@@ -401,41 +357,6 @@ private hhmm(time, fmt = "h:mm a")
 	f.format(t)
 }
 
-private timeIntervalLabel() {
-	def start = ""
-	switch (startTimeType) {
-		case "time":
-			if (ending) {
-            	start += hhmm(starting)
-            }
-			break
-		case "sunrise":
-		case "sunset":
-        	start += startTimeType[0].toUpperCase() + startTimeType[1..-1]
-			if (startTimeOffset) {
-				start += startTimeOffset > 0 ? "+${startTimeOffset} min" : "${startTimeOffset} min"
-			}
-			break
-	}
-
-    def finish = ""
-	switch (endTimeType) {
-		case "time":
-			if (ending) {
-            	finish += hhmm(ending)
-            }
-			break
-		case "sunrise":
-		case "sunset":
-        	finish += endTimeType[0].toUpperCase() + endTimeType[1..-1]
-			if (endTimeOffset) {
-				finish += endTimeOffset > 0 ? "+${endTimeOffset} min" : "${endTimeOffset} min"
-			}
-			break
-	}
-	start && finish ? "${start} to ${finish}" : ""
-}
-
 //sets complete/not complete for the setup section on the main dynamic page
 def greyedOut(){
 	def result = ""
@@ -448,7 +369,16 @@ def greyedOut(){
 //sets complete/not complete for the settings section on the main dynamic page
 def greyedOutSettings(){
 	def result = ""
-    if (people || days || falseAlarmThreshold ) {
+    if (starting || ending || days || falseAlarmThreshold) {
+    	result = "complete"	
+    }
+    result
+}
+
+//sets complete/not complete for time restriction section in settings
+def greyedOutTime(starting, ending){
+	def result = ""
+    if (starting || ending) {
     	result = "complete"	
     }
     result