MSA-2096: For use with sump pump z-wave module. Allows battery backup sump pump systems made by Glentronics, inc to send alert notifications through Z-wave to the SmartThings user.

devicetypes/fortrezz/sump-pump-controller.src/sump-pump-controller.groovy

@@ -0,0 +1,167 @@
+/**
+ *  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: "Sump Pump Controller", namespace: "fortrezz", author: "FortrezZ, LLC") {
+		capability "Sensor"
+
+		attribute "alarmState", "string"
+        attribute "powerAlert", "number"
+        attribute "sumpAlert", "number"
+
+		fingerprint deviceId: "0x0701", inClusters: "0x5E,0x86,0x72,0x5A,0x85,0x59,0x73,0x20,0x7A,0x71"
+	}
+
+	simulator {
+		status "replace battery now": "command: 7105, payload: 00 00 00 FF 08 0B 00 00"
+		status "battery fully charged": "command: 7105, payload: 00 00 00 FF 08 0D 00 00"
+		status "AC mains disconnected": "command: 7105, payload: 00 00 00 FF 08 02 00 00"
+		status "AC mains reconnected": "command: 7105, payload: 00 00 00 FF 08 03 00 00"
+		status "Excess Pumping": "command: 7105, payload: 00 00 00 FF 09 03 01 01 00"
+		status "Float Error": "command: 7105, payload: 00 00 00 FF 09 03 01 02 00"
+		status "General Error": "command: 7105, payload: 00 00 00 FF 09 01 00 00"
+	}
+
+	tiles (scale: 2){
+		multiAttributeTile(name:"alert", type: "lighting", width: 6, height: 4){
+			tileAttribute ("device.alarm", key: "PRIMARY_CONTROL") {
+				attributeState("clear", label:"clear", icon:"http://swiftlet.technology/wp-content/uploads/2016/04/Ok-96.png", backgroundColor:"#ffffff")
+                attributeState("alert", label:"Alert!", icon:"http://swiftlet.technology/wp-content/uploads/2016/04/Error-96.png", backgroundColor:"#ff5b5b")
+			}
+		}
+		main "alert"
+		details(["alert"])
+	}
+}
+
+def parse(String description) {
+	def results = []
+	if (description.startsWith("Err")) {
+	    results << createEvent(descriptionText:description, displayed:true)
+	} else {
+		def cmd = zwave.parse(description, [ 0x80: 1, 0x84: 1, 0x71: 2, 0x72: 1 ])
+		if (cmd) {
+			zwaveEvent(cmd, results)
+		}
+	}
+	log.debug "\"$description\" parsed to ${results.inspect()}"
+	return results
+}
+
+
+// Notification Report from SPM
+def zwaveEvent(physicalgraph.zwave.commands.alarmv2.AlarmReport cmd, results) {
+    def powerAlert = device.currentValue("powerAlert")
+    if (powerAlert == null)
+    {
+    	powerAlert = 0
+    }
+    def sumpAlert = device.currentValue("sumpAlert")
+    if (sumpAlert == null)
+    {
+    	sumpAlert = 0
+    }
+
+if (cmd.zwaveAlarmType == 8) {
+    	if (cmd.zwaveAlarmEvent == 2) {
+        	results << createEvent(name: "alarmState", value: "acMainsDisconnected", descriptionText: "AC Mains Disconnected")
+            powerAlert = powerAlert + 1
+        } else if (cmd.zwaveAlarmEvent == 3) {
+        	results << createEvent(name: "alarmState", value: "acMainsReconnected", descriptionText: "AC Mains Reconnected")
+            powerAlert = powerAlert - 1
+        } else if (cmd.zwaveAlarmEvent == 11) {
+        	results << createEvent(name: "alarmState", value: "replaceBatteryNow", descriptionText: "Replace AA batteries in Z-wave module")
+            powerAlert = powerAlert + 1
+        } else if (cmd.zwaveAlarmEvent == 13) {
+        	results << createEvent(name: "alarmState", value: "batteryFullyCharged", descriptionText: "AA Batteries Replaced")
+            powerAlert = powerAlert - 1
+        }
+        
+        if (powerAlert < 0)
+        {
+        	powerAlert = 0
+        }
+	} else if (cmd.zwaveAlarmType == 9) {
+    	if (cmd.zwaveAlarmEvent == 1) {
+        	results << createEvent(name: "alarmState", value: "systemHardwareFailure", descriptionText: "Sump Pump Error, refer to Sump Pump Controller Unit")
+            sumpAlert = sumpAlert + 1
+        } else if (cmd.zwaveAlarmEvent == 3) {
+			if (cmd.eventParameter[0] == 0) {
+            	results << createEvent(name: "alarmState", value: "alarmClear", descriptionText: "Alarm has been cleared")
+                sumpAlert = 0
+            } else if (cmd.eventParameter[0] == 1) {
+            	results << createEvent(name: "alarmState", value: "floatError", descriptionText: "Pump or float problem")
+	            sumpAlert = sumpAlert + 1
+            } else if (cmd.eventParameter[0] == 2) {
+            	results << createEvent(name: "alarmState", value: "backupPumpActivated", descriptionText: "Backup pump was activated")
+	            sumpAlert = sumpAlert + 1
+            } else if (cmd.eventParameter[0] == 3) {
+            	results << createEvent(name: "alarmState", value: "highWater", descriptionText: "High water alarm")
+	            sumpAlert = sumpAlert + 1
+            } else if (cmd.eventParameter[0] == 4) {
+            	results << createEvent(name: "alarmState", value: "addWater", descriptionText: "Add distilled water to the battery")
+	            sumpAlert = sumpAlert + 1
+            } else if (cmd.eventParameter[0] == 5) {
+            	results << createEvent(name: "alarmState", value: "backupPumpError", descriptionText: "Backup pump is defective or not connected")
+	            sumpAlert = sumpAlert + 1
+            } else if (cmd.eventParameter[0] == 6) {
+            	results << createEvent(name: "alarmState", value: "9VBatteryLow", descriptionText: "9 volt battery is low or slide switch is OFF")
+	            sumpAlert = sumpAlert + 1
+            } else if (cmd.eventParameter[0] == 7) {
+            	results << createEvent(name: "alarmState", value: "12VBatteryError", descriptionText: "Problem with backup sump pump battery")
+	            sumpAlert = sumpAlert + 1
+            } else if (cmd.eventParameter[0] == 8) {
+            	results << createEvent(name: "alarmState", value: "checkCable", descriptionText: "Check your cable connection (to Z-wave module)")
+	            sumpAlert = sumpAlert + 1
+            }
+		}
+
+		if (sumpAlert < 0)
+        {
+        	sumpAlert = 0
+        }
+	}
+    
+    if ((sumpAlert > 0) || (powerAlert > 0))
+    {
+    	sendEvent(name: "alarm", value: "alert", displayed: false)
+    }
+    else
+    {
+    	sendEvent(name: "alarm", value: "clear", displayed: false)
+    }
+    results
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.wakeupv1.WakeUpNotification cmd, results) {
+	results << new physicalgraph.device.HubAction(zwave.wakeUpV1.wakeUpNoMoreInformation().format())
+	results << createEvent(descriptionText: "$device.displayName woke up", isStateChange: false)
+}
+
+def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd, results) {
+	def map = [ name: "battery", unit: "%" ]
+	if (cmd.batteryLevel == 0xFF) {
+		map.value = 1
+		map.descriptionText = "$device.displayName battery is low!"
+	} else {
+		map.value = cmd.batteryLevel
+	}
+	results << createEvent(map)
+}
+
+def zwaveEvent(physicalgraph.zwave.Command cmd, results) {
+	def event = [ displayed: false ]
+	event.linkText = device.label ?: device.name
+	event.descriptionText = "$event.linkText: $cmd"
+	results << createEvent(event)
+}

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

@@ -1,202 +1,203 @@
-//DEPRECATED. INTEGRATION MOVED TO SUPER LAN CONNECT
+//DEPRECATED. INTEGRATION MOVED TO SUPER LAN CONNECT
-
+
-/**
+/**
- *  Hue Bulb
+ *  Hue Bulb
- *
+ *
- *  Philips Hue Type "Extended Color Light"
+ *  Philips Hue Type "Extended Color Light"
- *
+ *
- *  Author: SmartThings
+ *  Author: SmartThings
- */
+ */
-
+
-// for the UI
+// for the UI
-metadata {
+metadata {
-	// Automatically generated. Make future change here.
+	// Automatically generated. Make future change here.
-	definition (name: "Hue Bulb", namespace: "smartthings", author: "SmartThings") {
+	definition (name: "Hue Bulb", namespace: "smartthings", author: "SmartThings") {
-		capability "Switch Level"
+		capability "Switch Level"
-		capability "Actuator"
+		capability "Actuator"
-		capability "Color Control"
+		capability "Color Control"
-		capability "Color Temperature"
+		capability "Color Temperature"
-		capability "Switch"
+		capability "Switch"
-		capability "Refresh"
+		capability "Refresh"
-		capability "Sensor"
+		capability "Sensor"
-		capability "Health Check"
+		capability "Health Check"
-		capability "Light"
+		capability "Light"
-
+
-		command "setAdjustedColor"
+		command "setAdjustedColor"
-        command "reset"
+        command "reset"
-        command "refresh"
+        command "refresh"
-	}
+	}
-
+
-	simulator {
+	simulator {
-		// TODO: define status and reply messages here
+		// TODO: define status and reply messages here
-	}
+	}
-
+
-	tiles (scale: 2){
+	tiles (scale: 2){
-		multiAttributeTile(name:"rich-control", type: "lighting", width: 6, height: 4, canChangeIcon: true){
+		multiAttributeTile(name:"rich-control", type: "lighting", width: 6, height: 4, canChangeIcon: true){
-			tileAttribute ("device.switch", key: "PRIMARY_CONTROL") {
+			tileAttribute ("device.switch", key: "PRIMARY_CONTROL") {
-				attributeState "on", label:'${name}', action:"switch.off", icon:"st.lights.philips.hue-single", backgroundColor:"#00A0DC", nextState:"turningOff"
+				attributeState "on", label:'${name}', action:"switch.off", icon:"st.lights.philips.hue-single", backgroundColor:"#00A0DC", nextState:"turningOff"
-				attributeState "off", label:'${name}', action:"switch.on", icon:"st.lights.philips.hue-single", backgroundColor:"#ffffff", nextState:"turningOn"
+				attributeState "off", label:'${name}', action:"switch.on", icon:"st.lights.philips.hue-single", backgroundColor:"#ffffff", nextState:"turningOn"
-				attributeState "turningOn", label:'${name}', action:"switch.off", icon:"st.lights.philips.hue-single", backgroundColor:"#00A0DC", nextState:"turningOff"
+				attributeState "turningOn", label:'${name}', action:"switch.off", icon:"st.lights.philips.hue-single", backgroundColor:"#00A0DC", nextState:"turningOff"
-				attributeState "turningOff", label:'${name}', action:"switch.on", icon:"st.lights.philips.hue-single", backgroundColor:"#ffffff", nextState:"turningOn"
+				attributeState "turningOff", label:'${name}', action:"switch.on", icon:"st.lights.philips.hue-single", backgroundColor:"#ffffff", nextState:"turningOn"
-			}
+			}
-			tileAttribute ("device.level", key: "SLIDER_CONTROL") {
+			tileAttribute ("device.level", key: "SLIDER_CONTROL") {
-				attributeState "level", action:"switch level.setLevel", range:"(0..100)"
+				attributeState "level", action:"switch level.setLevel", range:"(0..100)"
-            }
+            }
-			tileAttribute ("device.color", key: "COLOR_CONTROL") {
+			tileAttribute ("device.color", key: "COLOR_CONTROL") {
-				attributeState "color", action:"setAdjustedColor"
+				attributeState "color", action:"setAdjustedColor"
-			}
+			}
-		}
+		}
-
+
-    controlTile("colorTempSliderControl", "device.colorTemperature", "slider", width: 4, height: 2, inactiveLabel: false, range:"(2000..6500)") {
+    controlTile("colorTempSliderControl", "device.colorTemperature", "slider", width: 4, height: 2, inactiveLabel: false, range:"(2000..6500)") {
-        state "colorTemperature", action:"color temperature.setColorTemperature"
+        state "colorTemperature", action:"color temperature.setColorTemperature"
-    }
+    }
-
+
-    valueTile("colorTemp", "device.colorTemperature", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
+    valueTile("colorTemp", "device.colorTemperature", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
-        state "colorTemperature", label: 'WHITES'
+        state "colorTemperature", label: 'WHITES'
-    }
+    }
-
+
-		standardTile("reset", "device.reset", height: 2, width: 2, inactiveLabel: false, decoration: "flat") {
+		standardTile("reset", "device.reset", height: 2, width: 2, inactiveLabel: false, decoration: "flat") {
-			state "default", label:"Reset To White", action:"reset", icon:"st.lights.philips.hue-single"
+			state "default", label:"Reset To White", action:"reset", icon:"st.lights.philips.hue-single"
-		}
+		}
-
+
-		standardTile("refresh", "device.refresh", height: 2, width: 2, inactiveLabel: false, decoration: "flat") {
+		standardTile("refresh", "device.refresh", height: 2, width: 2, inactiveLabel: false, decoration: "flat") {
-			state "default", label:"", action:"refresh.refresh", icon:"st.secondary.refresh"
+			state "default", label:"", action:"refresh.refresh", icon:"st.secondary.refresh"
-		}
+		}
-
+
-		main(["rich-control"])
+		main(["rich-control"])
-		details(["rich-control", "colorTempSliderControl", "colorTemp", "reset", "refresh"])
+		details(["rich-control", "colorTempSliderControl", "colorTemp", "reset", "refresh"])
-	}
+	}
-}
+}
-
+
-def initialize() {
+def initialize() {
-	sendEvent(name: "DeviceWatch-Enroll", value: "{\"protocol\": \"LAN\", \"scheme\":\"untracked\", \"hubHardwareId\": \"${device.hub.hardwareID}\"}", displayed: false)
+	sendEvent(name: "DeviceWatch-Enroll", value: "{\"protocol\": \"LAN\", \"scheme\":\"untracked\", \"hubHardwareId\": \"${device.hub.hardwareID}\"}", displayed: false)
-}
+}
-
+
-void installed() {
+void installed() {
-	log.debug "installed()"
+	log.debug "installed()"
-	initialize()
+	initialize()
-}
+}
-
+
-def updated() {
+def updated() {
-	log.debug "updated()"
+	log.debug "updated()"
-	initialize()
+	initialize()
-}
+}
-
+
-// parse events into attributes
+// parse events into attributes
-def parse(description) {
+def parse(description) {
-	log.debug "parse() - $description"
+	log.debug "parse() - $description"
-	def results = []
+	def results = []
-
+
-	def map = description
+	def map = description
-	if (description instanceof String)  {
+	if (description instanceof String)  {
-		log.debug "Hue Bulb stringToMap - ${map}"
+		log.debug "Hue Bulb stringToMap - ${map}"
-		map = stringToMap(description)
+		map = stringToMap(description)
-	}
+	}
-
+
-	if (map?.name && map?.value) {
+	if (map?.name && map?.value) {
-		results << createEvent(name: "${map?.name}", value: "${map?.value}")
+		results << createEvent(name: "${map?.name}", value: "${map?.value}")
-	}
+	}
-	results
+	results
-}
+}
-
+
-// handle commands
+// handle commands
-void on() {
+void on() {
-	log.trace parent.on(this)
+	log.trace parent.on(this)
-}
+}
-
+
-void off() {
+void off() {
-	log.trace parent.off(this)
+	log.trace parent.off(this)
-}
+}
-
+
-void setLevel(percent) {
+void setLevel(percent) {
-    log.debug "Executing 'setLevel'"
+    log.debug "Executing 'setLevel'"
-    if (verifyPercent(percent)) {
+    if (verifyPercent(percent)) {
-	    log.trace parent.setLevel(this, percent)
+	    log.trace parent.setLevel(this, percent)
-    }
+    }
-}
+}
-
+
-void setSaturation(percent) {
+void setSaturation(percent) {
-    log.debug "Executing 'setSaturation'"
+    log.debug "Executing 'setSaturation'"
-    if (verifyPercent(percent)) {
+    if (verifyPercent(percent)) {
-	    log.trace parent.setSaturation(this, percent)
+	    log.trace parent.setSaturation(this, percent)
-    }
+    }
-}
+}
-
+
-void setHue(percent) {
+void setHue(percent) {
-    log.debug "Executing 'setHue'"
+    log.debug "Executing 'setHue'"
-    if (verifyPercent(percent)) {
+    if (verifyPercent(percent)) {
-	    log.trace parent.setHue(this, percent)
+	    log.trace parent.setHue(this, percent)
-    }
+    }
-}
+}
-
+
-void setColor(value) {
+void setColor(value) {
-    def events = []
+    def events = []
-    def validValues = [:]
+    def validValues = [:]
-
+
-    if (verifyPercent(value.hue)) {
+    if (verifyPercent(value.hue)) {
-        validValues.hue = value.hue
+        validValues.hue = value.hue
-    }
+    }
-    if (verifyPercent(value.saturation)) {
+    if (verifyPercent(value.saturation)) {
-        validValues.saturation = value.saturation
+        validValues.saturation = value.saturation
-    }
+    }
-    if (value.hex != null) {
+    if (value.hex != null) {
-        if (value.hex ==~ /^\#([A-Fa-f0-9]){6}$/) {
+        if (value.hex ==~ /^\#([A-Fa-f0-9]){6}$/) {
-            validValues.hex = value.hex
+            validValues.hex = value.hex
-        } else {
+        } else {
-            log.warn "$value.hex is not a valid color"
+            log.warn "$value.hex is not a valid color"
-        }
+        }
-    }
+    }
-    if (verifyPercent(value.level)) {
+    if (verifyPercent(value.level)) {
-        validValues.level = value.level
+        validValues.level = value.level
-    }
+    }
-    if (value.switch == "off" || (value.level != null && value.level <= 0)) {
+    if (value.switch == "off" || (value.level != null && value.level <= 0)) {
-        validValues.switch = "off"
+        validValues.switch = "off"
-    } else {
+    } else {
-        validValues.switch = "on"
+        validValues.switch = "on"
-    }
+    }
-    if (!validValues.isEmpty()) {
+    if (!validValues.isEmpty()) {
-	    log.trace parent.setColor(this, validValues)
+	    log.trace parent.setColor(this, validValues)
-    }
+    }
-}
+}
-
+
-void reset() {
+void reset() {
-    log.debug "Executing 'reset'"
+    log.debug "Executing 'reset'"
-	setColorTemperature(4000)
+	setColorTemperature(4000)
-}
+}
-
+
-void setAdjustedColor(value) {
+void setAdjustedColor(value) {
-    if (value) {
+    if (value) {
-        log.trace "setAdjustedColor: ${value}"
+        log.trace "setAdjustedColor: ${value}"
-        def adjusted = value + [:]
+        def adjusted = value + [:]
-        // Needed because color picker always sends 100
+        // Needed because color picker always sends 100
-        adjusted.level = null
+        adjusted.level = null
-	    setColor(adjusted)
+	    setColor(adjusted)
-    } else {
+    } else {
-        log.warn "Invalid color input $value"
+        log.warn "Invalid color input $value"
-    }
+    }
-}
+}
-
+
-void setColorTemperature(value) {
+void setColorTemperature(value) {
-    if (value) {
+    if (value) {
-        log.trace "setColorTemperature: ${value}k"
+        log.trace "setColorTemperature: ${value}k"
-	    log.trace parent.setColorTemperature(this, value)
+	    log.trace parent.setColorTemperature(this, value)
-    } else {
+    } else {
-        log.warn "Invalid color temperature $value"
+        log.warn "Invalid color temperature $value"
-    }
+    }
-}
+}
-
+
-void refresh() {
+void refresh() {
-    log.debug "Executing 'refresh'"
+    log.debug "Executing 'refresh'"
-    parent?.manualRefresh()
+    parent?.manualRefresh()
-}
+}
-
+
-def verifyPercent(percent) {
+def verifyPercent(percent) {
-    if (percent == null)
+    if (percent == null)
-        return false
+        return false
-    else if (percent >= 0 && percent <= 100) {
+    else if (percent >= 0 && percent <= 100) {
-        return true
+        return true
-    } else {
+    } else {
-        log.warn "$percent is not 0-100"
+        log.warn "$percent is not 0-100"
-        return false
+        return false
-    }
+    }
-}
+}
+