Initial commit

devicetypes/smartthings/zwave-metering-dimmer.src/zwave-metering-dimmer.groovy

@@ -0,0 +1,179 @@
+/**
+ *  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.
+ *
+ *  Z-Wave Metering Dimmer
+ *
+ *  Copyright 2014 SmartThings
+ *
+ */
+metadata {
+	definition (name: "Z-Wave Metering Dimmer", namespace: "smartthings", author: "SmartThings") {
+		capability "Switch"
+		capability "Polling"
+		capability "Power Meter"
+		capability "Energy Meter"
+		capability "Refresh"
+		capability "Switch Level"
+		capability "Sensor"
+		capability "Actuator"
+
+		command "reset"
+
+		fingerprint inClusters: "0x26,0x32"
+	}
+
+	simulator {
+		status "on":  "command: 2603, payload: FF"
+		status "off": "command: 2603, payload: 00"
+		status "09%": "command: 2603, payload: 09"
+		status "10%": "command: 2603, payload: 0A"
+		status "33%": "command: 2603, payload: 21"
+		status "66%": "command: 2603, payload: 42"
+		status "99%": "command: 2603, payload: 63"
+
+		for (int i = 0; i <= 10000; i += 1000) {
+			status "power  ${i} W": new physicalgraph.zwave.Zwave().meterV1.meterReport(
+				scaledMeterValue: i, precision: 3, meterType: 4, scale: 2, size: 4).incomingMessage()
+		}
+		for (int i = 0; i <= 100; i += 10) {
+			status "energy  ${i} kWh": new physicalgraph.zwave.Zwave().meterV1.meterReport(
+				scaledMeterValue: i, precision: 3, meterType: 0, scale: 0, size: 4).incomingMessage()
+		}
+
+		["FF", "00", "09", "0A", "21", "42", "63"].each { val ->
+			reply "2001$val,delay 100,2602": "command: 2603, payload: $val"
+		}
+	}
+
+	tiles {
+		standardTile("switch", "device.switch", width: 2, height: 2, canChangeIcon: true) {
+			state "on", label:'${name}', action:"switch.off", icon:"st.switches.switch.on", backgroundColor:"#79b821", nextState:"turningOff"
+			state "off", label:'${name}', action:"switch.on", icon:"st.switches.switch.off", backgroundColor:"#ffffff", nextState:"turningOn"
+			state "turningOn", label:'${name}', icon:"st.switches.switch.on", backgroundColor:"#79b821"
+			state "turningOff", label:'${name}', icon:"st.switches.switch.off", backgroundColor:"#ffffff"
+		}
+		valueTile("power", "device.power") {
+			state "default", label:'${currentValue} W'
+		}
+		valueTile("energy", "device.energy") {
+			state "default", label:'${currentValue} kWh'
+		}
+		standardTile("reset", "device.energy", inactiveLabel: false, decoration: "flat") {
+			state "default", label:'reset kWh', action:"reset"
+		}
+		controlTile("levelSliderControl", "device.level", "slider", height: 1, width: 3, inactiveLabel: false) {
+			state "level", action:"switch level.setLevel"
+		}
+		standardTile("refresh", "device.switch", inactiveLabel: false, decoration: "flat") {
+			state "default", label:"", action:"refresh.refresh", icon:"st.secondary.refresh"
+		}
+	}
+
+	main(["switch","power","energy"])
+	details(["switch", "power", "energy", "levelSliderControl", "refresh", "reset"])
+}
+
+// parse events into attributes
+def parse(String description) {
+	def result = null
+	if (description != "updated") {
+		def cmd = zwave.parse(description, [0x20: 1, 0x26: 3, 0x70: 1, 0x32:3])
+		if (cmd) {
+			result = zwaveEvent(cmd)
+	        log.debug("'$description' parsed to $result")
+		} else {
+			log.debug("Couldn't zwave.parse '$description'")
+		}
+	}
+    result
+}
+
+def updated() {
+	response(refresh())
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicReport cmd) {
+	dimmerEvents(cmd)
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicSet cmd) {
+	dimmerEvents(cmd)
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.switchmultilevelv3.SwitchMultilevelReport cmd) {
+	dimmerEvents(cmd)
+}
+
+def dimmerEvents(physicalgraph.zwave.Command cmd) {
+	def result = []
+	def value = (cmd.value ? "on" : "off")
+	def switchEvent = createEvent(name: "switch", value: value, descriptionText: "$device.displayName was turned $value")
+	result << switchEvent
+	if (cmd.value) {
+		result << createEvent(name: "level", value: cmd.value, unit: "%")
+	}
+	if (switchEvent.isStateChange) {
+		result << response(["delay 3000", zwave.meterV2.meterGet(scale: 2).format()])
+	}
+	return result
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.meterv3.MeterReport cmd) {
+	if (cmd.meterType == 1) {
+		if (cmd.scale == 0) {
+			return createEvent(name: "energy", value: cmd.scaledMeterValue, unit: "kWh")
+		} else if (cmd.scale == 1) {
+			return createEvent(name: "energy", value: cmd.scaledMeterValue, unit: "kVAh")
+		} else if (cmd.scale == 2) {
+			return createEvent(name: "power", value: Math.round(cmd.scaledMeterValue), unit: "W")
+		} else {
+			return createEvent(name: "electric", value: cmd.scaledMeterValue, unit: ["pulses", "V", "A", "R/Z", ""][cmd.scale - 3])
+		}
+	}
+}
+
+def on() {
+	delayBetween([
+		zwave.basicV1.basicSet(value: 0xFF).format(),
+		zwave.switchMultilevelV1.switchMultilevelGet().format(),
+	], 5000)
+}
+
+def off() {
+	delayBetween([
+		zwave.basicV1.basicSet(value: 0x00).format(),
+		zwave.switchMultilevelV1.switchMultilevelGet().format(),
+	], 5000)
+}
+
+def poll() {
+	delayBetween([
+		zwave.meterV2.meterGet(scale: 0).format(),
+		zwave.meterV2.meterGet(scale: 2).format(),
+	], 1000)
+}
+
+def refresh() {
+	delayBetween([
+		zwave.switchMultilevelV1.switchMultilevelGet().format(),
+		zwave.meterV2.meterGet(scale: 0).format(),
+		zwave.meterV2.meterGet(scale: 2).format(),
+	], 1000)
+}
+
+def setLevel(level) {
+	if(level > 99) level = 99
+	delayBetween([
+		zwave.basicV1.basicSet(value: level).format(),
+		zwave.switchMultilevelV1.switchMultilevelGet().format()
+	], 5000)
+}