Z-Wave Water Valve: initial device type

devicetypes/smartthings/zwave-water-valve.src/zwave-water-valve.groovy

@@ -0,0 +1,127 @@
+/**
+ *  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.
+ *
+ */
+metadata {
+	definition (name: "Z-Wave Water Valve", namespace: "smartthings", author: "SmartThings") {
+		capability "Actuator"
+		capability "Valve"
+		capability "Polling"
+		capability "Refresh"
+		capability "Sensor"
+
+		fingerprint deviceId: "0x1006", inClusters: "0x25"
+	}
+
+    preferences {
+        input description: "After successful installation, please click the refresh tile to update device status",
+                title: "Instructions", displayDuringSetup: true, type: "paragraph", element: "paragraph"
+    }
+
+	// simulator metadata
+	simulator {
+		status "open": "command: 2503, payload: FF"
+		status "close":  "command: 2503, payload: 00"
+
+		// reply messages
+		reply "2001FF,delay 100,2502": "command: 2503, payload: FF"
+		reply "200100,delay 100,2502": "command: 2503, payload: 00"
+	}
+
+	// tile definitions
+	tiles(scale: 2) {
+		multiAttributeTile(name:"valve", type: "generic", width: 6, height: 4, canChangeIcon: true){
+			tileAttribute ("device.contact", key: "PRIMARY_CONTROL") {
+				attributeState "open", label: '${name}', action: "valve.close", icon: "st.valves.water.open", backgroundColor: "#53a7c0", nextState:"closing"
+				attributeState "closed", label: '${name}', action: "valve.open", icon: "st.valves.water.closed", backgroundColor: "#e86d13", nextState:"opening"
+				attributeState "opening", label: '${name}', action: "valve.close", icon: "st.valves.water.open", backgroundColor: "#ffe71e"
+				attributeState "closing", label: '${name}', action: "valve.open", icon: "st.valves.water.closed", backgroundColor: "#ffe71e"
+			}
+		}
+
+		standardTile("refresh", "device.contact", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
+			state "default", label:'', action:"refresh.refresh", icon:"st.secondary.refresh"
+		}
+
+		main "valve"
+		details(["valve","refresh"])
+	}
+
+}
+
+def parse(String description) {
+	log.trace "parse description : $description"
+	def result = null
+	def cmd = zwave.parse(description, [0x20: 1])
+	if (cmd) {
+		result = createEvent(zwaveEvent(cmd))
+	}
+	log.debug "Parse returned ${result?.descriptionText}"
+	return result
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicReport cmd) {
+    def value = cmd.value == "on" || cmd.value == 0xFF ?  "open" : cmd.value == "off" || cmd.value == 0x00 ? "closed" : "unknown"
+    [name: "contact", value: value, descriptionText: "$device.displayName valve is $value"]
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.manufacturerspecificv2.ManufacturerSpecificReport cmd) {   //TODO should show MSR when device is discovered
+    log.debug "manufacturerId:   ${cmd.manufacturerId}"
+    log.debug "manufacturerName: ${cmd.manufacturerName}"
+    log.debug "productId:        ${cmd.productId}"
+    log.debug "productTypeId:    ${cmd.productTypeId}"
+    def msr = String.format("%04X-%04X-%04X", cmd.manufacturerId, cmd.productTypeId, cmd.productId)
+    updateDataValue("MSR", msr)
+    [descriptionText: "$device.displayName MSR: $msr", isStateChange: false]
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.deviceresetlocallyv1.DeviceResetLocallyNotification cmd) {
+    [descriptionText: cmd.toString(), isStateChange: true, displayed: true]
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.switchbinaryv1.SwitchBinaryReport cmd) {
+	def value = cmd.value == "on" || cmd.value == 0xFF ?  "open" : cmd.value == "off" || cmd.value == 0x00 ? "closed" : "unknown"
+	[name: "contact", value: value, descriptionText: "$device.displayName valve is $value"]
+}
+
+def zwaveEvent(physicalgraph.zwave.Command cmd) {
+	[:] // Handles all Z-Wave commands we aren't interested in
+}
+
+def open() {
+    delayBetween([
+            zwave.basicV1.basicSet(value: 0xFF).format(),
+            zwave.switchBinaryV1.switchBinaryGet().format()
+    ],10000) //wait for a water valve to be completely opened
+}
+
+def close() {
+    delayBetween([
+            zwave.basicV1.basicSet(value: 0x00).format(),
+            zwave.switchBinaryV1.switchBinaryGet().format()
+    ],10000) //wait for a water valve to be completely closed
+}
+
+def poll() {
+    delayBetween([
+            zwave.switchBinaryV1.switchBinaryGet().format(),
+            zwave.manufacturerSpecificV1.manufacturerSpecificGet().format()
+    ],100)
+}
+
+def refresh() {
+    log.debug "refresh() is called"
+    delayBetween([
+            zwave.switchBinaryV1.switchBinaryGet().format(),
+            zwave.manufacturerSpecificV1.manufacturerSpecificGet().format()
+    ],100)
+}