Merge pull request #1087 from varzac/update-zonestatus

Update DTHs to use ZigBee library ZoneStatus

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

@@ -13,6 +13,7 @@
  *  for the specific language governing permissions and limitations under the License.
  *
  */
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
 
 metadata {
 	definition (name: "NYCE Motion Sensor", namespace: "smartthings", author: "SmartThings") {
@@ -143,51 +144,14 @@ private Map parseReportAttributeMessage(String description) {
  
 
 private Map parseIasMessage(String description) {
-    List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-    String msgCode = parsedMsg[2]
+	Map resultMap = [:]
-    
-    Map resultMap = [:]
-    switch(msgCode) {
-        case '0x0030': // Closed/No Motion/Dry
-            log.debug 'no motion'
-            resultMap.name = 'motion'
-            resultMap.value = 'inactive'
-            break
 
-        case '0x0032': // Open/Motion/Wet
+	result.name = 'motion'
-            log.debug 'motion'
+	result.value = zs.isAlarm2Set() ? 'active' : 'inactive'
-            resultMap.name = 'motion'
+	log.debug(zs.isAlarm2Set() ? 'motion' : 'no motion')
-            resultMap.value = 'active'
-            break
 
-        case '0x0032': // Tamper Alarm
+	return resultMap
-        	log.debug 'motion with tamper alarm'
-            resultMap.name = 'motion'
-            resultMap.value = 'active'
-            break
-
-        case '0x0033': // Battery Alarm
-            break
-
-        case '0x0034': // Supervision Report
-        	log.debug 'no motion with tamper alarm'
-            resultMap.name = 'motion'
-            resultMap.value = 'inactive'
-            break
-
-        case '0x0035': // Restore Report
-            break
-
-        case '0x0036': // Trouble/Failure
-        	log.debug 'motion with failure alarm'
-            resultMap.name = 'motion'
-            resultMap.value = 'active'
-            break
-
-        case '0x0038': // Test Mode
-            break
-    }
-    return resultMap
 }
 
 def refresh()

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

@@ -13,7 +13,10 @@
  *  for the specific language governing permissions and limitations under the License.
  *
  */
- 
+
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
+
+
 metadata {
 	definition (name: "NYCE Open/Closed Sensor", namespace: "smartthings", author: "NYCE") {
     	capability "Battery"
@@ -219,40 +222,33 @@ private Map parseReportAttributeMessage(String description) {
 }
 
 private List parseIasMessage(String description) {
-	List parsedMsg = description.split(" ")
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-	String msgCode = parsedMsg[2]
+	log.debug "parseIasMessage: $description"
 
 	List resultListMap = []
 	Map resultMap_battery = [:]
 	Map resultMap_battery_state = [:]
 	Map resultMap_sensor = [:]
 
-	// Relevant bit field definitions from ZigBee spec
+	resultMap_sensor.name = "contact"
-	def BATTERY_BIT = ( 1 << 3 )
+	resultMap_sensor.value = zs.isAlarm1Set() ? "open" : "closed"
-	def TROUBLE_BIT = ( 1 << 6 )
-	def SENSOR_BIT = ( 1 << 0 )		// it's ALARM1 bit from the ZCL spec
-
-	// Convert hex string to integer
-	def zoneStatus = Integer.parseInt(msgCode[-4..-1],16)
-
-	log.debug "parseIasMessage: zoneStatus: ${zoneStatus}"
 
 	// Check each relevant bit, create map for it, and add to list
-	log.debug "parseIasMessage: Battery Status ${zoneStatus & BATTERY_BIT}"
+	log.debug "parseIasMessage: Battery Status ${zs.battery}"
-	log.debug "parseIasMessage: Trouble Status ${zoneStatus & TROUBLE_BIT}"
+	log.debug "parseIasMessage: Trouble Status ${zs.trouble}"
-	log.debug "parseIasMessage: Sensor Status ${zoneStatus & SENSOR_BIT}"
+	log.debug "parseIasMessage: Sensor Status ${zs.alarm1}"
 
 	/* 	Comment out this path to check the battery state to avoid overwriting the
 		battery value (Change log #2), but keep these conditions for later use
 	 resultMap_battery_state.name = "battery_state"
-	 if (zoneStatus & TROUBLE_BIT) {
+	 if (zs.isTroubleSet()) {
 		 resultMap_battery_state.value = "failed"
 
 		 resultMap_battery.name = "battery"
 		 resultMap_battery.value = 0
 	 }
 	 else {
-		 if (zoneStatus & BATTERY_BIT) {
+		 if (zs.isBatterySet()) {
 			 resultMap_battery_state.value = "low"
 
 			 // to generate low battery notification by the platform
@@ -270,9 +266,6 @@ private List parseIasMessage(String description) {
 	 }
 	*/
 
-	resultMap_sensor.name = "contact"
-	resultMap_sensor.value = (zoneStatus & SENSOR_BIT) ? "open" : "closed"
-
 	resultListMap << resultMap_battery_state
 	resultListMap << resultMap_battery
 	resultListMap << resultMap_sensor

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

@@ -13,6 +13,8 @@
  *  License for the specific language governing permissions and limitations
  *  under the License.
  */
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
+
 
 metadata {
 	definition (name: "SmartSense Moisture Sensor",namespace: "smartthings", author: "SmartThings", category: "C2") {
@@ -169,42 +171,9 @@ private Map parseCustomMessage(String description) {
 }
 
 private Map parseIasMessage(String description) {
-	List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-	String msgCode = parsedMsg[2]
 
-	Map resultMap = [:]
+	return zs.isAlarm1Set() ? getMoistureResult('wet') : getMoistureResult('dry')
-	switch(msgCode) {
-		case '0x0020': // Closed/No Motion/Dry
-			resultMap = getMoistureResult('dry')
-			break
-
-		case '0x0021': // Open/Motion/Wet
-			resultMap = getMoistureResult('wet')
-			break
-
-		case '0x0022': // Tamper Alarm
-			break
-
-		case '0x0023': // Battery Alarm
-			break
-
-		case '0x0024': // Supervision Report
-			 log.debug 'dry with tamper alarm'
-			resultMap = getMoistureResult('dry')
-			break
-
-		case '0x0025': // Restore Report
-			log.debug 'water with tamper alarm'
-			resultMap = getMoistureResult('wet')
-			break
-
-		case '0x0026': // Trouble/Failure
-			break
-
-		case '0x0028': // Test Mode
-			break
-	}
-	return resultMap
 }
 
 def getTemperature(value) {

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

@@ -13,6 +13,8 @@
  *  License for the specific language governing permissions and limitations
  *  under the License.
  */
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
+
 
 metadata {
 	definition (name: "SmartSense Motion Sensor", namespace: "smartthings", author: "SmartThings", category: "C2") {
@@ -182,44 +184,10 @@ private Map parseCustomMessage(String description) {
 }
 
 private Map parseIasMessage(String description) {
-	List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-	String msgCode = parsedMsg[2]
 
-	Map resultMap = [:]
+	// Some sensor models that use this DTH use alarm1 and some use alarm2 to signify motion
-	switch(msgCode) {
+	return (zs.isAlarm1Set() || zs.isAlarm2Set()) ? getMotionResult('active') : getMotionResult('inactive')
-		case '0x0020': // Closed/No Motion/Dry
-			resultMap = getMotionResult('inactive')
-			break
-
-		case '0x0021': // Open/Motion/Wet
-			resultMap = getMotionResult('active')
-			break
-
-		case '0x0022': // Tamper Alarm
-			log.debug 'motion with tamper alarm'
-			resultMap = getMotionResult('active')
-			break
-
-		case '0x0023': // Battery Alarm
-			break
-
-		case '0x0024': // Supervision Report
-			log.debug 'no motion with tamper alarm'
-			resultMap = getMotionResult('inactive')
-			break
-
-		case '0x0025': // Restore Report
-			break
-
-		case '0x0026': // Trouble/Failure
-			log.debug 'motion with failure alarm'
-			resultMap = getMotionResult('active')
-			break
-
-		case '0x0028': // Test Mode
-			break
-	}
-	return resultMap
 }
 
 def getTemperature(value) {

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

@@ -15,6 +15,7 @@
  */
 
 //DEPRECATED - Using the smartsense-motion-sensor.groovy DTH for this device. Users need to be moved before deleting this DTH
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
 
 metadata {
 	definition (name: "SmartSense Motion/Temp Sensor", namespace: "smartthings", author: "SmartThings") {
@@ -168,44 +169,8 @@ private Map parseCustomMessage(String description) {
 }
 
 private Map parseIasMessage(String description) {
-    List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-    String msgCode = parsedMsg[2]
+	return zs.isAlarm1Set() ? getMotionResult('active') : getMotionResult('inactive')
-
-    Map resultMap = [:]
-    switch(msgCode) {
-        case '0x0020': // Closed/No Motion/Dry
-        	resultMap = getMotionResult('inactive')
-            break
-
-        case '0x0021': // Open/Motion/Wet
-        	resultMap = getMotionResult('active')
-            break
-
-        case '0x0022': // Tamper Alarm
-        	log.debug 'motion with tamper alarm'
-        	resultMap = getMotionResult('active')
-            break
-
-        case '0x0023': // Battery Alarm
-            break
-
-        case '0x0024': // Supervision Report
-        	log.debug 'no motion with tamper alarm'
-        	resultMap = getMotionResult('inactive')
-            break
-
-        case '0x0025': // Restore Report
-            break
-
-        case '0x0026': // Trouble/Failure
-        	log.debug 'motion with failure alarm'
-        	resultMap = getMotionResult('active')
-            break
-
-        case '0x0028': // Test Mode
-            break
-    }
-    return resultMap
 }
 
 def getTemperature(value) {

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

@@ -13,6 +13,7 @@
  *  License for the specific language governing permissions and limitations
  *  under the License.
  */
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
 
 metadata {
 	definition (name: "SmartSense Multi Sensor", namespace: "smartthings", author: "SmartThings", category: "C2") {
@@ -224,47 +225,13 @@ private Map parseCustomMessage(String description) {
 }
 
 private Map parseIasMessage(String description) {
-	List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-	String msgCode = parsedMsg[2]
-
 	Map resultMap = [:]
-	switch(msgCode) {
-		case '0x0020': // Closed/No Motion/Dry
-			if (garageSensor != "Yes"){
-				resultMap = getContactResult('closed')
-			}
-		break
 
-		case '0x0021': // Open/Motion/Wet
+	if(garageSensor !=  "Yes") {
-			if (garageSensor != "Yes"){
+		resultMap = zs.isAlarm1Set() ? getContactResult('open') : getContactResult('closed')
-				resultMap = getContactResult('open')
-			}
-		break
-
-		case '0x0022': // Tamper Alarm
-		break
-
-		case '0x0023': // Battery Alarm
-		break
-
-		case '0x0024': // Supervision Report
-			if (garageSensor != "Yes"){
-				resultMap = getContactResult('closed')
-			}
-		break
-
-		case '0x0025': // Restore Report
-			if (garageSensor != "Yes"){
-				resultMap = getContactResult('open')
-			}
-		break
-
-		case '0x0026': // Trouble/Failure
-		break
-
-		case '0x0028': // Test Mode
-		break
 	}
+
 	return resultMap
 }
 

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

@@ -14,6 +14,7 @@
  *
  */
 //DEPRECATED - Using the smartsense-multi-sensor.groovy DTH for this device. Users need to be moved before deleting this DTH
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
 
  metadata {
  	definition (name: "SmartSense Open/Closed Accelerometer Sensor", namespace: "smartthings", author: "SmartThings", category: "C2") {
@@ -171,40 +172,9 @@ private Map parseCustomMessage(String description) {
 }
 
 private Map parseIasMessage(String description) {
-	List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-	String msgCode = parsedMsg[2]
 
-	Map resultMap = [:]
+	return zs.isAlarm1Set() ? getContactResult('open') : getContactResult('closed')
-	switch(msgCode) {
-        case '0x0020': // Closed/No Motion/Dry
-        resultMap = getContactResult('closed')
-        break
-
-        case '0x0021': // Open/Motion/Wet
-        resultMap = getContactResult('open')
-        break
-
-        case '0x0022': // Tamper Alarm
-        break
-
-        case '0x0023': // Battery Alarm
-        break
-
-        case '0x0024': // Supervision Report
-        resultMap = getContactResult('closed')
-        break
-
-        case '0x0025': // Restore Report
-        resultMap = getContactResult('open')
-        break
-
-        case '0x0026': // Trouble/Failure
-        break
-
-        case '0x0028': // Test Mode
-        break
-    }
-    return resultMap
 }
 
 def getTemperature(value) {

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

@@ -13,6 +13,7 @@
  *  for the specific language governing permissions and limitations under the License.
  *
  */
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
 
 metadata {
 	definition (name: "SmartSense Open/Closed Sensor", namespace: "smartthings", author: "SmartThings", category: "C2") {
@@ -167,40 +168,8 @@ private Map parseCustomMessage(String description) {
 }
 
 private Map parseIasMessage(String description) {
-    List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-    String msgCode = parsedMsg[2]
+	return zs.isAlarm1Set() ? getContactResult('open') : getContactResult('closed')
-
-    Map resultMap = [:]
-    switch(msgCode) {
-        case '0x0020': // Closed/No Motion/Dry
-        	resultMap = getContactResult('closed')
-            break
-
-        case '0x0021': // Open/Motion/Wet
-        	resultMap = getContactResult('open')
-            break
-
-        case '0x0022': // Tamper Alarm
-            break
-
-        case '0x0023': // Battery Alarm
-            break
-
-        case '0x0024': // Supervision Report
-        	resultMap = getContactResult('closed')
-            break
-
-        case '0x0025': // Restore Report
-        	resultMap = getContactResult('open')
-            break
-
-        case '0x0026': // Trouble/Failure
-            break
-
-        case '0x0028': // Test Mode
-            break
-    }
-    return resultMap
 }
 
 def getTemperature(value) {

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

@@ -13,6 +13,7 @@
  *  for the specific language governing permissions and limitations under the License.
  *
  */
+import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
 
 metadata {
 	definition (name: "Tyco Door/Window Sensor", namespace: "smartthings", author: "SmartThings") {
@@ -161,40 +162,9 @@ private Map parseCustomMessage(String description) {
 }
 
 private Map parseIasMessage(String description) {
-    List parsedMsg = description.split(' ')
+	ZoneStatus zs = zigbee.parseZoneStatus(description)
-    String msgCode = parsedMsg[2]
 
-    Map resultMap = [:]
+	return zs.isAlarm1Set() ? getContactResult('open') : getContactResult('closed')
-    switch(msgCode) {
-        case '0x0020': // Closed/No Motion/Dry
-        	resultMap = getContactResult('closed')
-            break
-
-        case '0x0021': // Open/Motion/Wet
-        	resultMap = getContactResult('open')
-            break
-
-        case '0x0022': // Tamper Alarm
-            break
-
-        case '0x0023': // Battery Alarm
-            break
-
-        case '0x0024': // Supervision Report
-        	resultMap = getContactResult('closed')
-            break
-
-        case '0x0025': // Restore Report
-        	resultMap = getContactResult('open')
-            break
-
-        case '0x0026': // Trouble/Failure
-            break
-
-        case '0x0028': // Test Mode
-            break
-    }
-    return resultMap
 }
 
 def getTemperature(value) {