mirror of
https://github.com/mtan93/SmartThingsPublic.git
synced 2026-04-02 06:13:07 +01:00
MSA-2118: - For use with Flow Meter -
Leak Detector SmartApp allows uses to create custom rules for turning off their water and getting notifications from their flow meter. Catch a running toilet and turn off the water automatically. Detect leaky pipes and notify user of leak alert. 5 different trigger types: Continuous flow, accumulated flow, Mode, Time Period, Water Valve Status. Parent & Child app need to be installed as a pair (parent first).
This commit is contained in:
Fortrezz
243
smartapps/fortrezz/leak-detector.src/leak-detector.groovy
Normal file
243
smartapps/fortrezz/leak-detector.src/leak-detector.groovy
Normal file
@@ -0,0 +1,243 @@
|
||||
/**
|
||||
* Leak Detector
|
||||
*
|
||||
* Copyright 2016 Daniel Kurin
|
||||
*
|
||||
*/
|
||||
definition(
|
||||
name: "Leak Detector",
|
||||
namespace: "fortrezz",
|
||||
author: "FortrezZ, LLC",
|
||||
description: "Child SmartApp for leak detector rules",
|
||||
category: "Green Living",
|
||||
parent: "fortrezz:FortrezZ Leak Detector",
|
||||
iconUrl: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience.png",
|
||||
iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience@2x.png",
|
||||
iconX3Url: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience@2x.png")
|
||||
|
||||
|
||||
preferences {
|
||||
page(name: "prefsPage", title: "Choose the detector behavior", install: true, uninstall: true)
|
||||
|
||||
// Do something here like update a message on the screen,
|
||||
// or introduce more inputs. submitOnChange will refresh
|
||||
// the page and allow the user to see the changes immediately.
|
||||
// For example, you could prompt for the level of the dimmers
|
||||
// if dimmers have been selected:
|
||||
//log.debug "Child Settings: ${settings}"
|
||||
}
|
||||
|
||||
def prefsPage() {
|
||||
def daysOfTheWeek = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
|
||||
dynamicPage(name: "prefsPage") {
|
||||
section("Set Leak Threshold by...") {
|
||||
input(name: "type", type: "enum", title: "Type...", submitOnChange: true, options: ruleTypes())
|
||||
}
|
||||
|
||||
if(type)
|
||||
{
|
||||
switch (type) {
|
||||
case "Mode":
|
||||
section("Threshold settings") {
|
||||
input(name: "ruleName", type: "text", title: "Rule Name", required: true)
|
||||
input(name: "gpm", type: "decimal", title: "GPM exceeds", required: true, defaultValue: 0.1)
|
||||
}
|
||||
section("Only in these modes") {
|
||||
input(name: "modes", type: "mode", title: "select a mode(s)", multiple: true, required: true)
|
||||
}
|
||||
section ("Action") {
|
||||
input(name: "dev", type: "capability.actuator", title: "Choose a device to perform the action", required: false, submitOnChange: true)
|
||||
if (dev) {
|
||||
input(name: "command", type: "enum", title: "Command...", submitOnChange: true, options: deviceCommands(dev))
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Time Period":
|
||||
section("Threshold settings") {
|
||||
input(name: "ruleName", type: "text", title: "Rule Name", required: true)
|
||||
input(name: "gpm", type: "decimal", title: "GPM exceeds", required: true)
|
||||
}
|
||||
section("Between...") {
|
||||
input(name: "startTime", type: "time", title: "Start Time", required: true)
|
||||
}
|
||||
section("...and...") {
|
||||
input(name: "endTime", type: "time", title: "End Time", required: true)
|
||||
}
|
||||
section("Only on these days") {
|
||||
input(name: "days", type: "enum", title: "Days of the week", required: false, options: daysOfTheWeek, multiple: true)
|
||||
}
|
||||
section("Only in these modes") {
|
||||
input(name: "modes", type: "mode", title: "System Modes", required: false, multiple: true)
|
||||
}
|
||||
section ("Action") {
|
||||
input(name: "dev", type: "capability.actuator", title: "Choose a device to perform the action", required: false, submitOnChange: true)
|
||||
if (dev) {
|
||||
input(name: "command", type: "enum", title: "Command...", submitOnChange: true, options: deviceCommands(dev))
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Accumulated Flow":
|
||||
section("Threshold settings") {
|
||||
input(name: "ruleName", type: "text", title: "Rule Name", required: true)
|
||||
input(name: "gallons", type: "number", title: "Total Gallons exceeds", required: true)
|
||||
}
|
||||
section("Between...") {
|
||||
input(name: "startTime", type: "time", title: "Start Time", required: true)
|
||||
}
|
||||
section("...and...") {
|
||||
input(name: "endTime", type: "time", title: "End Time", required: true)
|
||||
}
|
||||
section("Only on these days") {
|
||||
input(name: "days", type: "enum", title: "Days of the week", required: false, options: daysOfTheWeek, multiple: true)
|
||||
}
|
||||
section("Only in these modes") {
|
||||
input(name: "modes", type: "mode", title: "System Modes", required: false, multiple: true)
|
||||
}
|
||||
section ("Action") {
|
||||
input(name: "dev", type: "capability.actuator", title: "Choose a device to perform the action", required: false, submitOnChange: true)
|
||||
if (dev) {
|
||||
input(name: "command", type: "enum", title: "Command...", submitOnChange: true, options: deviceCommands(dev))
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Continuous Flow":
|
||||
section("Threshold settings") {
|
||||
input(name: "ruleName", type: "text", title: "Rule Name", required: true)
|
||||
input(name: "flowMinutes", type: "number", title: "Minutes of constant flow", required: true, defaultValue: 60)
|
||||
}
|
||||
section("Only in these modes") {
|
||||
input(name: "modes", type: "mode", title: "System Modes", required: false, multiple: true)
|
||||
}
|
||||
section ("Action") {
|
||||
input(name: "dev", type: "capability.actuator", title: "Choose a device to perform the action", required: false, submitOnChange: true)
|
||||
if (dev) {
|
||||
input(name: "command", type: "enum", title: "Command...", submitOnChange: true, options: deviceCommands(dev))
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Water Valve Status":
|
||||
section("Threshold settings") {
|
||||
input(name: "ruleName", type: "text", title: "Rule Name", required: true)
|
||||
input(name: "gpm", type: "decimal", title: "GPM exceeds", required: true, defaultValue: 0.1)
|
||||
}
|
||||
section ("While...") {
|
||||
input(name: "valve", type: "capability.valve", title: "Choose a valve", required: true)
|
||||
}
|
||||
section ("...is...") {
|
||||
input(name: "valveStatus", type: "enum", title: "Status", options: ["Open","Closed"], required: true)
|
||||
}
|
||||
break
|
||||
|
||||
case "Switch Status":
|
||||
section("Threshold settings") {
|
||||
input(name: "ruleName", type: "text", title: "Rule Name", required: true)
|
||||
input(name: "gpm", type: "decimal", title: "GPM exceeds", required: true, defaultValue: 0.1)
|
||||
}
|
||||
section ("If...") {
|
||||
input(name: "valve", type: "capability.switch", title: "Choose a switch", required: true)
|
||||
}
|
||||
section ("...is...") {
|
||||
input(name: "switchStatus", type: "enum", title: "Status", options: ["On","Off"], required: true)
|
||||
}
|
||||
break
|
||||
|
||||
default:
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def ruleTypes() {
|
||||
def types = []
|
||||
types << "Mode"
|
||||
types << "Time Period"
|
||||
types << "Accumulated Flow"
|
||||
types << "Continuous Flow"
|
||||
types << "Water Valve Status"
|
||||
//types << "Switch Status"
|
||||
|
||||
return types
|
||||
}
|
||||
|
||||
def actionTypes() {
|
||||
def types = []
|
||||
types << [name: "Switch", capability: "capabilty.switch"]
|
||||
types << [name: "Water Valve", capability: "capability.valve"]
|
||||
|
||||
return types
|
||||
}
|
||||
|
||||
def deviceCommands(dev)
|
||||
{
|
||||
def cmds = []
|
||||
dev.supportedCommands.each { command ->
|
||||
cmds << command.name
|
||||
}
|
||||
|
||||
return cmds
|
||||
}
|
||||
|
||||
def installed() {
|
||||
log.debug "Installed with settings: ${settings}"
|
||||
app.updateLabel("${ruleName ? ruleName : ""} - ${type}")
|
||||
|
||||
initialize()
|
||||
}
|
||||
|
||||
def updated() {
|
||||
log.debug "Updated with settings: ${settings}"
|
||||
app.updateLabel("${ruleName ? ruleName : ""} - ${type}")
|
||||
|
||||
unsubscribe()
|
||||
initialize()
|
||||
}
|
||||
|
||||
def settings() {
|
||||
def set = settings
|
||||
if (set["dev"] != null)
|
||||
{
|
||||
log.debug("dev set: ${set.dev}")
|
||||
set.dev = set.dev.id
|
||||
}
|
||||
if (set["valve"] != null)
|
||||
{
|
||||
log.debug("valve set: ${set.valve}")
|
||||
set.valve = set.valve.id
|
||||
}
|
||||
log.debug(set)
|
||||
return set
|
||||
}
|
||||
|
||||
def devAction(action)
|
||||
{
|
||||
if(dev)
|
||||
{
|
||||
log.debug("device: ${dev}, action: ${action}")
|
||||
dev."${action}"()
|
||||
}
|
||||
}
|
||||
|
||||
def isValveStatus(status)
|
||||
{
|
||||
def result = false
|
||||
log.debug("Water Valve ${valve} has status ${valve.currentState("contact").value}, compared to ${status.toLowerCase()}")
|
||||
if(valve)
|
||||
{
|
||||
if(valve.currentState("contact").value == status.toLowerCase())
|
||||
{
|
||||
result = true
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
def initialize() {
|
||||
// TODO: subscribe to attributes, devices, locations, etc.
|
||||
}
|
||||
|
||||
// TODO: implement event handlers
|
||||
Reference in New Issue
Block a user