MSA-1506: ZRC-90

CHF-273

devicetypes/erocm123/remotec-zrc-90-scene-master.src/remotec-zrc-90-scene-master.groovy

@@ -0,0 +1,174 @@
+/**
+ *  Remotec ZRC-90 Scene Master
+ *  Copyright 2015 Eric Maycock
+ *
+ *  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: "Remotec ZRC-90 Scene Master", namespace: "erocm123", author: "Eric Maycock") {
+		capability "Actuator"
+		capability "Button"
+		capability "Configuration"
+		capability "Sensor"
+        capability "Battery"
+        
+        attribute "sequenceNumber", "number"
+        attribute "numberOfButtons", "number"
+
+		fingerprint deviceId: "0x0106", inClusters: "0x5E,0x85,0x72,0x21,0x84,0x86,0x80,0x73,0x59,0x5A,0x5B,0xEF,0x5B,0x84"
+	}
+
+	simulator {
+		status "button 1 pushed":  "command: 5B03, payload: 23 00 01"
+		status "button 1 held":  "command: 5B03, payload: 2B 02 01"
+        status "button 1 released":  "command: 5B03, payload: 2C 01 01"
+        status "button 1 double":  "command: 5B03, payload: 2F 03 01"
+		status "button 2 pushed":  "command: 5B03, payload: 23 00 02"
+		status "button 2 held":  "command: 5B03, payload: 2B 02 02"
+        status "button 2 released":  "command: 5B03, payload: 2C 01 02"
+        status "button 2 double":  "command: 5B03, payload: 2F 03 02"
+		status "button 3 pushed":  "command: 5B03, payload: 23 00 03"
+		status "button 3 held":  "command: 5B03, payload: 2B 02 03"
+        status "button 3 released":  "command: 5B03, payload: 2C 01 03"
+        status "button 3 double":  "command: 5B03, payload: 2F 03 03"
+		status "button 4 pushed":  "command: 5B03, payload: 23 00 04"
+		status "button 4 held":  "command: 5B03, payload: 2B 02 04"
+        status "button 4 released":  "command: 5B03, payload: 2C 01 04"
+        status "button 4 double":  "command: 5B03, payload: 2F 03 04"
+        status "button 5 pushed":  "command: 5B03, payload: 23 00 05"
+		status "button 5 held":  "command: 5B03, payload: 2B 02 05"
+        status "button 5 released":  "command: 5B03, payload: 2C 01 05"
+        status "button 5 double":  "command: 5B03, payload: 2F 03 05"
+		status "button 6 pushed":  "command: 5B03, payload: 23 00 06"
+		status "button 6 held":  "command: 5B03, payload: 2B 02 06"
+        status "button 6 released":  "command: 5B03, payload: 2C 01 06"
+        status "button 6 double":  "command: 5B03, payload: 2F 03 06"
+		status "button 7 pushed":  "command: 5B03, payload: 23 00 07"
+		status "button 7 held":  "command: 5B03, payload: 2B 02 07"
+        status "button 7 released":  "command: 5B03, payload: 2C 01 07"
+        status "button 7 double":  "command: 5B03, payload: 2F 03 07"
+		status "button 8 pushed":  "command: 5B03, payload: 23 00 08"
+		status "button 8 held":  "command: 5B03, payload: 2B 02 08"
+        status "button 8 released":  "command: 5B03, payload: 2C 01 08"
+        status "button 8 double":  "command: 5B03, payload: 2F 03 08"
+        status "battery 100%": "command: 8003, payload: 64"
+		status "wakeup":  "command: 8407, payload:"
+        
+	}
+	tiles (scale: 2) {
+		standardTile("button", "device.button", width: 2, height: 2) {
+			state "default", label: "", icon: "st.unknown.zwave.remote-controller", backgroundColor: "#ffffff"
+		}
+        valueTile(
+			"battery", "device.battery", decoration: "flat", width: 2, height: 2) {
+			state "battery", label:'${currentValue}% battery', unit:""
+		}
+        valueTile(
+			"sequenceNumber", "device.sequenceNumber", decoration: "flat", width: 2, height: 2) {
+			state "battery", label:'${currentValue}', unit:""
+		}
+        standardTile("configure", "device.configure", inactiveLabel: false, width: 2, height: 2, decoration: "flat") {
+			state "configure", label:'', action:"configuration.configure", icon:"st.secondary.configure"
+		}
+		main "button"
+		details(["button", "battery", "sequenceNumber", "configure"])
+	}
+    
+    preferences {
+       input name: "holdMode", type: "enum", title: "Multiple \"held\" events on botton hold? With this option, the controller will send a \"held\" event about every second while holding down a button. This allows you to set things up such as \"dimming\" in apps like Rule Machine.", defaultValue: "2", displayDuringSetup: true, required: false, options: [
+                   "1":"Yes",
+                   "2":"No"]
+       input name: "debug", type: "boolean", title: "Enable Debug?", defaultValue: false, displayDuringSetup: false, required: false
+    }
+}
+
+def parse(String description) {
+	def results = []
+    if (settings.debug == true) log.debug "${description}"
+	if (description.startsWith("Err")) {
+	    results = createEvent(descriptionText:description, displayed:true)
+	} else {
+		def cmd = zwave.parse(description, [0x2B: 1, 0x80: 1, 0x84: 1])
+		if(cmd) results += zwaveEvent(cmd)
+		if(!results) results = [ descriptionText: cmd, displayed: false ]
+	}
+    
+    if(state.isConfigured != "true") configure()
+    
+	return results
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.centralscenev1.CentralSceneNotification cmd) {
+        if (settings.debug == true) log.debug "keyAttributes: $cmd.keyAttributes"
+        if (settings.debug == true) log.debug "sceneNumber: $cmd.sceneNumber"
+        if (settings.debug == true) log.debug "sequenceNumber: $cmd.sequenceNumber"
+
+        sendEvent(name: "sequenceNumber", value: cmd.sequenceNumber, displayed:false)
+        switch (cmd.keyAttributes) {
+           case 0:
+              buttonEvent(cmd.sceneNumber, "pushed")
+           break
+           case 1:
+              if (settings.holdMode == "2") buttonEvent(cmd.sceneNumber, "held")
+           break
+           case 2:
+              if (settings.holdMode == "1") buttonEvent(cmd.sceneNumber, "held")
+           break
+           case 3:
+              buttonEvent(cmd.sceneNumber + 8, "pushed")
+           break
+           default:
+              if (settings.debug == true) log.debug "Unhandled CentralSceneNotification: ${cmd}"
+           break
+        }
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.wakeupv1.WakeUpNotification cmd) {
+	def results = [createEvent(descriptionText: "$device.displayName woke up", isStateChange: false)]
+	results << response(zwave.wakeUpV1.wakeUpNoMoreInformation().format())
+	return results
+}
+
+def buttonEvent(button, value) {
+	createEvent(name: "button", value: value, data: [buttonNumber: button], descriptionText: "$device.displayName button $button was $value", isStateChange: true)
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {
+	def map = [ name: "battery", unit: "%" ]
+	if (cmd.batteryLevel == 0xFF) {
+		map.value = 1
+		map.descriptionText = "${device.displayName} battery is low"
+		map.isStateChange = true
+	} else {
+		map.value = cmd.batteryLevel
+	}
+	createEvent(map)
+}
+
+def zwaveEvent(physicalgraph.zwave.Command cmd) {
+	log.debug "Unhandled zwaveEvent: ${cmd}"
+}
+
+def installed() {
+    log.debug "installed()"
+    configure()
+}
+
+def updated() {
+    log.debug "updated()"
+    configure()
+}
+
+def configure() {
+	log.debug "configure()"
+    sendEvent(name: "numberOfButtons", value: 16, displayed: true)
+    state.isConfigured = "true"
+}

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

@@ -106,7 +106,7 @@ def configure() {
     schedule("0 0/5 * * * ? *", "healthPoll")
     log.debug "Configuring Reporting and Bindings."
     // Device-Watch allows 2 check-in misses from device
-    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
     // minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
     zigbee.onOffConfig(0, 300) + zigbee.levelConfig() + zigbee.onOffRefresh() + zigbee.levelRefresh()
 }

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

@@ -57,7 +57,7 @@ metadata {
 }
 
 void installed() {
-	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan"], displayed: false)
+	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan", hubHardwareId: device.hub.hardwareID], displayed: false)
 }
 
 // parse events into attributes

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

@@ -66,7 +66,7 @@ metadata {
 }
 
 void installed() {
-	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan"], displayed: false)
+	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan", hubHardwareId: device.hub.hardwareID], displayed: false)
 }
 
 // parse events into attributes

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

@@ -50,7 +50,7 @@ metadata {
 }
 
 void installed() {
-	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan"], displayed: false)
+	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan", hubHardwareId: device.hub.hardwareID], displayed: false)
 }
 
 // parse events into attributes

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

@@ -55,7 +55,7 @@ metadata {
 }
 
 void installed() {
-	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan"], displayed: false)
+	sendEvent(name: "checkInterval", value: 60 * 12, data: [protocol: "lan", hubHardwareId: device.hub.hardwareID], displayed: false)
 }
 
 // parse events into attributes

devicetypes/smartthings/smartpower-outlet.src/smartpower-outlet.groovy

@@ -129,7 +129,7 @@ def refresh() {
 
 def configure() {
 	// Device-Watch allows 2 check-in misses from device
-	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
 	// OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
 	zigbee.onOffConfig(0, 300) + powerConfig() + refresh()
 }

devicetypes/smartthings/smartsense-moisture-sensor.src/smartsense-moisture-sensor.groovy

@@ -293,7 +293,7 @@ def refresh() {
 
 def configure() {
 	// Device-Watch allows 2 check-in misses from device
-	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
 
 	String zigbeeEui = swapEndianHex(device.hub.zigbeeEui)
 	log.debug "Configuring Reporting, IAS CIE, and Bindings."

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

@@ -304,7 +304,7 @@ def refresh() {
 
 def configure() {
 	// Device-Watch allows 2 check-in misses from device
-	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
 
 	String zigbeeEui = swapEndianHex(device.hub.zigbeeEui)
 	log.debug "Configuring Reporting, IAS CIE, and Bindings."

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

@@ -402,7 +402,7 @@ def refresh() {
 
 def configure() {
 	// Device-Watch allows 2 check-in misses from device
-	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
 
 	log.debug "Configuring Reporting"
 

devicetypes/smartthings/smartsense-open-closed-sensor.src/smartsense-open-closed-sensor.groovy

@@ -256,7 +256,7 @@ def refresh() {
 
 def configure() {
 	// Device-Watch allows 2 check-in misses from device
-	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
 
 	String zigbeeEui = swapEndianHex(device.hub.zigbeeEui)
 	log.debug "Configuring Reporting, IAS CIE, and Bindings."

devicetypes/smartthings/smartsense-temp-humidity-sensor.src/smartsense-temp-humidity-sensor.groovy

@@ -265,7 +265,7 @@ def refresh()
 
 def configure() {
 	// Device-Watch allows 2 check-in misses from device
-	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
 
 	log.debug "Configuring Reporting and Bindings."
 	def humidityConfigCmds = [

devicetypes/smartthings/tyco-door-window-sensor.src/.st-ignore

@@ -0,0 +1,2 @@
+.st-ignore
+README.md

devicetypes/smartthings/tyco-door-window-sensor.src/README.md

@@ -0,0 +1,42 @@
+# Tyco Door Window Sensor
+
+
+
+Works with: 
+
+* [Tyco Door Window Sensor](https://support.smartthings.com/hc/en-us/articles/204834100-Tyco-Door-Window-Sensor)
+
+## Table of contents
+
+* [Capabilities](#capabilities)
+* [Health](#device-health)
+* [Battery](#battery-specification)
+
+## Capabilities
+
+* **Battery** - defines device uses a battery
+* **Configuration** - _configure()_ command called when device is installed or device preferences updated
+* **Contact Sensor** - can detect contact (open/close)
+* **Refresh** - _refresh()_ command for status updates
+* **Temperature Measurement** - can measure the device temperature
+* **Health Check** - indicates ability to get device health notifications
+
+## Device Health
+
+Contact sensor with maxReportTime of 5 mins.
+Check-in interval is double the value of maxReportTime for Zigbee device. 
+This gives the device twice the amount of time to respond before it is marked as offline.
+Check-in interval = 12 min
+
+## Battery Specification
+
+3V CR2032 battery is required.
+
+## Troubleshooting
+
+If the device doesn't pair when trying from the SmartThings mobile app, it is possible that either the sensor needs to be reseted or the sensor is out of range.
+Reset needs to be done by inserting the battery in the sensor and then quickly pressing the adjacent black button 10 times. Pairing should be tried again now.
+It may happen that sensor is out of range, then pairing needs to be tried again by placing the sensor closer to the hub.
+Instructions related to pairing, resetting and removing the different motion sensors from SmartThings can be found in the following links
+for the different models:
+* [Tyco Door Window Sensor (MCT-340)](https://support.smartthings.com/hc/en-us/articles/204834100-Tyco-Door-Window-Sensor)

devicetypes/smartthings/tyco-door-window-sensor.src/tyco-door-window-sensor.groovy

@@ -16,12 +16,13 @@
 import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
 
 metadata {
-	definition (name: "Tyco Door/Window Sensor", namespace: "smartthings", author: "SmartThings") {
+	definition (name: "Tyco Door/Window Sensor", namespace: "smartthings", author: "SmartThings", category: "C2") {
 		capability "Battery"
 		capability "Configuration"
 		capability "Contact Sensor"
 		capability "Refresh"
 		capability "Temperature Measurement"
+		capability "Health Check"
 
 		command "enrollResponse"
 
@@ -229,44 +230,42 @@ private Map getContactResult(value) {
 	]
 }
 
+/**
+ * PING is used by Device-Watch in attempt to reach the Device
+ * */
+def ping() {
+	return zigbee.readAttribute(0x0402, 0x0000) // Read the Temperature Cluster
+}
+
 def refresh()
 {
 	log.debug "Refreshing Temperature and Battery"
-	[
+	def refreshCmds = [
 
         "st rattr 0x${device.deviceNetworkId} 1 0x402 0", "delay 200",
 		"st rattr 0x${device.deviceNetworkId} 1 1 0x20"
 
 	]
+
+	return refreshCmds + enrollResponse()
 }
 
 def configure() {
+	// Device-Watch allows 2 check-in misses from device
+	sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
 
 	String zigbeeEui = swapEndianHex(device.hub.zigbeeEui)
 		log.debug "Configuring Reporting, IAS CIE, and Bindings."
-	def configCmds = [
+	def enrollCmds = [
     	"delay 1000",
 
 		"zcl global write 0x500 0x10 0xf0 {${zigbeeEui}}", "delay 200",
 		"send 0x${device.deviceNetworkId} 1 1", "delay 1500",
 
-        "zcl global send-me-a-report 1 0x20 0x20 600 3600 {01}", "delay 200",
-        "send 0x${device.deviceNetworkId} 1 1", "delay 1500",
-
-        "zcl global send-me-a-report 0x402 0 0x29 300 3600 {6400}", "delay 200",
-        "send 0x${device.deviceNetworkId} 1 1", "delay 1500",
-
-
         //"raw 0x500 {01 23 00 00 00}", "delay 200",
         //"send 0x${device.deviceNetworkId} 1 1", "delay 1500",
-
-
-		"zdo bind 0x${device.deviceNetworkId} 1 1 0x402 {${device.zigbeeId}} {}", "delay 500",
-		"zdo bind 0x${device.deviceNetworkId} 1 1 1 {${device.zigbeeId}} {}",
-
-        "delay 500"
 	]
-    return configCmds + enrollResponse() + refresh() // send refresh cmds as part of config
+    return enrollCmds + zigbee.batteryConfig() + zigbee.temperatureConfig(30, 300) + refresh() // send refresh cmds as part of config
 }
 
 def enrollResponse() {

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

@@ -90,7 +90,7 @@ def refresh() {
 def configure() {
     log.debug "Configuring Reporting and Bindings."
     // Device-Watch allows 2 check-in misses from device
-    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
     // OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
     zigbee.onOffConfig(0, 300) + zigbee.levelConfig() + zigbee.onOffRefresh() + zigbee.levelRefresh()
 }

devicetypes/smartthings/zigbee-rgbw-bulb.src/zigbee-rgbw-bulb.groovy

@@ -134,7 +134,7 @@ def refresh() {
 def configure() {
     log.debug "Configuring Reporting and Bindings."
     // Device-Watch allows 2 check-in misses from device
-    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
     // OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
     zigbee.onOffConfig(0, 300) + zigbee.levelConfig() + zigbee.colorTemperatureConfig() + zigbee.configureReporting(COLOR_CONTROL_CLUSTER, ATTRIBUTE_HUE, 0x20, 1, 3600, 0x01) + zigbee.configureReporting(COLOR_CONTROL_CLUSTER, ATTRIBUTE_SATURATION, 0x20, 1, 3600, 0x01) + zigbee.readAttribute(0x0006, 0x00) + zigbee.readAttribute(0x0008, 0x00) + zigbee.readAttribute(COLOR_CONTROL_CLUSTER, 0x00) + zigbee.readAttribute(COLOR_CONTROL_CLUSTER, ATTRIBUTE_COLOR_TEMPERATURE) + zigbee.readAttribute(COLOR_CONTROL_CLUSTER, ATTRIBUTE_HUE) + zigbee.readAttribute(COLOR_CONTROL_CLUSTER, ATTRIBUTE_SATURATION)
 }

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

@@ -114,7 +114,7 @@ def refresh() {
 def configure() {
     log.debug "Configuring Reporting and Bindings."
     // Device-Watch allows 2 check-in misses from device
-    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee"])
+    sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
     // OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
     zigbee.onOffConfig(0, 300) + zigbee.levelConfig() + zigbee.colorTemperatureConfig() + zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.colorTemperatureRefresh()
 }