MSA-1280: Door window contact sensor with proper fingerprinting and battery level reporting.

devicetypes/a4refillpad/orvibo-contact-sensor.src/orvibo-contact-sensor.groovy

@@ -0,0 +1,126 @@
+/**
+ *  Orvibo Contact Sensor
+ * 
+ *  Copyright Wayne Man 2016
+ * 
+ *  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.
+ *
+ *  Orvibo Contact Sensor Device Type
+ *  Battery levels updates periodically, for an instant update press physical button on sensor once
+ *  30/04/2016 fixed fingerprint
+ *  09/05/2016 added heartbeat to help track if sensor is alive (recommend using a devicecheck smartapp)
+ */
+metadata {
+	definition (name: "Orvibo Contact Sensor", namespace: "a4refillpad", author: "Wayne Man") {
+		capability "Contact Sensor"
+		capability "Sensor"
+        	capability "Battery"
+
+		fingerprint inClusters: "0000,0001,0003,0500", manufacturer: "\u6B27\u745E", model: "75a4bfe8ef9c4350830a25d13e3ab068"
+
+	}
+
+	// simulator metadata
+	simulator {
+		// status messages
+		status "open":   "zone report :: type: 19 value: 0031"
+		status "closed": "zone report :: type: 19 value: 0030"
+	}
+
+    	tiles(scale: 2) {
+		multiAttributeTile(name:"contact", type: "lighting", width: 6, height: 4) {
+			tileAttribute ("device.contact", key: "PRIMARY_CONTROL") {
+           		attributeState("open", label:'open', icon:"st.contact.contact.open", backgroundColor:"#ffa81e")
+            	attributeState("closed", label:'closed', icon:"st.contact.contact.closed", backgroundColor:"#79b821")   
+ 			}
+		}
+        
+        valueTile("battery", "device.battery", inactiveLabel: false, width: 2, height: 2, decoration: "flat") {
+            state "battery", label:'${currentValue}% battery', unit:""
+        }    
+        
+		main "contact"
+		details(["contact", "battery"])
+	}
+ 
+}
+
+// Parse incoming device messages to generate events
+def parse(String description) {
+	def name = null
+	def value = description
+   	def descriptionText = null
+   	def now = new Date()
+    log.debug "Parsing: ${description}"
+    Map map = [:]
+
+	List listMap = []
+	List listResult = []
+  
+    
+	if (zigbee.isZoneType19(description)) {
+		name = "contact"
+		value = zigbee.translateStatusZoneType19(description) ? "open" : "closed"
+	} else if(description?.startsWith("read attr -")) {
+    	map = parseReportAttributeMessage(description)
+    }
+	
+	def result = createEvent(name: name, value: value)
+	log.debug "Parse returned ${result?.descriptionText}"
+//  send event for heartbeat    
+    	sendEvent(name: "heartbeat", value: now)
+	listResult << result
+    
+   	if (listMap) {
+        for (msg in listMap) {
+            listResult << createEvent(msg)
+        }
+    }
+    else if (map) {
+        listResult << createEvent(map)
+    }
+
+	log.debug "Parse returned ${result?.descriptionText}"
+	return listResult
+} 
+
+private Map parseReportAttributeMessage(String description) {
+	Map descMap = (description - "read attr - ").split(",").inject([:]) {
+		map, param -> def nameAndValue = param.split(":")
+		map += [(nameAndValue[0].trim()):nameAndValue[1].trim()]
+	}
+	Map resultMap = [:]
+
+	log.info "IN parseReportAttributeMessage()"
+	log.debug "descMap ${descMap}"
+
+	switch(descMap.cluster) {
+		case "0001":
+			log.debug "Battery status reported"
+
+			if(descMap.attrId == "0021") {
+				resultMap.name = 'battery'
+                resultMap.value = (convertHexToInt(descMap.value) / 2)
+                log.debug "Battery Percentage convert to ${resultMap.value}%"
+			}
+			break
+		default:
+			log.info descMap.cluster
+			log.info "cluster1"
+			break
+	}
+
+	log.info "OUT parseReportAttributeMessage()"
+	return resultMap
+}
+
+private Integer convertHexToInt(hex) {
+	Integer.parseInt(hex,16)
+}

smartapps/smartthings/-.src/-.groovy

@@ -1,198 +0,0 @@
-/**
- *  Copyright 2015 SmartThings
- *
- *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- *  in compliance with the License. You may obtain a copy of the License at:
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
- *  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
- *  for the specific language governing permissions and limitations under the License.
- *
- *  Good Night
- *
- *  Author: SmartThings
- *  Date: 2013-03-07
- */
-definition(
-    name: "이현주",
-    namespace: "smartthings",
-    author: "SmartThings",
-    description: "Changes mode when motion ceases after a specific time of night.",
-    category: "Mode Magic",
-    iconUrl: "https://s3.amazonaws.com/smartapp-icons/ModeMagic/good-night.png",
-    iconX2Url: "https://s3.amazonaws.com/smartapp-icons/ModeMagic/good-night@2x.png"
-)
-
-preferences {
-	section("When there is no motion on any of these sensors") {
-		input "motionSensors", "capability.motionSensor", title: "Where?", multiple: true
-	}
-	section("For this amount of time") {
-		input "minutes", "number", title: "Minutes?"
-	}
-	section("After this time of day") {
-		input "timeOfDay", "time", title: "Time?"
-	}
-	section("And (optionally) these switches are all off") {
-		input "switches", "capability.switch", multiple: true, required: false
-	}
-	section("Change to this mode") {
-		input "newMode", "mode", title: "Mode?"
-	}
-	section( "Notifications" ) {
-        input("recipients", "contact", title: "Send notifications to") {
-            input "sendPushMessage", "enum", title: "Send a push notification?", options: ["Yes", "No"], required: false
-            input "phoneNumber", "phone", title: "Send a Text Message?", required: false
-        }
-	}
-
-}
-
-def installed() {
-	log.debug "Current mode = ${location.mode}"
-	createSubscriptions()
-}
-
-def updated() {
-	log.debug "Current mode = ${location.mode}"
-	unsubscribe()
-	createSubscriptions()
-}
-
-def createSubscriptions()
-{
-	subscribe(motionSensors, "motion.active", motionActiveHandler)
-	subscribe(motionSensors, "motion.inactive", motionInactiveHandler)
-	subscribe(switches, "switch.off", switchOffHandler)
-	subscribe(location, modeChangeHandler)
-
-	if (state.modeStartTime == null) {
-		state.modeStartTime = 0
-	}
-}
-
-def modeChangeHandler(evt) {
-	state.modeStartTime = now()
-}
-
-def switchOffHandler(evt) {
-	if (correctMode() && correctTime()) {
-		if (allQuiet() && switchesOk()) {
-			takeActions()
-		}
-	}
-}
-
-def motionActiveHandler(evt)
-{
-	log.debug "Motion active"
-}
-
-def motionInactiveHandler(evt)
-{
-	// for backward compatibility
-	if (state.modeStartTime == null) {
-		subscribe(location, modeChangeHandler)
-		state.modeStartTime = 0
-	}
-
-	if (correctMode() && correctTime()) {
-		runIn(minutes * 60, scheduleCheck, [overwrite: false])
-	}
-}
-
-def scheduleCheck()
-{
-	log.debug "scheduleCheck, currentMode = ${location.mode}, newMode = $newMode"
-	
-	if (correctMode() && correctTime()) {
-		if (allQuiet() && switchesOk()) {
-			takeActions()
-		}
-	}
-}
-
-private takeActions() {
-	def message = "Goodnight! SmartThings changed the mode to '$newMode'"
-	send(message)
-	setLocationMode(newMode)
-	log.debug message
-}
-
-private correctMode() {
-	if (location.mode != newMode) {
-		true
-	} else {
-		log.debug "Location is already in the desired mode:  doing nothing"
-		false
-	}
-}
-
-private correctTime() {
-	def t0 = now()
-	def modeStartTime = new Date(state.modeStartTime)
-	def startTime = timeTodayAfter(modeStartTime, timeOfDay, location.timeZone)
-	if (t0 >= startTime.time) {
-		true
-	} else {
-		log.debug "The current time of day (${new Date(t0)}), is not in the correct time window ($startTime):  doing nothing"
-		false
-	}
-}
-
-private switchesOk() {
-	def result = true
-	for (it in (switches ?: [])) {
-		if (it.currentSwitch == "on") {
-			result = false
-			break
-		}
-	}
-	log.debug "Switches are all off: $result"
-	result
-}
-
-private allQuiet() {
-	def threshold = 1000 * 60 * minutes - 1000
-	def states = motionSensors.collect { it.currentState("motion") ?: [:] }.sort { a, b -> b.dateCreated <=> a.dateCreated }
-	if (states) {
-		if (states.find { it.value == "active" }) {
-			log.debug "Found active state"
-			false
-		} else {
-			def sensor = states.first()
-		    def elapsed = now() - sensor.rawDateCreated.time
-			if (elapsed >= threshold) {
-				log.debug "No active states, and enough time has passed"
-				true
-			} else {
-				log.debug "No active states, but not enough time has passed"
-				false
-			}
-		}
-	} else {
-		log.debug "No states to check for activity"
-		true
-	}
-}
-
-private send(msg) {
-    if (location.contactBookEnabled) {
-        sendNotificationToContacts(msg, recipients)
-    }
-    else {
-        if (sendPushMessage != "No") {
-            log.debug("sending push message")
-            sendPush(msg)
-        }
-
-        if (phoneNumber) {
-            log.debug("sending text message")
-            sendSms(phoneNumber, msg)
-        }
-    }
-
-	log.debug msg
-}