Compare commits

..

1 Commits

2 changed files with 204 additions and 439 deletions

View File

@@ -1,439 +0,0 @@
/**
* FortrezZ Flow Meter Interface
*
* Copyright 2016 FortrezZ, LLC
*
* 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: "FortrezZ Flow Meter Interface", namespace: "fortrezz", author: "Daniel Kurin") {
capability "Battery"
capability "Energy Meter"
capability "Image Capture"
capability "Temperature Measurement"
capability "Sensor"
capability "Water Sensor"
attribute "gpm", "number"
attribute "cumulative", "number"
attribute "alarmState", "string"
attribute "chartMode", "string"
attribute "lastThreshhold", "number"
command "chartMode"
command "zero"
command "setHighFlowLevel", ["number"]
fingerprint deviceId: "0x2101", inClusters: "0x5E, 0x86, 0x72, 0x5A, 0x73, 0x71, 0x85, 0x59, 0x32, 0x31, 0x70, 0x80, 0x7A"
}
simulator {
// TODO: define status and reply messages here
}
preferences {
input "gallonThreshhold", "decimal", title: "High Flow Rate Threshhold", description: "Flow rate (in gpm) that will trigger a notification.", defaultValue: 5, required: false, displayDuringSetup: true
input("registerEmail", type: "email", required: false, title: "Email Address", description: "Register your device with FortrezZ", displayDuringSetup: true)
}
tiles(scale: 2) {
carouselTile("flowHistory", "device.image", width: 6, height: 3) { }
valueTile("battery", "device.battery", inactiveLabel: false, width: 2, height: 2) {
state "battery", label:'${currentValue}%\nBattery', unit:""
}
valueTile("temperature", "device.temperature", 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("gpm", "device.gpm", inactiveLabel: false, width: 2, height: 2) {
state "gpm", label:'${currentValue}gpm', unit:""
}
standardTile("powerState", "device.powerState", width: 2, height: 2) {
state "reconnected", icon:"http://swiftlet.technology/wp-content/uploads/2016/02/Connected-64.png", backgroundColor:"#cccccc"
state "disconnected", icon:"http://swiftlet.technology/wp-content/uploads/2016/02/Disconnected-64.png", backgroundColor:"#cc0000"
state "batteryReplaced", icon:"http://swiftlet.technology/wp-content/uploads/2016/04/Full-Battery-96.png", backgroundColor:"#cccccc"
state "noBattery", icon:"http://swiftlet.technology/wp-content/uploads/2016/04/No-Battery-96.png", backgroundColor:"#cc0000"
}
standardTile("waterState", "device.waterState", width: 2, height: 2, canChangeIcon: true) {
state "none", icon:"http://cdn.device-icons.smartthings.com/Weather/weather12-icn@2x.png", backgroundColor:"#cccccc", label: "No Flow"
state "flow", icon:"http://cdn.device-icons.smartthings.com/Weather/weather12-icn@2x.png", backgroundColor:"#53a7c0", label: "Flow"
state "overflow", icon:"http://cdn.device-icons.smartthings.com/Weather/weather12-icn@2x.png", backgroundColor:"#cc0000", label: "High Flow"
}
standardTile("heatState", "device.heatState", width: 2, height: 2) {
state "normal", label:'Normal', icon:"st.alarm.temperature.normal", backgroundColor:"#ffffff"
state "freezing", label:'Freezing', icon:"st.alarm.temperature.freeze", backgroundColor:"#2eb82e"
state "overheated", label:'Overheated', icon:"st.alarm.temperature.overheat", backgroundColor:"#F80000"
}
standardTile("take1", "device.image", width: 2, height: 2, canChangeIcon: false, inactiveLabel: true, canChangeBackground: false, decoration: "flat") {
state "take", label: "", action: "Image Capture.take", nextState:"taking", icon: "st.secondary.refresh"
}
standardTile("chartMode", "device.chartMode", width: 2, height: 2, canChangeIcon: false, canChangeBackground: false, decoration: "flat") {
state "day", label:'24 Hours\n(press to change)', nextState: "week", action: 'chartMode'
state "week", label:'7 Days\n(press to change)', nextState: "month", action: 'chartMode'
state "month", label:'4 Weeks\n(press to change)', nextState: "day", action: 'chartMode'
}
valueTile("zeroTile", "device.zero", width: 2, height: 2, canChangeIcon: false, canChangeBackground: false, decoration: "flat") {
state "zero", label:'Zero', action: 'zero'
}
main (["waterState"])
details(["flowHistory", "chartMode", "take1", "temperature", "gpm", "waterState", "battery"])
}
}
// parse events into attributes
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) {
results << createEvent( zwaveEvent(cmd) )
}
}
//log.debug "\"$description\" parsed to ${results.inspect()}"
if(gallonThreshhold != device.currentValue("lastThreshhold"))
{
results << setThreshhold(gallonThreshhold)
}
log.debug "zwave parsed to ${results.inspect()}"
return results
}
def updated()
{
log.debug("Updated")
}
def setHighFlowLevel(level)
{
setThreshhold(level)
}
def take() {
def mode = device.currentValue("chartMode")
if(mode == "day")
{
take1()
}
else if(mode == "week")
{
take7()
}
else if(mode == "month")
{
take28()
}
}
def chartMode(string) {
log.debug("ChartMode")
def state = device.currentValue("chartMode")
def tempValue = ""
switch(state)
{
case "day":
tempValue = "week"
break
case "week":
tempValue = "month"
break
case "month":
tempValue = "day"
break
default:
tempValue = "day"
break
}
sendEvent(name: "chartMode", value: tempValue)
take()
}
def take1() {
api("24hrs", "") {
log.debug("Image captured")
if(it.headers.'Content-Type'.contains("image/png")) {
if(it.data) {
storeImage(getPictureName("24hrs"), it.data)
}
}
}
}
def take7() {
api("7days", "") {
log.debug("Image captured")
if(it.headers.'Content-Type'.contains("image/png")) {
if(it.data) {
storeImage(getPictureName("7days"), it.data)
}
}
}
}
def take28() {
api("4weeks", "") {
log.debug("Image captured")
if(it.headers.'Content-Type'.contains("image/png")) {
if(it.data) {
storeImage(getPictureName("4weeks"), it.data)
}
}
}
}
def zero()
{
delayBetween([
zwave.meterV3.meterReset().format(),
zwave.meterV3.meterGet().format(),
zwave.firmwareUpdateMdV2.firmwareMdGet().format(),
], 100)
}
def zwaveEvent(physicalgraph.zwave.commands.sensormultilevelv5.SensorMultilevelReport cmd)
{
log.debug cmd
def map = [:]
if(cmd.sensorType == 1) {
map = [name: "temperature"]
if(cmd.scale == 0) {
map.value = getTemperature(cmd.scaledSensorValue)
} else {
map.value = cmd.scaledSensorValue
}
map.unit = location.temperatureScale
} /* else if(cmd.sensorType == 2) {
map = [name: "waterState"]
if(cmd.sensorValue[0] == 0x80) {
map.value = "flow"
sendEvent(name: "water", value: "dry")
} else if(cmd.sensorValue[0] == 0x00) {
map.value = "none"
sendEvent(name: "water", value: "dry")
} else if(cmd.sensorValue[0] == 0xFF) {
map.value = "overflow"
sendEvent(name: "water", value: "wet")
sendAlarm("waterOverflow")
}
} */
return map
}
def zwaveEvent(physicalgraph.zwave.commands.meterv3.MeterReport cmd)
{
def map = [:]
map.name = "gpm"
def delta = cmd.scaledMeterValue - cmd.scaledPreviousMeterValue
if (delta < 0 || delta > 10000) {
log.error(cmd)
delta = 0
}
map.value = delta
map.unit = "gpm"
sendDataToCloud(delta)
sendEvent(name: "cumulative", value: cmd.scaledMeterValue, displayed: false, unit: "gal")
return map
}
def zwaveEvent(physicalgraph.zwave.commands.alarmv2.AlarmReport cmd)
{
def map = [:]
if (cmd.zwaveAlarmType == 8) // Power Alarm
{
map.name = "powerState" // For Tile (shows in "Recently")
if (cmd.zwaveAlarmEvent == 2) // AC Mains Disconnected
{
map.value = "disconnected"
sendAlarm("acMainsDisconnected")
}
else if (cmd.zwaveAlarmEvent == 3) // AC Mains Reconnected
{
map.value = "reconnected"
sendAlarm("acMainsReconnected")
}
else if (cmd.zwaveAlarmEvent == 0x0B) // Replace Battery Now
{
map.value = "noBattery"
sendAlarm("replaceBatteryNow")
}
else if (cmd.zwaveAlarmEvent == 0x00) // Battery Replaced
{
map.value = "batteryReplaced"
sendAlarm("batteryReplaced")
}
}
else if (cmd.zwaveAlarmType == 4) // Heat Alarm
{
map.name = "heatState"
if (cmd.zwaveAlarmEvent == 0) // Normal
{
map.value = "normal"
}
else if (cmd.zwaveAlarmEvent == 1) // Overheat
{
map.value = "overheated"
sendAlarm("tempOverheated")
}
else if (cmd.zwaveAlarmEvent == 5) // Underheat
{
map.value = "freezing"
sendAlarm("tempFreezing")
}
}
else if (cmd.zwaveAlarmType == 5) // Water Alarm
{
map.name = "waterState"
if (cmd.zwaveAlarmEvent == 0) // Normal
{
map.value = "none"
sendEvent(name: "water", value: "dry")
}
else if (cmd.zwaveAlarmEvent == 6) // Flow Detected
{
if(cmd.eventParameter[0] == 2)
{
map.value = "flow"
sendEvent(name: "water", value: "dry")
}
else if(cmd.eventParameter[0] == 3)
{
map.value = "overflow"
sendAlarm("waterOverflow")
sendEvent(name: "water", value: "wet")
}
}
}
//log.debug "alarmV2: $cmd"
return map
}
def zwaveEvent(physicalgraph.zwave.commands.batteryv1.BatteryReport cmd) {
def map = [:]
if(cmd.batteryLevel == 0xFF) {
map.name = "battery"
map.value = 1
map.descriptionText = "${device.displayName} has a low battery"
map.displayed = true
} else {
map.name = "battery"
map.value = cmd.batteryLevel > 0 ? cmd.batteryLevel.toString() : 1
map.unit = "%"
map.displayed = false
}
return map
}
def zwaveEvent(physicalgraph.zwave.Command cmd)
{
log.debug "COMMAND CLASS: $cmd"
}
def sendDataToCloud(double data)
{
def params = [
uri: "https://iot.swiftlet.technology",
path: "/fortrezz/post.php",
body: [
id: device.id,
value: data,
email: registerEmail
]
]
//log.debug("POST parameters: ${params}")
try {
httpPostJson(params) { resp ->
resp.headers.each {
//log.debug "${it.name} : ${it.value}"
}
log.debug "sendDataToCloud query response: ${resp.data}"
}
} catch (e) {
log.debug "something went wrong: $e"
}
}
def getTemperature(value) {
if(location.temperatureScale == "C"){
return value
} else {
return Math.round(celsiusToFahrenheit(value))
}
}
private getPictureName(category) {
//def pictureUuid = device.id.toString().replaceAll('-', '')
def pictureUuid = java.util.UUID.randomUUID().toString().replaceAll('-', '')
def name = "image" + "_$pictureUuid" + "_" + category + ".png"
return name
}
def api(method, args = [], success = {}) {
def methods = [
//"snapshot": [uri: "http://${ip}:${port}/snapshot.cgi${login()}&${args}", type: "post"],
"24hrs": [uri: "https://iot.swiftlet.technology/fortrezz/chart.php?uuid=${device.id}&tz=${location.timeZone.ID}&type=1", type: "get"],
"7days": [uri: "https://iot.swiftlet.technology/fortrezz/chart.php?uuid=${device.id}&tz=${location.timeZone.ID}&type=2", type: "get"],
"4weeks": [uri: "https://iot.swiftlet.technology/fortrezz/chart.php?uuid=${device.id}&tz=${location.timeZone.ID}&type=3", type: "get"],
]
def request = methods.getAt(method)
return doRequest(request.uri, request.type, success)
}
private doRequest(uri, type, success) {
log.debug(uri)
if(type == "post") {
httpPost(uri , "", success)
}
else if(type == "get") {
httpGet(uri, success)
}
}
def sendAlarm(text)
{
sendEvent(name: "alarmState", value: text, descriptionText: text, displayed: false)
}
def setThreshhold(rate)
{
log.debug "Setting Threshhold to ${rate}"
def event = createEvent(name: "lastThreshhold", value: rate, displayed: false)
def cmds = []
cmds << zwave.configurationV2.configurationSet(configurationValue: [(int)Math.round(rate*10)], parameterNumber: 5, size: 1).format()
sendEvent(event)
return response(cmds) // return a list containing the event and the result of response()
}

View File

@@ -0,0 +1,204 @@
/**
* FortrezZ Flow Meter Interface
*
* Copyright 2016 FortrezZ, LLC
*
* 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.
*
* Based on Todd Wackford's MimoLite Garage Door Opener
*/
metadata {
// Automatically generated. Make future change here.
definition (name: "FortrezZ MIMOlite", namespace: "fortrezz", author: "FortrezZ, LLC") {
capability "Configuration"
capability "Switch"
capability "Refresh"
capability "Contact Sensor"
capability "Voltage Measurement"
attribute "powered", "string"
command "on"
command "off"
fingerprint deviceId: "0x1000", inClusters: "0x72,0x86,0x71,0x30,0x31,0x35,0x70,0x85,0x25,0x03"
}
simulator {
// Simulator stuff
}
preferences {
input "RelaySwitchDelay", "decimal", title: "Delay between relay switch on and off in seconds. Only Numbers 0 to 3.0 allowed. 0 value will remove delay and allow relay to function as a standard switch", description: "Numbers 0 to 3.1 allowed.", defaultValue: 0, required: false, displayDuringSetup: true
}
// UI tile definitions
tiles (scale: 2) {
standardTile("switch", "device.switch", width: 4, height: 4, canChangeIcon: false, decoration: "flat") {
state "on", label: "On", action: "off", icon: "http://swiftlet.technology/wp-content/uploads/2016/06/Switch-On-104-edit.png", backgroundColor: "#53a7c0"
state "off", label: 'Off', action: "on", icon: "http://swiftlet.technology/wp-content/uploads/2016/06/Switch-Off-104-edit.png", backgroundColor: "#ffffff"
}
standardTile("contact", "device.contact", width: 2, height: 2, inactiveLabel: false) {
state "open", label: '${name}', icon: "st.contact.contact.open", backgroundColor: "#ffa81e"
state "closed", label: '${name}', icon: "st.contact.contact.closed", backgroundColor: "#79b821"
}
standardTile("refresh", "device.switch", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
state "default", label:'', action:"refresh.refresh", icon:"st.secondary.refresh"
}
standardTile("powered", "device.powered", width: 2, height: 2, inactiveLabel: false) {
state "powerOn", label: "Power On", icon: "st.switches.switch.on", backgroundColor: "#79b821"
state "powerOff", label: "Power Off", icon: "st.switches.switch.off", backgroundColor: "#ffa81e"
}
standardTile("configure", "device.configure", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
state "configure", label:'', action:"configuration.configure", icon:"st.secondary.configure"
}
valueTile("voltage", "device.voltage", width: 2, height: 2) {
state "val", label:'${currentValue}v', unit:"", defaultState: true
}
valueTile("voltageCounts", "device.voltageCounts", width: 2, height: 2) {
state "val", label:'${currentValue}', unit:"", defaultState: true
}
main (["switch"])
details(["switch", "contact", "voltage", "powered", "refresh","configure"])
}
}
def parse(String description) {
//log.debug "description is: ${description}"
def result = null
def cmd = zwave.parse(description, [0x20: 1, 0x84: 1, 0x30: 1, 0x70: 1, 0x31: 5])
//log.debug "command value is: $cmd.CMD"
if (cmd.CMD == "7105") { //Mimo sent a power loss report
log.debug "Device lost power"
sendEvent(name: "powered", value: "powerOff", descriptionText: "$device.displayName lost power")
} else {
sendEvent(name: "powered", value: "powerOn", descriptionText: "$device.displayName regained power")
}
//log.debug "${device.currentValue('contact')}" // debug message to make sure the contact tile is working
if (cmd) {
result = createEvent(zwaveEvent(cmd))
}
log.debug "Parse returned ${result?.descriptionText} $cmd.CMD"
return result
}
def updated() {
log.debug "Settings Updated..."
configure()
}
//notes about zwaveEvents:
// these are special overloaded functions which MUST be returned with a map similar to (return [name: "switch", value: "on"])
// not doing so will produce a null on the parse function, this will mess you up in the future.
// Perhaps can use 'createEvent()' and return that as long as a map is inside it.
def zwaveEvent(physicalgraph.zwave.commands.switchbinaryv1.SwitchBinaryReport cmd) {
log.debug "switchBinaryReport ${cmd}"
if (cmd.value) // if the switch is on it will not be 0, so on = true
{
return [name: "switch", value: "on"] // change switch value to on
}
else // if the switch sensor report says its off then do...
{
return [name: "switch", value: "off"] // change switch value to off
}
}
// working on next for the analogue and digital stuff.
def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicSet cmd) // basic set is essentially our digital sensor for SIG1
{
log.debug "sent a BasicSet command"
//refresh()
delayBetween([zwave.sensorMultilevelV5.sensorMultilevelGet().format()])// requests a report of the anologue input voltage
[name: "contact", value: cmd.value ? "open" : "closed"]}
//[name: "contact", value: cmd.value ? "open" : "closed", type: "digital"]}
def zwaveEvent(physicalgraph.zwave.commands.sensorbinaryv1.SensorBinaryReport cmd)
{
log.debug "sent a sensorBinaryReport command"
refresh()
[name: "contact", value: cmd.value ? "open" : "closed"]
}
def zwaveEvent (physicalgraph.zwave.commands.sensormultilevelv5.SensorMultilevelReport cmd) // sensorMultilevelReport is used to report the value of the analog voltage for SIG1
{
log.debug "sent a SensorMultilevelReport"
def ADCvalue = cmd.scaledSensorValue
sendEvent(name: "voltageCounts", value: ADCvalue)
CalculateVoltage(cmd.scaledSensorValue)
}
def zwaveEvent(physicalgraph.zwave.Command cmd) {
// Handles all Z-Wave commands we aren't interested in
log.debug("Un-parsed Z-Wave message ${cmd}")
[:]
}
def CalculateVoltage(ADCvalue)
{
def map = [:]
def volt = (((1.5338*(10**-16))*(ADCvalue**5)) - ((1.2630*(10**-12))*(ADCvalue**4)) + ((3.8111*(10**-9))*(ADCvalue**3)) - ((4.7739*(10**-6))*(ADCvalue**2)) + ((2.8558*(10**-3))*(ADCvalue)) - (2.2721*(10**-2)))
//def volt = (((3.19*(10**-16))*(ADCvalue**5)) - ((2.18*(10**-12))*(ADCvalue**4)) + ((5.47*(10**-9))*(ADCvalue**3)) - ((5.68*(10**-6))*(ADCvalue**2)) + (0.0028*ADCvalue) - (0.0293))
//log.debug "$cmd.scale $cmd.precision $cmd.size $cmd.sensorType $cmd.sensorValue $cmd.scaledSensorValue"
def voltResult = volt.round(1)// + "v"
map.name = "voltage"
map.value = voltResult
map.unit = "v"
return map
}
def configure() {
def x = (RelaySwitchDelay*10).toInteger()
log.debug "Configuring.... " //setting up to monitor power alarm and actuator duration
delayBetween([
zwave.associationV1.associationSet(groupingIdentifier:3, nodeId:[zwaveHubNodeId]).format(), // FYI: Group 3: If a power dropout occurs, the MIMOlite will send an Alarm Command Class report
// (if there is enough available residual power)
zwave.associationV1.associationSet(groupingIdentifier:2, nodeId:[zwaveHubNodeId]).format(), // periodically send a multilevel sensor report of the ADC analog voltage to the input
zwave.associationV1.associationSet(groupingIdentifier:4, nodeId:[zwaveHubNodeId]).format(), // when the input is digitally triggered or untriggered, snd a binary sensor report
zwave.configurationV1.configurationSet(configurationValue: [x], parameterNumber: 11, size: 1).format() // configurationValue for parameterNumber means how many 100ms do you want the relay
// to wait before it cycles again / size should just be 1 (for 1 byte.)
//zwave.configurationV1.configurationGet(parameterNumber: 11).format() // gets the new parameter changes. not currently needed. (forces a null return value without a zwaveEvent funciton
])
}
def on() {
delayBetween([
zwave.basicV1.basicSet(value: 0xFF).format(), // physically changes the relay from on to off and requests a report of the relay
refresh()// to make sure that it changed (the report is used elsewhere, look for switchBinaryReport()
])
}
def off() {
delayBetween([
zwave.basicV1.basicSet(value: 0x00).format(), // physically changes the relay from on to off and requests a report of the relay
refresh()// to make sure that it changed (the report is used elsewhere, look for switchBinaryReport()
])
}
def refresh() {
log.debug "REFRESH!"
delayBetween([
zwave.switchBinaryV1.switchBinaryGet().format(), //requests a report of the relay to make sure that it changed (the report is used elsewhere, look for switchBinaryReport()
zwave.sensorMultilevelV5.sensorMultilevelGet().format()// requests a report of the anologue input voltage
])
}