mirror of
https://github.com/mtan93/SmartThingsPublic.git
synced 2026-03-12 21:03:11 +00:00
Compare commits
1 Commits
MSA-2127-1
...
MSA-2118-8
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4ca07ce9db |
@@ -1,462 +0,0 @@
|
||||
/**
|
||||
* Fibaro Door/Window Sensor 2
|
||||
*
|
||||
* 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: "Fibaro Door/Window Sensor 2", namespace: "Fibargroup", author: "Fibar Group S.A.") {
|
||||
capability "Contact Sensor"
|
||||
capability "Tamper Alert"
|
||||
capability "Temperature Measurement"
|
||||
capability "Configuration"
|
||||
capability "Battery"
|
||||
capability "Sensor"
|
||||
capability "Health Check"
|
||||
|
||||
attribute "temperatureAlarm", "string"
|
||||
|
||||
fingerprint mfr: "010F", prod: "0702"
|
||||
fingerprint deviceId: "0x0701", inClusters:"0x5E,0x59,0x22,0x80,0x56,0x7A,0x73,0x98,0x31,0x85,0x70,0x5A,0x72,0x8E,0x71,0x86,0x84"
|
||||
fingerprint deviceId: "0x0701", inClusters:"0x5E,0x59,0x22,0x80,0x56,0x7A,0x73,0x31,0x85,0x70,0x5A,0x72,0x8E,0x71,0x86,0x84"
|
||||
}
|
||||
|
||||
tiles (scale: 2) {
|
||||
multiAttributeTile(name:"FGDW", type:"lighting", width:6, height:4) {
|
||||
tileAttribute("device.contact", key:"PRIMARY_CONTROL") {
|
||||
attributeState("open", label:"open", icon:"st.contact.contact.open", backgroundColor:"#e86d13")
|
||||
attributeState("closed", label:"closed", icon:"st.contact.contact.closed", backgroundColor:"#00a0dc")
|
||||
}
|
||||
tileAttribute("device.multiStatus", key:"SECONDARY_CONTROL") {
|
||||
attributeState("multiStatus", label:'${currentValue}')
|
||||
}
|
||||
}
|
||||
|
||||
valueTile("tamper", "device.tamper", inactiveLabel: false, width: 2, height: 2, decoration: "flat") {
|
||||
state "tamper", label:'Tamper:\n ${currentValue}'
|
||||
}
|
||||
|
||||
valueTile("temperature", "device.temperature", inactiveLabel: false, width: 2, height: 2) {
|
||||
state "temperature", label:'${currentValue}°',
|
||||
backgroundColors:[
|
||||
[value: 31, color: "#153591"],
|
||||
[value: 44, color: "#1e9cbb"],
|
||||
[value: 59, color: "#90d2a7"],
|
||||
[value: 74, color: "#44b621"],
|
||||
[value: 84, color: "#f1d801"],
|
||||
[value: 95, color: "#d04e00"],
|
||||
[value: 96, color: "#bc2323"]
|
||||
]
|
||||
}
|
||||
|
||||
valueTile("battery", "device.battery", inactiveLabel: false, width: 2, height: 2, decoration: "flat") {
|
||||
state "battery", label:'${currentValue}%\n battery', unit:"%"
|
||||
}
|
||||
|
||||
standardTile("temperatureAlarm", "device.temperatureAlarm", inactiveLabel: false, width: 2, height: 2, decoration: "flat") {
|
||||
state "default", label: "No temp. alarm", backgroundColor:"#ffffff"
|
||||
state "clear", label:'', backgroundColor:"#ffffff", icon: "st.alarm.temperature.normal"
|
||||
state "underheat", label:'underheat', backgroundColor:"#1e9cbb", icon: "st.alarm.temperature.freeze"
|
||||
state "overheat", label:'overheat', backgroundColor:"#d04e00", icon: "st.alarm.temperature.overheat"
|
||||
}
|
||||
|
||||
main "FGDW"
|
||||
details(["FGDW","tamper","temperature","battery","temperatureAlarm"])
|
||||
}
|
||||
|
||||
preferences {
|
||||
|
||||
input (
|
||||
title: "Fibaro Door/Window Sensor 2",
|
||||
description: "Tap to view the manual.",
|
||||
image: "http://manuals.fibaro.com/wp-content/uploads/2017/05/dws2.jpg",
|
||||
url: "http://manuals.fibaro.com/content/manuals/en/FGDW-002/FGDW-002-EN-T-v1.0.pdf",
|
||||
type: "href",
|
||||
element: "href"
|
||||
)
|
||||
|
||||
input (
|
||||
title: "Wake up interval",
|
||||
description: "How often should your device automatically sync with the HUB. The lower the value, the shorter the battery life.\n0 or 1-18 (in hours)",
|
||||
type: "paragraph",
|
||||
element: "paragraph"
|
||||
)
|
||||
|
||||
input (
|
||||
name: "wakeUpInterval",
|
||||
title: null,
|
||||
type: "number",
|
||||
range: "0..18",
|
||||
defaultValue: 6,
|
||||
required: false
|
||||
)
|
||||
|
||||
parameterMap().findAll{(it.num as Integer) != 54}.each {
|
||||
input (
|
||||
title: "${it.num}. ${it.title}",
|
||||
description: it.descr,
|
||||
type: "paragraph",
|
||||
element: "paragraph"
|
||||
)
|
||||
|
||||
input (
|
||||
name: it.key,
|
||||
title: null,
|
||||
description: "Default: $it.def" ,
|
||||
type: it.type,
|
||||
options: it.options,
|
||||
range: (it.min != null && it.max != null) ? "${it.min}..${it.max}" : null,
|
||||
defaultValue: it.def,
|
||||
required: false
|
||||
)
|
||||
}
|
||||
|
||||
input ( name: "logging", title: "Logging", type: "boolean", required: false )
|
||||
}
|
||||
}
|
||||
|
||||
def updated() {
|
||||
if ( state.lastUpdated && (now() - state.lastUpdated) < 500 ) return
|
||||
logging("${device.displayName} - Executing updated()","info")
|
||||
|
||||
if ( settings.temperatureHigh as Integer == 0 && settings.temperatureLow as Integer == 0 ) {
|
||||
sendEvent(name: "temperatureAlarm", value: null, displayed: false)
|
||||
} else if ( settings.temperatureHigh != null || settings.temperatureHigh != null ) {
|
||||
sendEvent(name: "temperatureAlarm", value: "clear", displayed: false)
|
||||
}
|
||||
|
||||
syncStart()
|
||||
state.lastUpdated = now()
|
||||
}
|
||||
|
||||
def configure() {
|
||||
def cmds = []
|
||||
cmds << zwave.batteryV1.batteryGet()
|
||||
cmds << zwave.sensorMultilevelV5.sensorMultilevelGet(sensorType: 1)
|
||||
encapSequence(cmds,1000)
|
||||
}
|
||||
|
||||
private syncStart() {
|
||||
boolean syncNeeded = false
|
||||
Integer settingValue = null
|
||||
parameterMap().each {
|
||||
if(settings."$it.key" != null || it.num == 54) {
|
||||
if (state."$it.key" == null) { state."$it.key" = [value: null, state: "synced"] }
|
||||
if ( (it.num as Integer) == 54 ) {
|
||||
settingValue = (((settings."temperatureHigh" as Integer) == 0) ? 0 : 1) + (((settings."temperatureLow" as Integer) == 0) ? 0 : 2)
|
||||
} else if ( (it.num as Integer) in [55,56] ) {
|
||||
settingValue = (((settings."$it.key" as Integer) == 0) ? state."$it.key".value : settings."$it.key") as Integer
|
||||
} else {
|
||||
settingValue = settings."$it.key" as Integer
|
||||
}
|
||||
if (state."$it.key".value != settingValue || state."$it.key".state != "synced" ) {
|
||||
state."$it.key".value = settingValue
|
||||
state."$it.key".state = "notSynced"
|
||||
syncNeeded = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if(settings.wakeUpInterval != null) {
|
||||
if (state.wakeUpInterval == null) { state.wakeUpInterval = [value: null, state: "synced"] }
|
||||
if (state.wakeUpInterval.value != ((settings.wakeUpInterval as Integer) * 3600)) {
|
||||
sendEvent(name: "checkInterval", value: (settings.wakeUpInterval as Integer) * 3600 * 4 + 120, displayed: false, data: [protocol: "zwave", hubHardwareId: device.hub.hardwareID])
|
||||
state.wakeUpInterval.value = ((settings.wakeUpInterval as Integer) * 3600)
|
||||
state.wakeUpInterval.state = "notSynced"
|
||||
syncNeeded = true
|
||||
}
|
||||
} else {
|
||||
sendEvent(name: "checkInterval", value: 21600 * 4 + 120, displayed: false, data: [protocol: "zwave", hubHardwareId: device.hub.hardwareID])
|
||||
}
|
||||
|
||||
if ( syncNeeded ) {
|
||||
logging("${device.displayName} - sync needed.", "info")
|
||||
multiStatusEvent("Sync pending. Please wake up the device by pressing the tamper button.", true)
|
||||
}
|
||||
}
|
||||
|
||||
private syncNext() {
|
||||
logging("${device.displayName} - Executing syncNext()","info")
|
||||
def cmds = []
|
||||
for ( param in parameterMap() ) {
|
||||
if ( state."$param.key"?.value != null && state."$param.key"?.state in ["notSynced","inProgress"] ) {
|
||||
multiStatusEvent("Sync in progress. (param: ${param.num})", true)
|
||||
state."$param.key"?.state = "inProgress"
|
||||
cmds << response(encap(zwave.configurationV2.configurationSet(configurationValue: intToParam(state."$param.key".value, param.size), parameterNumber: param.num, size: param.size)))
|
||||
cmds << response(encap(zwave.configurationV2.configurationGet(parameterNumber: param.num)))
|
||||
break
|
||||
}
|
||||
}
|
||||
if (cmds) {
|
||||
runIn(10, "syncCheck")
|
||||
sendHubCommand(cmds,1000)
|
||||
} else {
|
||||
runIn(1, "syncCheck")
|
||||
}
|
||||
}
|
||||
|
||||
private syncCheck() {
|
||||
logging("${device.displayName} - Executing syncCheck()","info")
|
||||
def failed = []
|
||||
def incorrect = []
|
||||
def notSynced = []
|
||||
parameterMap().each {
|
||||
if (state."$it.key"?.state == "incorrect" ) {
|
||||
incorrect << it
|
||||
} else if ( state."$it.key"?.state == "failed" ) {
|
||||
failed << it
|
||||
} else if ( state."$it.key"?.state in ["inProgress","notSynced"] ) {
|
||||
notSynced << it
|
||||
}
|
||||
}
|
||||
|
||||
if (failed) {
|
||||
multiStatusEvent("Sync failed! Verify parameter: ${failed[0].num}", true, true)
|
||||
} else if (incorrect) {
|
||||
multiStatusEvent("Sync mismatch! Verify parameter: ${incorrect[0].num}", true, true)
|
||||
} else if (notSynced) {
|
||||
multiStatusEvent("Sync incomplete! Wake up the device again by pressing the tamper button.", true, true)
|
||||
} else {
|
||||
sendHubCommand(response(encap(zwave.wakeUpV1.wakeUpNoMoreInformation())))
|
||||
if (device.currentValue("multiStatus")?.contains("Sync")) { multiStatusEvent("Sync OK.", true, true) }
|
||||
}
|
||||
}
|
||||
|
||||
private multiStatusEvent(String statusValue, boolean force = false, boolean display = false) {
|
||||
if (!device.currentValue("multiStatus")?.contains("Sync") || device.currentValue("multiStatus") == "Sync OK." || force) {
|
||||
sendEvent(name: "multiStatus", value: statusValue, descriptionText: statusValue, displayed: display)
|
||||
}
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.wakeupv2.WakeUpNotification cmd) {
|
||||
logging("${device.displayName} woke up", "info")
|
||||
def cmds = []
|
||||
sendEvent(descriptionText: "$device.displayName woke up", isStateChange: true)
|
||||
if ( state.wakeUpInterval?.state == "notSynced" && state.wakeUpInterval?.value != null ) {
|
||||
cmds << zwave.wakeUpV2.wakeUpIntervalSet(seconds: state.wakeUpInterval.value as Integer, nodeid: zwaveHubNodeId)
|
||||
state.wakeUpInterval.state = "synced"
|
||||
}
|
||||
cmds << zwave.batteryV1.batteryGet()
|
||||
cmds << zwave.sensorMultilevelV5.sensorMultilevelGet(sensorType: 1)
|
||||
runIn(1,"syncNext")
|
||||
[response(encapSequence(cmds,1000))]
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.configurationv2.ConfigurationReport cmd) {
|
||||
def paramKey = parameterMap().find( {it.num == cmd.parameterNumber } ).key
|
||||
logging("${device.displayName} - Parameter ${paramKey} value is ${cmd.scaledConfigurationValue} expected " + state."$paramKey".value, "info")
|
||||
state."$paramKey".state = (state."$paramKey".value == cmd.scaledConfigurationValue) ? "synced" : "incorrect"
|
||||
syncNext()
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.applicationstatusv1.ApplicationRejectedRequest cmd) {
|
||||
logging("${device.displayName} - rejected request!","warn")
|
||||
for ( param in parameterMap() ) {
|
||||
if ( state."$param.key"?.state == "inProgress" ) {
|
||||
state."$param.key"?.state = "failed"
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.alarmv2.AlarmReport cmd) {
|
||||
logging("${device.displayName} - AlarmReport received, zwaveAlarmType: ${cmd.zwaveAlarmType}, zwaveAlarmEvent: ${cmd.zwaveAlarmEvent}", "info")
|
||||
def lastTime = new Date().format("yyyy MMM dd EEE h:mm:ss a", location.timeZone)
|
||||
switch (cmd.zwaveAlarmType) {
|
||||
case 6:
|
||||
sendEvent(name: "contact", value: (cmd.zwaveAlarmEvent == 22)? "open":"closed");
|
||||
if (cmd.zwaveAlarmEvent == 22) { multiStatusEvent("Contact Open - $lastTime") }
|
||||
break;
|
||||
case 7:
|
||||
sendEvent(name: "tamper", value: (cmd.zwaveAlarmEvent == 3)? "detected":"clear");
|
||||
if (cmd.zwaveAlarmEvent == 3) { multiStatusEvent("Tamper - $lastTime") }
|
||||
break;
|
||||
case 4:
|
||||
if (device.currentValue("temperatureAlarm")?.value != null) {
|
||||
switch (cmd.zwaveAlarmEvent) {
|
||||
case 0: sendEvent(name: "temperatureAlarm", value: "clear"); break;
|
||||
case 2: sendEvent(name: "temperatureAlarm", value: "overheat"); break;
|
||||
case 6: sendEvent(name: "temperatureAlarm", value: "underheat"); break;
|
||||
};
|
||||
};
|
||||
break;
|
||||
default: logging("${device.displayName} - Unknown zwaveAlarmType: ${cmd.zwaveAlarmType}","warn");
|
||||
}
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.sensormultilevelv5.SensorMultilevelReport cmd) {
|
||||
logging("${device.displayName} - SensorMultilevelReport received, sensorType: ${cmd.sensorType}, scaledSensorValue: ${cmd.scaledSensorValue}", "info")
|
||||
switch (cmd.sensorType) {
|
||||
case 1:
|
||||
def cmdScale = cmd.scale == 1 ? "F" : "C"
|
||||
sendEvent(name: "temperature", unit: getTemperatureScale(), value: convertTemperatureIfNeeded(cmd.scaledSensorValue, cmdScale, cmd.precision), displayed: true)
|
||||
break
|
||||
default:
|
||||
logging("${device.displayName} - Unknown sensorType: ${cmd.sensorType}","warn")
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {
|
||||
logging("${device.displayName} - BatteryReport received, value: ${cmd.batteryLevel}", "info")
|
||||
sendEvent(name: "battery", value: cmd.batteryLevel.toString(), unit: "%", displayed: true)
|
||||
}
|
||||
|
||||
def parse(String description) {
|
||||
def result = []
|
||||
logging("${device.displayName} - Parsing: ${description}")
|
||||
if (description.startsWith("Err 106")) {
|
||||
result = createEvent(
|
||||
descriptionText: "Failed to complete the network security key exchange. If you are unable to receive data from it, you must remove it from your network and add it again.",
|
||||
eventType: "ALERT",
|
||||
name: "secureInclusion",
|
||||
value: "failed",
|
||||
displayed: true,
|
||||
)
|
||||
} else if (description == "updated") {
|
||||
return null
|
||||
} else {
|
||||
def cmd = zwave.parse(description, cmdVersions())
|
||||
if (cmd) {
|
||||
logging("${device.displayName} - Parsed: ${cmd}")
|
||||
zwaveEvent(cmd)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.securityv1.SecurityMessageEncapsulation cmd) {
|
||||
def encapsulatedCommand = cmd.encapsulatedCommand(cmdVersions())
|
||||
if (encapsulatedCommand) {
|
||||
logging("${device.displayName} - Parsed SecurityMessageEncapsulation into: ${encapsulatedCommand}")
|
||||
zwaveEvent(encapsulatedCommand)
|
||||
} else {
|
||||
log.warn "Unable to extract secure cmd from $cmd"
|
||||
}
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.crc16encapv1.Crc16Encap cmd) {
|
||||
def version = cmdVersions()[cmd.commandClass as Integer]
|
||||
def ccObj = version ? zwave.commandClass(cmd.commandClass, version) : zwave.commandClass(cmd.commandClass)
|
||||
def encapsulatedCommand = ccObj?.command(cmd.command)?.parse(cmd.data)
|
||||
if (encapsulatedCommand) {
|
||||
logging("${device.displayName} - Parsed Crc16Encap into: ${encapsulatedCommand}")
|
||||
zwaveEvent(encapsulatedCommand)
|
||||
} else {
|
||||
log.warn "Could not extract crc16 command from $cmd"
|
||||
}
|
||||
}
|
||||
|
||||
private logging(text, type = "debug") {
|
||||
if (settings.logging == "true") {
|
||||
log."$type" text
|
||||
}
|
||||
}
|
||||
|
||||
private secEncap(physicalgraph.zwave.Command cmd) {
|
||||
logging("${device.displayName} - encapsulating command using Secure Encapsulation, command: $cmd","info")
|
||||
zwave.securityV1.securityMessageEncapsulation().encapsulate(cmd).format()
|
||||
}
|
||||
|
||||
private crcEncap(physicalgraph.zwave.Command cmd) {
|
||||
logging("${device.displayName} - encapsulating command using CRC16 Encapsulation, command: $cmd","info")
|
||||
zwave.crc16EncapV1.crc16Encap().encapsulate(cmd).format()
|
||||
}
|
||||
|
||||
private encap(physicalgraph.zwave.Command cmd) {
|
||||
if (zwaveInfo.zw.contains("s")) {
|
||||
secEncap(cmd)
|
||||
} else if (zwaveInfo.cc.contains("56")){
|
||||
crcEncap(cmd)
|
||||
} else {
|
||||
logging("${device.displayName} - no encapsulation supported for command: $cmd","info")
|
||||
cmd.format()
|
||||
}
|
||||
}
|
||||
|
||||
private encapSequence(cmds, Integer delay=250) {
|
||||
delayBetween(cmds.collect{ encap(it) }, delay)
|
||||
}
|
||||
|
||||
private List intToParam(Long value, Integer size = 1) {
|
||||
def result = []
|
||||
size.times {
|
||||
result = result.plus(0, (value & 0xFF) as Short)
|
||||
value = (value >> 8)
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
private Map cmdVersions() {
|
||||
[0x5E: 2, 0x59: 1, 0x22: 1, 0x80: 1, 0x56: 1, 0x7A: 3, 0x73: 1, 0x98: 1, 0x31: 5, 0x85: 2, 0x70: 2, 0x5A: 1, 0x72: 2, 0x8E: 2, 0x71: 2, 0x86: 1, 0x84: 2]
|
||||
}
|
||||
|
||||
private parameterMap() {[
|
||||
[key: "doorState", num: 1, size: 1, type: "enum", options: [0: "Closed when magnet near", 1: "Opened when magnet near"], def: "0", title: "Door/window state",
|
||||
descr: "Defines the state of door/window depending on the magnet position."],
|
||||
[key: "ledIndications", num: 2, size: 1, type: "enum", options: [
|
||||
1: "Indication of opening/closing",
|
||||
2: "Indication of wake up",
|
||||
4: "Indication of device tampering",
|
||||
6: "Indication of wake up & tampering",
|
||||
],
|
||||
def: "6", title: "Visual LED indications",
|
||||
descr: "Defines events indicated by the visual LED indicator. Disabling events might extend battery life."],
|
||||
[key: "tamperDelay", num: 30, size: 2, type: "number", def: 5, min: 0, max: 32400, title: "Tamper - alarm cancellation delay",
|
||||
descr: "Time period after which a tamper alarm will be cancelled.\n0-32400 - time in seconds"],
|
||||
[key: "tamperCancelation", num: 31, size: 1, type: "enum", options: [0: "Do not send tamper cancellation report", 1: "Send tamper cancellation report"], def: "1", title: "Tamper – reporting alarm cancellation",
|
||||
descr: "Reporting cancellation of tamper alarm to the controller and 3rd association group."],
|
||||
[key: "temperatureMeasurement", num: 50, size: 2, type: "number", def: 300, min: 0, max: 32400, title: "Interval of temperature measurements",
|
||||
descr: "This parameter defines how often the temperature will be measured (specific time).\n0 - temperature measurements disabled\n5-32400 - time in seconds"],
|
||||
[key: "temperatureThreshold", num: 51, size: 2, type: "enum", options: [
|
||||
0: "disabled",
|
||||
3: "0.5°F/0.3°C",
|
||||
6: "1°F/0.6°C",
|
||||
11: "2°F/1.1°C",
|
||||
17: "3°F/1.7°C",
|
||||
22: "4°F/2.2°C",
|
||||
28: "5°F/2.8°C"],
|
||||
def: 11, title: "Temperature reports threshold",
|
||||
descr: "Change of temperature resulting in temperature report being sent to the HUB."],
|
||||
[key: "temperatureAlarm", num: 54, size: 1, type: "enum", options: [
|
||||
0: "Temperature alarms disabled",
|
||||
1: "High temperature alarm",
|
||||
2: "Low temperature alarm",
|
||||
3: "High and low temperature alarms"],
|
||||
def: "0", title: "Temperature alarm reports",
|
||||
descr: "Temperature alarms reported to the Z-Wave controller. Thresholds are set in parameters 55 and 56"],
|
||||
[key: "temperatureHigh", num: 55, size: 2, type: "enum", options: [
|
||||
0: "disabled",
|
||||
200: "68°F/20°C",
|
||||
250: "77°F/25°C",
|
||||
300: "86°F/30°C",
|
||||
350: "95°F/35°C",
|
||||
400: "104°F/40°C",
|
||||
450: "113°F/45°C",
|
||||
500: "122°F/50°C",
|
||||
550: "131°F/55°C",
|
||||
600: "140°F/60°C"],
|
||||
def: 350, title: "High temperature alarm threshold",
|
||||
descr: "If temperature is higher than set value, overheat high temperature alarm will be triggered."],
|
||||
[key: "temperatureLow", num: 56, size: 2, type: "enum", options: [
|
||||
0: "disabled",
|
||||
6: "33°F/0.6°C",
|
||||
10: "34°F/1°C",
|
||||
22: "36°F/2.2°C",
|
||||
33: "38°F/3.3°C",
|
||||
44: "40°F/4.4°C",
|
||||
50: "41°F/5°C",
|
||||
100: "50°F/10°C",
|
||||
150: "59°F/15°C",
|
||||
200: "68°F/20°C",
|
||||
250: "77°F/25°C"],
|
||||
def: 100, title: "Low temperature alarm threshold",
|
||||
descr: "If temperature is lower than set value, low temperature alarm will be triggered."]
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,320 @@
|
||||
/**
|
||||
* Leak Detector for FortrezZ Water Meter
|
||||
*
|
||||
* Copyright 2016 Daniel Kurin
|
||||
*
|
||||
*/
|
||||
definition(
|
||||
name: "FortrezZ Leak Detector",
|
||||
namespace: "fortrezz",
|
||||
author: "FortrezZ, LLC",
|
||||
description: "Use the FortrezZ Water Meter to identify leaks in your home's water system.",
|
||||
category: "Green Living",
|
||||
iconUrl: "http://swiftlet.technology/wp-content/uploads/2016/05/logo-square-200-1.png",
|
||||
iconX2Url: "http://swiftlet.technology/wp-content/uploads/2016/05/logo-square-500.png",
|
||||
iconX3Url: "http://swiftlet.technology/wp-content/uploads/2016/05/logo-square.png")
|
||||
|
||||
|
||||
preferences {
|
||||
page(name: "page2", title: "Select device and actions", install: true, uninstall: true)
|
||||
}
|
||||
|
||||
def page2() {
|
||||
dynamicPage(name: "page2") {
|
||||
section("Choose a water meter to monitor:") {
|
||||
input(name: "meter", type: "capability.energyMeter", title: "Water Meter", description: null, required: true, submitOnChange: true)
|
||||
}
|
||||
|
||||
if (meter) {
|
||||
section {
|
||||
app(name: "childRules", appName: "Leak Detector", namespace: "fortrezz", title: "Create New Leak Detector...", multiple: true)
|
||||
}
|
||||
}
|
||||
|
||||
section("Send notifications through...") {
|
||||
input(name: "pushNotification", type: "bool", title: "SmartThings App", required: false)
|
||||
input(name: "smsNotification", type: "bool", title: "Text Message (SMS)", submitOnChange: true, required: false)
|
||||
if (smsNotification)
|
||||
{
|
||||
input(name: "phone", type: "phone", title: "Phone number?", required: true)
|
||||
}
|
||||
input(name: "minutesBetweenNotifications", type: "number", title: "Minutes between notifications", required: true, defaultValue: 60)
|
||||
}
|
||||
|
||||
log.debug "there are ${childApps.size()} child smartapps"
|
||||
def childRules = []
|
||||
childApps.each {child ->
|
||||
//log.debug "child ${child.id}: ${child.settings()}"
|
||||
childRules << [id: child.id, rules: child.settings()]
|
||||
}
|
||||
state.rules = childRules
|
||||
//log.debug("Child Rules: ${state.rules} w/ length ${state.rules.toString().length()}")
|
||||
log.debug "Parent Settings: ${settings}"
|
||||
}
|
||||
}
|
||||
|
||||
def installed() {
|
||||
log.debug "Installed with settings: ${settings}"
|
||||
|
||||
initialize()
|
||||
}
|
||||
|
||||
def updated() {
|
||||
log.debug "Updated with settings: ${settings}"
|
||||
|
||||
unsubscribe()
|
||||
initialize()
|
||||
}
|
||||
|
||||
def initialize() {
|
||||
subscribe(meter, "cumulative", cumulativeHandler)
|
||||
subscribe(meter, "gpm", gpmHandler)
|
||||
log.debug("Subscribing to events")
|
||||
}
|
||||
|
||||
def cumulativeHandler(evt) {
|
||||
//Date Stuff
|
||||
def daysOfTheWeek = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
|
||||
def today = new Date()
|
||||
today.clearTime()
|
||||
Calendar c = Calendar.getInstance();
|
||||
c.setTime(today);
|
||||
int dow = c.get(Calendar.DAY_OF_WEEK);
|
||||
def dowName = daysOfTheWeek[dow-1]
|
||||
|
||||
def gpm = meter.latestValue("gpm")
|
||||
def cumulative = new BigDecimal(evt.value)
|
||||
log.debug "Cumulative Handler: [gpm: ${gpm}, cumulative: ${cumulative}]"
|
||||
def rules = state.rules
|
||||
rules.each { it ->
|
||||
def r = it.rules
|
||||
def childAppID = it.id
|
||||
//log.debug("Rule: ${r}")
|
||||
switch (r.type) {
|
||||
case "Mode":
|
||||
log.debug("Mode Test: ${location.currentMode} in ${r.modes}... ${findIn(r.modes, location.currentMode)}")
|
||||
if (findIn(r.modes, location.currentMode))
|
||||
{
|
||||
log.debug("Threshold:${r.gpm}, Value:${gpm}")
|
||||
if(gpm > r.gpm)
|
||||
{
|
||||
sendNotification(childAppID, gpm)
|
||||
if(r.dev)
|
||||
{
|
||||
//log.debug("Child App: ${childAppID}")
|
||||
def activityApp = getChildById(childAppID)
|
||||
activityApp.devAction(r.command)
|
||||
}
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Time Period":
|
||||
log.debug("Time Period Test: ${r}")
|
||||
def boolTime = timeOfDayIsBetween(r.startTime, r.endTime, new Date(), location.timeZone)
|
||||
def boolDay = !r.days || findIn(r.days, dowName) // Truth Table of this mess: http://swiftlet.technology/wp-content/uploads/2016/05/IMG_20160523_150600.jpg
|
||||
def boolMode = !r.modes || findIn(r.modes, location.currentMode)
|
||||
|
||||
if(boolTime && boolDay && boolMode)
|
||||
{
|
||||
if(gpm > r.gpm)
|
||||
{
|
||||
sendNotification(childAppID, gpm)
|
||||
if(r.dev)
|
||||
{
|
||||
def activityApp = getChildById(childAppID)
|
||||
activityApp.devAction(r.command)
|
||||
}
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Accumulated Flow":
|
||||
log.debug("Accumulated Flow Test: ${r}")
|
||||
def boolTime = timeOfDayIsBetween(r.startTime, r.endTime, new Date(), location.timeZone)
|
||||
def boolDay = !r.days || findIn(r.days, dowName) // Truth Table of this mess: http://swiftlet.technology/wp-content/uploads/2016/05/IMG_20160523_150600.jpg
|
||||
def boolMode = !r.modes || findIn(r.modes, location.currentMode)
|
||||
|
||||
if(boolTime && boolDay && boolMode)
|
||||
{
|
||||
def delta = 0
|
||||
if(state["accHistory${childAppID}"] != null)
|
||||
{
|
||||
delta = cumulative - state["accHistory${childAppID}"]
|
||||
}
|
||||
else
|
||||
{
|
||||
state["accHistory${childAppID}"] = cumulative
|
||||
}
|
||||
log.debug("Currently in specified time, delta from beginning of time period: ${delta}")
|
||||
|
||||
if(delta > r.gallons)
|
||||
{
|
||||
sendNotification(childAppID, delta)
|
||||
if(r.dev)
|
||||
{
|
||||
def activityApp = getChildById(childAppID)
|
||||
activityApp.devAction(r.command)
|
||||
}
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
log.debug("Outside specified time, saving value")
|
||||
state["accHistory${childAppID}"] = cumulative
|
||||
}
|
||||
break
|
||||
|
||||
case "Continuous Flow":
|
||||
log.debug("Continuous Flow Test: ${r}")
|
||||
def contMinutes = 0
|
||||
def boolMode = !r.modes || findIn(r.modes, location.currentMode)
|
||||
|
||||
if(gpm != 0)
|
||||
{
|
||||
if(state["contHistory${childAppID}"] == [])
|
||||
{
|
||||
state["contHistory${childAppID}"] = new Date()
|
||||
}
|
||||
else
|
||||
{
|
||||
//def td = now() - Date.parse("yyyy-MM-dd'T'HH:mm:ss'Z'", state["contHistory${childAppID}"]).getTime()
|
||||
//log.debug(state["contHistory${childAppID}"])
|
||||
//def historyDate = new Date(state["contHistory${childAppID}"])
|
||||
def historyDate = new Date().parse("yyyy-MM-dd'T'HH:mm:ssZ", state["contHistory${childAppID}"])
|
||||
def td = now() - historyDate.getTime()
|
||||
//log.debug("Now minus then: ${td}")
|
||||
contMinutes = td/60000
|
||||
log.debug("Minutes of constant flow: ${contMinutes}, since ${state["contHistory${childAppID}"]}")
|
||||
}
|
||||
}
|
||||
|
||||
if(contMinutes > r.flowMinutes && boolMode)
|
||||
{
|
||||
sendNotification(childAppID, Math.round(contMinutes))
|
||||
if(r.dev)
|
||||
{
|
||||
def activityApp = getChildById(childAppID)
|
||||
activityApp.devAction(r.command)
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Water Valve Status":
|
||||
log.debug("Water Valve Test: ${r}")
|
||||
def child = getChildById(childAppID)
|
||||
//log.debug("Water Valve Child App: ${child.id}")
|
||||
if(child.isValveStatus(r.valveStatus))
|
||||
{
|
||||
if(gpm > r.gpm)
|
||||
{
|
||||
sendNotification(childAppID, gpm)
|
||||
}
|
||||
}
|
||||
break
|
||||
|
||||
case "Switch Status":
|
||||
break
|
||||
|
||||
default:
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def gpmHandler(evt) {
|
||||
//Date Stuff
|
||||
def daysOfTheWeek = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
|
||||
def today = new Date()
|
||||
today.clearTime()
|
||||
Calendar c = Calendar.getInstance();
|
||||
c.setTime(today);
|
||||
int dow = c.get(Calendar.DAY_OF_WEEK);
|
||||
def dowName = daysOfTheWeek[dow-1]
|
||||
|
||||
def gpm = evt.value
|
||||
def cumulative = meter.latestValue("cumulative")
|
||||
log.debug "GPM Handler: [gpm: ${gpm}, cumulative: ${cumulative}]"
|
||||
def rules = state.rules
|
||||
rules.each { it ->
|
||||
def r = it.rules
|
||||
def childAppID = it.id
|
||||
switch (r.type) {
|
||||
|
||||
// This is down here because "cumulative" never gets sent in the case of 0 change between messages
|
||||
case "Continuous Flow":
|
||||
log.debug("Continuous Flow Test (GPM): ${r}")
|
||||
def contMinutes = 0
|
||||
|
||||
if(gpm == "0.0")
|
||||
{
|
||||
state["contHistory${childAppID}"] = []
|
||||
}
|
||||
//log.debug("contHistory${childAppID} is ${state["contHistory${childAppID}"]}")
|
||||
break
|
||||
|
||||
default:
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
def sendNotification(device, gpm)
|
||||
{
|
||||
def set = getChildById(device).settings()
|
||||
def msg = ""
|
||||
if(set.type == "Accumulated Flow")
|
||||
{
|
||||
msg = "Water Flow Warning: \"${set.ruleName}\" is over threshold at ${gpm} gallons"
|
||||
}
|
||||
else if(set.type == "Continuous Flow")
|
||||
{
|
||||
msg = "Water Flow Warning: \"${set.ruleName}\" is over threshold at ${gpm} minutes"
|
||||
}
|
||||
else
|
||||
{
|
||||
msg = "Water Flow Warning: \"${set.ruleName}\" is over threshold at ${gpm}gpm"
|
||||
}
|
||||
log.debug(msg)
|
||||
|
||||
// Only send notifications as often as the user specifies
|
||||
def lastNotification = 0
|
||||
if(state["notificationHistory${device}"])
|
||||
{
|
||||
lastNotification = Date.parse("yyyy-MM-dd'T'HH:mm:ssZ", state["notificationHistory${device}"]).getTime()
|
||||
}
|
||||
def td = now() - lastNotification
|
||||
log.debug("Last Notification at ${state["notificationHistory${device}"]}... ${td/(60*1000)} minutes")
|
||||
if(td/(60*1000) > minutesBetweenNotifications.value)
|
||||
{
|
||||
log.debug("Sending Notification")
|
||||
if (pushNotification)
|
||||
{
|
||||
sendPush(msg)
|
||||
state["notificationHistory${device}"] = new Date()
|
||||
}
|
||||
if (smsNotification)
|
||||
{
|
||||
sendSms(phone, msg)
|
||||
state["notificationHistory${device}"] = new Date()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def getChildById(app)
|
||||
{
|
||||
return childApps.find{ it.id == app }
|
||||
}
|
||||
|
||||
def findIn(haystack, needle)
|
||||
{
|
||||
def result = false
|
||||
haystack.each { it ->
|
||||
//log.debug("findIn: ${it} <- ${needle}")
|
||||
if (needle == it)
|
||||
{
|
||||
//log.debug("Found needle in haystack")
|
||||
result = true
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
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