Compare commits

..

3 Commits

Author SHA1 Message Date
Matt Miskinnis
c1f91f42db MSA-1677: Not sure what to put here... 2016-12-28 08:54:33 -08:00
Jack Chi
5b874e8f3a Merge pull request #1545 from pchomal/dimmerswitch_generic
[CHF-477] Health Check for Z-Wave Dimmer Switch Generic
2016-12-27 11:36:51 -08:00
piyush.c
5b1da30a47 [CHF-477]
Health Check implementation for Z-Wave Dimmer Switch Generic with checkinterval of 32min
2016-12-20 10:39:08 +05:30
3 changed files with 627 additions and 486 deletions

View File

@@ -1,486 +0,0 @@
/**
* Qubino Weatherstation
* Device Handler
* Version 1.0
* Date: 16.12.2016
* Author: Kristjan Jamšek (Kjamsek), Goap d.o.o.
* Copyright 2016 Kristjan Jamšek
*
* 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.
*
* - DEVICE HANDLER FOR QUBINO WEATHERSTATION Z-WAVE DEVICE -
* The handler supports all unsecure functions of the Qubino Weatherstation device. Configuration parameters and
* association groups can be set in the device's preferences screen, but they are applied on the device only after
* pressing the 'Set configuration' and 'Set associations' buttons on the bottom of the details view.
*
* This device handler supports data values that are currently not implemented as capabilities, so custom attribute
* states are used. Please use a SmartApp that supports custom attribute monitoring with this device in your rules.
* By default the 'Temperature Measurement' and 'Relative Humidity Measurement' capability states are mirrored from
* the custom attribute state values 'temperatureCh1' and 'humidityCh1'.
*
* This device handler uses hubAction in configure() method in order to set a MultiChannel Lifeline association to the
* device, so reports from all endpoints can be received.
*
*
* CHANGELOG:
* 0.99: Final release code cleanup and commenting
* 1.00: Added comments to code for readability
*/
metadata {
definition (name: "Qubino Weatherstation", namespace: "Goap", author: "Kristjan Jamšek") {
capability "Configuration" //Needed for configure() function to set MultiChannel Lifeline Association Set
capability "Temperature Measurement" //Used on main tile, needed in order to have the device appear in capabilities lists, mirrors temperatureCh1 attribute states
capability "Relative Humidity Measurement" //Needed in order to have the device appear in capabilities lists, mirrors humidityCh1 attribute states
capability "Sensor" // - Tagging capability
attribute "temperatureCh1", "number" // temperature attribute for Ch1 Temperature reported by device's endpoint 1
attribute "windDirection", "number" // wind direction attribute for Wind Gauge - Direction reported by device's endpoint 2
attribute "windVelocity", "number" // wind velocity attribute for Wind Gauge - Velocity reported by device's endpoint 3
attribute "windGust", "number" // wind gust velocity attribute for Wind Gauge - Wind gust reported by device's endpoint 4
attribute "windTemperature", "number" // wind temperature attribute for Wind Gauge - Temperature reported by device's endpoint 5
attribute "windChillTemperature", "number" // wind chill temperature attribute for Wind Gauge - Wind Chill reported by device's endpoint 6
attribute "rainRate", "number" // rain rate attribute for Rain Sensor data reported by device's endpoint 7
attribute "humidityCh1", "number" // humidity attribute for Ch1 Humidity reported by device's endpoint 8
attribute "temperatureCh2", "number" // temperature attribute for Ch2 Temperature reported by device's endpoint 9
attribute "humidityCh2", "number" // humidity attribute for Ch2 Humidity reported by device's endpoint 10
attribute "setConfigParams", "string" // attribute for tile element for setConfigurationParams command
attribute "setAssocGroups", "string" // attribute for tile element for setAssociations command
command "setConfigurationParams" // command to issue Configuration Set command sequence according to user's preferences
command "setAssociations" // command to issue Association Set command sequence according to user's preferences
fingerprint mfr:"0159", prod:"0007", model:"0053" //Manufacturer Information values for Qubino Weatherstation
}
simulator {
// TESTED WITH PHYSICAL DEVICE - UNNEEDED
}
tiles(scale: 2) {
valueTile("temperature", "device.temperature") {
state("temperature", label:'${currentValue} °', unit:"°", icon: "st.Weather.weather2", backgroundColors: [
// Celsius Color Range
[value: 0, color: "#153591"],
[value: 7, color: "#1e9cbb"],
[value: 15, color: "#90d2a7"],
[value: 23, color: "#44b621"],
[value: 29, color: "#f1d801"],
[value: 33, color: "#d04e00"],
[value: 36, color: "#bc2323"],
// Fahrenheit Color Range
[value: 40, color: "#153591"],
[value: 44, color: "#1e9cbb"],
[value: 59, color: "#90d2a7"],
[value: 74, color: "#44b621"],
[value: 84, color: "#f1d801"],
[value: 92, color: "#d04e00"],
[value: 96, color: "#bc2323"]
])
}
valueTile("humidity", "device.humidity") {
state("humidity", label:'${currentValue} %', unit:"%", display:false)
}
standardTile("temperatureCh1", "device.temperatureCh1", width: 3, height: 3) {
state("temperatureCh1", label:'Temperature Ch1: ${currentValue} °', unit:'°', icon: 'st.Weather.weather2')
}
standardTile("windDirection", "device.windDirection", width: 3, height: 3) {
state("windDirection", label:'Wind Direction: ${currentValue} °', unit: "°", icon: 'st.Outdoor.outdoor20')
}
standardTile("windVelocity", "device.windVelocity", width: 3, height: 3) {
state("windVelocity", label:'Wind Velocity: ${currentValue} m/s', unit:"m/s", icon: 'st.Weather.weather1')
}
standardTile("windGust", "device.windGust", width: 3, height: 3) {
state("windGust", label:'Wind Gust: ${currentValue} m/s', unit:"m/s", icon: 'st.Weather.weather1')
}
standardTile("windTemperature", "device.windTemperature", width: 3, height: 3) {
state("windTemperature", label:'Wind Temperature: ${currentValue} °', unit:'°', icon: 'st.Weather.weather2')
}
standardTile("windChillTemperature", "device.windChillTemperature", width: 3, height: 3) {
state("windChillTemperature", label:'Wind Chill: ${currentValue} °', unit:'°', icon: 'st.Weather.weather2')
}
standardTile("rainRate", "device.rainRate", width: 3, height: 3) {
state("rainRate", label:'Rain Sensor: ${currentValue} mm/h', unit:"mm/h", icon: 'st.Weather.weather10')
}
standardTile("humidityCh1", "device.humidityCh1", width: 3, height: 3) {
state("humidityCh1", label:'Humidity Ch1: ${currentValue} %', unit:"%", icon: 'st.Weather.weather12')
}
standardTile("temperatureCh2", "device.temperatureCh2", width: 3, height: 3) {
state("temperatureCh2", label:'Temperature Ch2: ${currentValue} °', unit:'°', icon: 'st.Weather.weather2')
}
standardTile("humidityCh2", "device.humidityCh2", width: 3, height: 3) {
state("humidityCh2", label:'Humidity Ch2: ${currentValue} %', unit:"%", icon: 'st.Weather.weather12')
}
standardTile("setConfigParams", "device.setConfigParams", decoration: "flat", width: 3, height: 3) {
state("setConfigParams", label:'Set configuration', action:'setConfigurationParams', icon: "st.secondary.tools")
}
standardTile("setAssocGroups", "device.setAssocGroups", decoration: "flat", width: 3, height: 3) {
state("setAssocGroups", label:'Set associations', action:'setAssociations', icon: "st.secondary.tools")
}
main("temperature")
details(["temperatureCh1", "humidityCh1", "windDirection", "windVelocity", "windGust", "windTemperature", "windChillTemperature", "rainRate", "temperatureCh2", "humidityCh2", "setConfigParams", "setAssocGroups"])
}
preferences {
/**
* -------- CONFIGURATION PARAMETER SECTION --------
*/
input name: "param1", type: "number", range: "0..8800", required: false,
title: "1. Wind Gauge, Wind Gust Top Value. " +
"If the Wind Gust is higher than the parameter value, the device triggers an association.\n" +
"Available settings:\n" +
"0 ... 8800 = value from 0,00 m/s to 88,00 m/s,\n" +
"Default value: 1000 (10,00 m/s)."
input name: "param2", type: "number", range: "0..30000", required: false,
title: "2. Rain Gauge, Rain Rate Top Value. " +
"If the Rain Sensor Rain Rate is higher than the parameter value, the device triggers an association.\n" +
"Available settings:\n" +
"0 ... 30000 = value from 0,00 mm/h to 300,00 mm/h,\n" +
"Default value: 200 (2,00 mm/h)."
input name: "param3", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "3. Wind Gauge, Wind Gust. " +
"Available settings:\n" +
"0 = If the Wind Gust is higher than the parameter number 1 value, then the device sends a Basic Set 0x00,\n" +
"1 = If the Wind Gust is higher than the parameter number 1 value, then the device sends a Basic Set 0xFF,\n" +
"Default value: 1."
input name: "param4", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "4. Rain Gauge, Rain Rate. " +
"Available settings:\n" +
"0 = If the Rain Rate is higher than the parameter number 2 value, then the device sends a Basic Set 0x00,\n" +
"1 = If the Rain Rate is higher than the parameter number 2 value, then the device sends a Basic Set 0xFF,\n" +
"Default value: 1."
input name: "param5", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "5. Endpoint 1 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param6", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "6. Endpoint 2 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param7", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "7. Endpoint 3 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param8", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "8. Endpoint 4 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param9", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "9. Endpoint 5 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param10", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "10. Endpoint 6 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param11", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "11. Endpoint 7 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param12", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "12. Endpoint 8 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param13", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "13. Endpoint 9 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param14", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "14. Endpoint 10 - Unsolicited Report enable/disable. " +
"Available settings:\n" +
"0 = Unsolicited Report disabled,\n" +
"1 = Unsolicited Report enabled,\n" +
"Default value: 1."
input name: "param15", type: "enum", required: false,
options: ["0" : "0",
"1" : "1"],
title: "15. Random ID enable/disable " +
"Available settings:\n" +
"0 = Random ID disabled,\n" +
"1 = Random ID enabled,\n" +
"Default value: 0."
/**
* -------- ASSOCIATION GROUP SECTION --------
*/
input name: "assocGroup2", type: "text", required: false,
title: "Association group 2: \n" +
"Basic On/Off command will be sent to associated nodes when the Wind Gust of the Wind Gauge exceeds the Configuration parameter 1 value. \n" +
"NOTE: Insert the node Id value of the devices you wish to associate this group with. Multiple nodeIds can also be set at once by separating individual values by a comma (2,3,...)."
input name: "assocGroup3", type: "text", required: false,
title: "Association group 3: \n" +
"Basic On/Off command will be sent to associated nodes when the Rain Rate exceeds the Configuration parameter 2 value. \n" +
"NOTE: Insert the node Id value of the devices you wish to associate this group with. Multiple nodeIds can also be set at once by separating individual values by a comma (2,3,...)."
}
}
/**
* -------- HELPER METHODS SECTION --------
*/
/**
* Converts a list of String type node id values to Integer type.
*
* @param stringList - a list of String type node id values.
* @return stringList - a list of Integer type node id values.
*/
def convertStringListToIntegerList(stringList){
for(int i=0;i<stringList.size();i++){
stringList[i] = stringList[i].toInteger()
}
return stringList
}
/**
* Converts temperature values to fahrenheit or celsius scales accordign to user's setting.
*
* @param scaleParam user set scale parameter.
* @param encapCmd received temperature parsed value.
* @return String type value of the converted temperature value.
*/
def convertDegrees(scaleParam, encapCmd){
switch (scaleParam) {
default:
break;
case "F":
if(encapCmd.scale == 1){
return encapCmd.scaledSensorValue.toString()
}else{
return (encapCmd.scaledSensorValue * 9 / 5 + 32).toString()
}
break;
case "C":
if(encapCmd.scale == 0){
return encapCmd.scaledSensorValue.toString()
}else{
return (encapCmd.scaledSensorValue * 9 / 5 + 32).toString()
}
break;
}
}
/*
* -------- HANDLE COMMANDS SECTION --------
*/
/**
* Configuration capability command handler that executes after module inclusion to remove existing singlechannel association Lifeline and replace it
* with a multichannel Lifeline association setting for node id 1 and endpoint 1, which enables modules to report multichannel encapsulated frames.
*
* @param void
* @return List of commands that will be executed in sequence with 500 ms delay inbetween.
*/
def configure() {
log.debug "Qubino Weatherstation: configure()"
/** In this method we first clear the association group 1 that is set by SmartThings automatically.
* Afterwards we use physicalgraph.device.HubAction("8E0101000101") as a workaround for SmartThings' MultiChannel Association Command Class implementation,
* where we cannot set a node id and endpoint id. The hardcoded parameter "8E0101000101" should be interpreted in sequence as hexadecimal byte values:
* 8E010100 - Command class and command values, along with the field for singlechannel node id omitted
* 0101 - These two byte values represent the multichannel node id 01 followed by the endpoint id 01 (in general this value can be left as is unless
* multiple subordinated controllers are included in your network. In that case please adjust these two value to the correct id.
*/
def assocCmds = []
assocCmds << zwave.associationV1.associationRemove(groupingIdentifier:1, nodeId:zwaveHubNodeId).format()
assocCmds << new physicalgraph.device.HubAction("8E0101000101")
return delayBetween(assocCmds, 500)
}
/**
* setAssociations command handler that sets user selected association groups. In case no node id is insetred the group is instead cleared.
* Lifeline association hidden from user influence by design.
*
* @param void
* @return List of Association commands that will be executed in sequence with 500 ms delay inbetween.
*/
def setAssociations() {
log.debug "Qubino Weatherstation: setAssociations()"
def assocSet = []
if(settings.assocGroup2 != null){
def group2parsed = settings.assocGroup2.tokenize(",")
group2parsed = convertStringListToIntegerList(group2parsed)
assocSet << zwave.associationV1.associationSet(groupingIdentifier:2, nodeId:group2parsed).format()
}else{
assocSet << zwave.associationV1.associationRemove(groupingIdentifier:2, nodeId: 0).format()
}
if(settings.assocGroup3 != null){
def group3parsed = settings.assocGroup3.tokenize(",")
group3parsed = convertStringListToIntegerList(group3parsed)
assocSet << zwave.associationV1.associationSet(groupingIdentifier:3, nodeId:group3parsed).format()
}else{
assocSet << zwave.associationV1.associationRemove(groupingIdentifier:3, nodeId: 0).format()
}
return delayBetween(assocSet, 500)
}
/**
* setConfigurationParams command handler that sets user selected configuration parameters on the device.
* In case no value is set for a specific parameter the method skips setting that parameter.
* Secure mdoe setting hidden from user influence by design.
*
* @param void
* @return List of Configuration Set commands that will be executed in sequence with 500 ms delay inbetween.
*/
def setConfigurationParams() {
log.debug "Qubino Weatherstation: setConfigurationParams()"
def configSequence = []
if(settings.param1 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 1, size: 2, scaledConfigurationValue: settings.param1.toInteger()).format()
}
if(settings.param2 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 2, size: 2, scaledConfigurationValue: settings.param2.toInteger()).format()
}
if(settings.param3 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 3, size: 1, scaledConfigurationValue: settings.param3.toInteger()).format()
}
if(settings.param4 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 4, size: 1, scaledConfigurationValue: settings.param4.toInteger()).format()
}
if(settings.param5 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 5, size: 1, scaledConfigurationValue: settings.param5.toInteger()).format()
}
if(settings.param6 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 6, size: 1, scaledConfigurationValue: settings.param6.toInteger()).format()
}
if(settings.param7 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 7, size: 1, scaledConfigurationValue: settings.param7.toInteger()).format()
}
if(settings.param8 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 8, size: 1, scaledConfigurationValue: settings.param8.toInteger()).format()
}
if(settings.param9 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 9, size: 1, scaledConfigurationValue: settings.param9.toInteger()).format()
}
if(settings.param10 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 10, size: 1, scaledConfigurationValue: settings.param10.toInteger()).format()
}
if(settings.param11 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 11, size: 1, scaledConfigurationValue: settings.param11.toInteger()).format()
}
if(settings.param12 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 12, size: 1, scaledConfigurationValue: settings.param12.toInteger()).format()
}
if(settings.param13 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 13, size: 1, scaledConfigurationValue: settings.param13.toInteger()).format()
}
if(settings.param14 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 14, size: 1, scaledConfigurationValue: settings.param14.toInteger()).format()
}
if(settings.param15 != null){
configSequence << zwave.configurationV1.configurationSet(parameterNumber: 15, size: 1, scaledConfigurationValue: settings.param15.toInteger()).format()
}
return delayBetween(configSequence, 500)
}
/*
* -------- EVENT PARSER SECTION --------
*/
/**
* parse function takes care of parsing received bytes and passing them on to event methods.
*
* @param description String type value of the received bytes.
* @return Parsed result of the received bytes.
*/
def parse(String description) {
log.debug "Qubino Weatherstation: Parsing '${description}'"
def result = null
def cmd = zwave.parse(description)
if (cmd) {
result = zwaveEvent(cmd)
log.debug "Parsed ${cmd} to ${result.inspect()}"
} else {
log.debug "Non-parsed event: ${description}"
}
return result
}
/**
* Event method for MultiChannelCmdEncap encapsulation frames.
*
* @param cmd Type physicalgraph.zwave.commands.multichannelv3.MultiChannelCmdEncap received command.
* @return List of events that will update UI elements for data display.
*/
def zwaveEvent(physicalgraph.zwave.commands.multichannelv3.MultiChannelCmdEncap cmd) {
def encapsulatedCommand = cmd.encapsulatedCommand([0x30: 1, 0x31: 1])
def tempScale = location.temperatureScale
def resultEvents = []
switch (cmd.sourceEndPoint) {
default:
break;
case 1:
resultEvents << createEvent(name:"temperatureCh1", value: convertDegrees(tempScale,encapsulatedCommand), unit:"°"+location.temperatureScale, descriptionText: "Temperature Ch1: "+convertDegrees(tempScale,encapsulatedCommand)+"°"+location.temperatureScale)
resultEvents << createEvent(name:"temperature", value: convertDegrees(tempScale,encapsulatedCommand), unit:"°"+location.temperatureScale, descriptionText: "Temperature Ch1: "+convertDegrees(tempScale,encapsulatedCommand)+"°"+location.temperatureScale, displayed: false)
break;
case 2:
resultEvents << createEvent(name:"windDirection", value: encapsulatedCommand.scaledSensorValue.toString(), unit:"°", descriptionText: "Wind Direction: "+encapsulatedCommand.scaledSensorValue.toString()+" °")
break;
case 3:
resultEvents << createEvent(name:"windVelocity", value: encapsulatedCommand.scaledSensorValue.toString(), unit:"m/s", descriptionText: "Wind Velocity: "+encapsulatedCommand.scaledSensorValue.toString()+" m/s")
break;
case 4:
resultEvents << createEvent(name:"windGust", value: encapsulatedCommand.scaledSensorValue.toString(), unit:"m/s", descriptionText: "Wind Gust: "+encapsulatedCommand.scaledSensorValue.toString()+" m/s")
break;
case 5:
resultEvents << createEvent(name:"windTemperature", value: convertDegrees(tempScale,encapsulatedCommand), unit:"°"+location.temperatureScale, descriptionText: "Wind Temperature: "+convertDegrees(tempScale,encapsulatedCommand)+" °"+location.temperatureScale)
break;
case 6:
resultEvents << createEvent(name:"windChillTemperature", value: convertDegrees(tempScale,encapsulatedCommand), unit:"°"+location.temperatureScale, descriptionText: "Wind Chill: "+convertDegrees(tempScale,encapsulatedCommand)+" °"+location.temperatureScale)
break;
case 7:
resultEvents << createEvent(name:"rainRate", value: encapsulatedCommand.scaledSensorValue.toString(), unit:"mm/h", descriptionText: "Rain Sensor: "+encapsulatedCommand.scaledSensorValue.toString()+" mm/h")
break;
case 8:
resultEvents << createEvent(name:"humidity", value: encapsulatedCommand.scaledSensorValue.toString(), unit:"%", descriptionText: "Humidity Ch1: "+encapsulatedCommand.scaledSensorValue.toString()+" %", displayed: false)
resultEvents << createEvent(name:"humidityCh1", value: encapsulatedCommand.scaledSensorValue.toString(), unit:"%", descriptionText: "Humidity Ch1: "+encapsulatedCommand.scaledSensorValue.toString()+" %")
break;
case 9:
resultEvents << createEvent(name:"temperatureCh2", value: convertDegrees(tempScale,encapsulatedCommand), unit:"°"+location.temperatureScale, descriptionText: "Temperature Ch2: "+convertDegrees(tempScale,encapsulatedCommand)+" °"+location.temperatureScale)
break;
case 10:
resultEvents << createEvent(name:"humidityCh2", value: encapsulatedCommand.scaledSensorValue.toString(), unit:"%", descriptionText: "Humidity Ch2: "+encapsulatedCommand.scaledSensorValue.toString()+" %")
break;
}
return resultEvents
}

View File

@@ -24,6 +24,10 @@ metadata {
fingerprint inClusters: "0x26", deviceJoinName: "Z-Wave Dimmer"
fingerprint mfr:"001D", prod:"1902", deviceJoinName: "Z-Wave Dimmer"
fingerprint mfr:"001D", prod:"1B03", model:"0334", deviceJoinName: "Leviton Universal Dimmer"
fingerprint mfr:"011A", prod:"0102", model:"0201", deviceJoinName: "Enerwave In-Wall Dimmer"
fingerprint mfr:"001D", prod:"1001", model:"0334", deviceJoinName: "Leviton 3-Speed Fan Controller"
fingerprint mfr:"001D", prod:"0602", model:"0334", deviceJoinName: "Leviton Magnetic Low Voltage Dimmer"
fingerprint mfr:"001D", prod:"0401", model:"0334", deviceJoinName: "Leviton 600W Incandescent Dimmer"
}
simulator {

View File

@@ -0,0 +1,623 @@
/**
* Rule Machine
*
* Copyright 2015 Bruce Ravenel and Mike Maxwell
*
* Version 1.6.5 1 Jan 2016
*
* Version History
*
* 1.6.5 1 Jan 2016 Added version numbers to main page
* 1.6.4 30 Dec 2015 Multi-commands
* 1.6.3 26 Dec 2015 UI improvements and icon per Michael Struck
* 1.6.2 25 Dec 2015 null parameter value patch in expert, maxwell
* 1.6.1 24 Dec 2015 UI improvement
* 1.6 23 Dec 2015 Added expert commands per Mike Maxwell
*
* 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.
*
*/
definition(
name: "Rule Machine",
singleInstance: true,
namespace: "bravenel",
author: "Bruce Ravenel and Mike Maxwell",
description: "Rule Machine",
category: "My Apps",
iconUrl: "https://raw.githubusercontent.com/bravenel/Rule-Trigger/master/smartapps/bravenel/RuleMachine.png",
iconX2Url: "https://raw.githubusercontent.com/bravenel/Rule-Trigger/master/smartapps/bravenel/RuleMachine%402x.png",
iconX3Url: "https://raw.githubusercontent.com/bravenel/Rule-Trigger/master/smartapps/bravenel/RuleMachine%402x.png"
)
preferences {
page(name: "mainPage")
page(name: "removePage")
//expert pages
page(name: "expert")
page(name: "generalApprovalPAGE")
page(name: "customCommandsPAGE")
page(name: "addCustomCommandPAGE")
page(name: "customParamsPAGE")
}
def mainPage() {
dynamicPage(name: "mainPage", title: "Installed Rules", install: true, uninstall: false, submitOnChange: true) {
if(!state.setup) initialize(true)
section {
app(name: "childRules", appName: "Rule", namespace: "bravenel", title: "Create New Rule...", multiple: true)
}
section ("Expert Features") {
href( "expert", title: "", description: "Tap to create custom commands", state: "")
}
section ("Remove Rule Machine"){
href "removePage", description: "Tap to remove Rule Machine ", title: ""
}
if(state.ver) section ("Version 1.6.5/" + state.ver) { }
}
}
def removePage() {
dynamicPage(name: "removePage", title: "Remove Rule Machine And All Rules", install: false, uninstall: true) {
section ("WARNING!\n\nRemoving Rule Machine also removes all Rules\n") {
}
}
}
def installed() {
if(!state.setup) initialize(true) else initialize(false)
}
def updated() {
initialize(false)
}
def initialize(first) {
if(first) {
state.ruleState = [:]
state.ruleSubscribers = [:]
}
childApps.each {child ->
if(child.name == "Rule") {
log.info "Installed Rules and Triggers: ${child.label}"
if(first) {
state.ruleState[child.label] = null
state.ruleSubscribers[child.label] = [:]
}
}
}
state.setup = true
}
def ruleList(appLabel) {
def result = []
childApps.each { child ->
if(child.name == "Rule" && child.label != appLabel && state.ruleState[child.label] != null) result << child.label
}
return result
}
def subscribeRule(appLabel, ruleName, ruleTruth, childMethod) {
// log.debug "subscribe: $appLabel, $ruleName, $ruleTruth, $childMethod"
ruleName.each {name ->
state.ruleSubscribers[name].each {if(it == appLabel) return}
if(state.ruleSubscribers[name] == null) state.ruleSubscribers[name] = ["$appLabel":ruleTruth]
else state.ruleSubscribers[name] << ["$appLabel":ruleTruth]
}
}
def setRuleTruth(appLabel, ruleTruth) {
// log.debug "setRuleTruth1: $appLabel, $ruleTruth"
state.ruleState[appLabel] = ruleTruth
def thisList = state.ruleSubscribers[appLabel]
thisList.each {
if(it.value == null || "$it.value" == "$ruleTruth") {
childApps.each { child ->
if(child.label == it.key) child.ruleHandler(appLabel, ruleTruth)
}
}
}
}
def currentRule(appLabel) {
// log.debug "currentRule: $appLabel, ${state.ruleState[appLabel]}"
def result = state.ruleState[appLabel]
}
def childUninstalled() {
// log.debug "childUninstalled called"
}
def removeChild(appLabel) {
// log.debug "removeChild: $appLabel"
unSubscribeRule(appLabel)
if(state.ruleState[appLabel] != null) state.ruleState.remove(appLabel)
if(state.ruleSubscribers[appLabel] != null) state.ruleSubscribers.remove(appLabel)
}
def unSubscribeRule(appLabel) {
// log.debug "unSubscribeRule: $appLabel"
state.ruleSubscribers.each { rule ->
def newList = [:]
rule.value.each {list ->
if(list.key != appLabel) newList << list
}
rule.value = newList
}
}
def runRule(rule, appLabel) {
// log.debug "runRule: $rule, $appLabel"
childApps.each { child ->
rule.each {
if(child.label == it) child.ruleEvaluator(appLabel)
}
}
}
/*****custom command specific pages *****/
def expert(){
dynamicPage(name: "expert", title: "Expert Features", uninstall: false, install: false) {
section(){
paragraph "${expertText()}"
//expert hrefs...
href( "customCommandsPAGE"
,title : "Configure Custom Commands..."
,description: ""
,state : anyCustom()
)
}
}
}
def generalApprovalPAGE(params){
def title = params.title
def method = params.method
def result
dynamicPage(name: "generalApprovalPAGE", title: title ){
section() {
if (method) {
result = app."${method}"()
paragraph "${result}"
}
}
}
}
def customCommandsPAGE() {
if (!state.lastCmdIDX) state.lastCmdIDX = 0
def savedCommands = getCommands()
dynamicPage(name: "customCommandsPAGE", title: "Custom Commands", uninstall: false, install: false) {
section(){
input(
name : "devices"
,title : "Test device"
,multiple : false
,required : false
,type : "capability.actuator"
,submitOnChange : true
)
if (settings.devices && savedCommands.size() != 0){
input(
name : "testCmd"
,title : "Select saved command to test"
,multiple : false
,required : false
,type : "enum"
,options : savedCommands
,submitOnChange : true
)
}
}
def result = execCommand(settings.testCmd)
if (result) {
section("${result}"){
}
}
section(){
if (devices){
href( "addCustomCommandPAGE"
,title : "New custom command..."
,description: ""
,state : null
)
}
}
if (getCommands()){
section(){
input(
name : "deleteCmds"
,title : "Delete custom commands..."
,multiple : true
,required : false
,description : ""
,type : "enum"
,options : getCommands()
,submitOnChange : true
)
if (isValidCommand(deleteCmds)){
href( "generalApprovalPAGE"
,title : "Delete command(s) now"
,description : ""
,state : null
,params : [method:"deleteCommands",title:"Delete Command"]
,submitOnChange : true
)
}
}
}
}
}
def addCustomCommandPAGE(){
def cmdLabel = getCmdLabel()
def complete = ""
def test = false
def pageTitle = "Create new custom command for:\n${devices}"
if (cmdLabel){
complete = "complete"
test = true
}
dynamicPage(name: "addCustomCommandPAGE", title: pageTitle, uninstall: false, install: false) {
section(){
input(
name : "cCmd"
,title : "Available device commands"
,multiple : false
,required : false
,type : "enum"
,options : getDeviceCommands()
,submitOnChange : true
)
href( "customParamsPAGE"
,title: "Parameters"
,description: parameterLabel()
,state: null
)
}
if (test){
def result = execTestCommand()
section("Configured command: ${cmdLabel}\n${result}"){
if (result == "succeeded"){
if (!commandExists(cmdLabel)){
href( "generalApprovalPAGE"
,title : "Save command now"
,description: ""
,state : null
,params : [method:"addCommand",title:"Add Command"]
)
}
}
}
}
}
}
def customParamsPAGE(p){
def ct = settings.findAll{it.key.startsWith("cpType_")}
state.howManyP = ct.size() + 1
def howMany = state.howManyP
dynamicPage(name: "customParamsPAGE", title: "Select parameters", uninstall: false) {
if(howMany) {
for (int i = 1; i <= howMany; i++) {
def thisParam = "cpType_" + i
def myParam = ct.find {it.key == thisParam}
section("Parameter #${i}") {
getParamType(thisParam, i != howMany)
if(myParam) {
def pType = myParam.value
getPvalue(pType, i)
}
}
}
}
}
}
/***** child specific methods *****/
def getCommandMap(cmdID){
return state.customCommands["${cmdID}"]
}
/***** local custom command specific methods *****/
def anyCustom(){
def result = null
if (getCommands()) result = "complete"
return result
}
def getParamType(myParam,isLast){
def myOptions = ["string", "number", "decimal"]
def result = input (
name : myParam
,type : "enum"
,title : "parameter type"
,required : isLast
,options : myOptions
,submitOnChange : true
)
return result
}
def getPvalue(myPtype, n){
def myVal = "cpVal_" + n
def result = null
if (myPtype == "string"){
result = input(
name : myVal
,title : "string value"
,type : "text"
,required : false
)
} else if (myPtype == "number"){
result = input(
name : myVal
,title : "integer value"
,type : "number"
,required : false
)
} else if (myPtype == "decimal"){
result = input(
name : myVal
,title : "decimal value"
,type : "decimal"
,required : false
)
}
return result
}
def getCmdLabel(){
def cmd
if (settings.cCmd) cmd = settings.cCmd.value
def cpTypes = settings.findAll{it.key.startsWith("cpType_")}.sort()
def result = null
if (cmd) {
result = "${cmd}("
if (cpTypes.size() == 0){
result = result + ")"
} else {
def r = getParams(cpTypes)
if (r == "") result = r
else result = "${result}${r})"
}
}
return result
}
def getParams(cpTypes){
def result = ""
def cpValue
def badParam = false
cpTypes.each{ cpType ->
def i = cpType.key.replaceAll("cpType_","")
def cpVal = settings.find{it.key == "cpVal_${i}"}
if (cpVal){
cpValue = cpVal.value
if (cpType.value == "string"){
result = result + "'${cpValue}',"
} else {
if (cpValue.isNumber()){
result = result + "${cpValue},"
} else {
result = result + "[${cpValue}]: is not a number,"
}
}
} else {
badParam = true
}
}
if (badParam) result = ""
else result = result[0..-2]
return result
}
def parameterLabel(){
def howMany = (state.howManyP ?: 1) - 1
def result = ""
if (howMany) {
for (int i = 1; i <= howMany; i++) {
result = result + parameterLabelN(i) + "\n"
}
result = result[0..-2]
}
return result
}
def parameterLabelN(i){
def result = ""
def cpType = settings.find{it.key == "cpType_${i}"}
def cpVal = settings.find{it.key == "cpVal_${i}"}
def cpValue
if (cpVal) cpValue = cpVal.value
else cpValue = "missing value"
if (cpType){
result = "p${i} - type:${cpType.value}, value:${cpValue}"
}
return result
}
def getParamsAsList(cpTypes){
def result = []
cpTypes.each{ cpType ->
def i = cpType.key.replaceAll("cpType_","")
def cpVal = settings.find{it.key == "cpVal_${i}"}
if (cpVal){
if (cpType.value == "string"){
result << "${cpVal.value}"
} else if (cpType.value == "decimal"){
result << cpVal.value.toBigDecimal()
} else {
result << cpVal.value.toInteger()
}
} else {
result << "missing value"
}
}
return result
}
def getCommands(){
def result = []
def cmdMaps = state.customCommands ?: []
cmdMaps.each{ cmd ->
def option = [(cmd.key):(cmd.value.text)]
result.push(option)
}
return result
}
def isValidCommand(cmdIDS){
def result = false
cmdIDS.each{ cmdID ->
def cmd = state.customCommands["${cmdID}"]
if (cmd) result = true
}
return result
}
def deleteCommands(){
def result
def cmdMaps = state.customCommands
if (deleteCmds.size == 1) result = "Command removed"
else result = "Commands removed"
deleteCmds.each{ it ->
cmdMaps.remove(it)
}
return result
}
def commandExists(cmd){
def result = false
if (state.customCommands){
result = state.customCommands.find{ it.value.text == "${cmd}" }
}
return result
}
def addCommand(){
def result
def newCmd = getCmdLabel()
def found = commandExists(newCmd)
def cmdMaps = state.customCommands
//only update if not found...
if (!found) {
state.lastCmdIDX = state.lastCmdIDX + 1
def nextIDX = state.lastCmdIDX
def cmd = [text:"${newCmd}",cmd:"${cCmd}"]
def params = [:]
def cpTypes = settings.findAll{it.key.startsWith("cpType_")}.sort()
cpTypes.each{ cpType ->
def i = cpType.key.replaceAll("cpType_","")
def cpVal = settings.find{it.key == "cpVal_${i}"}
def param = ["type":"${cpType.value}","value":"${cpVal.value}"]
params.put(i, param)
}
cmd.put("params",params)
if (cmdMaps) cmdMaps.put((nextIDX),cmd)
else state.customCommands = [(nextIDX):cmd]
result = "command: ${newCmd} was added"
} else {
result = "command: ${newCmd} was not added, it already exists."
}
return result
}
def execTestCommand(){
def result
def cTypes = settings.findAll{it.key.startsWith("cpType_")}
def p = getParamsAsList(cTypes.sort()) as Object[]
devices.each { device ->
try {
device."${cCmd}"(p)
result = "succeeded"
}
catch (IllegalArgumentException e){
def em = e as String
def ems = em.split(":")
ems = ems[2].replace(" [","").replace("]","")
ems = ems.replaceAll(", ","\n")
result = "failed, valid commands:\n${ems}"
}
catch (e){
result = "failed with:\n${e}"
}
}
return result
}
def execCommand(cmdID){
def result = ""
def pList = []
if (cmdID){
def cmdMap = state.customCommands["${cmdID}"]
if (testCmd && cmdMap) {
def params = cmdMap.params.sort()
params.each{ p ->
if (p.value.type == "string"){
pList << "${p.value.value}"
} else if (p.value.type == "decimal"){
pList << p.value.value.toBigDecimal()
} else {
pList << p.value.value.toInteger()
}
}
def p = pList as Object[]
devices.each { device ->
try {
device."${cmdMap.cmd}"(p)
result = "Command succeeded"
}
catch (IllegalArgumentException e){
def em = e as String
def ems = em.split(":")
ems = ems[2].replace(" [","").replace("]","")
ems = ems.replaceAll(", ","\n")
result = "Command failed, valid commands:\n${ems}"
}
catch (e){
result = "failed with:\n${e}"
}
}
return result
}
}
}
def getDeviceCommands(){
def result = ""
devices.each { device ->
try {
device."xxx"()
result = "Command succeeded"
}
catch (IllegalArgumentException e){
def em = e as String
def ems = em.split(":")
ems = ems[2].replace(" [","").replace("]","")
result = ems.split(", ").collect{it as String}
}
}
return result
}
def isExpert(ver){
state.ver = ver
return getCommands().size() > 0
}
def expertText() {
def text =
"Custom commands allows Rule Machine to control devices with custom capabilities. " +
"This includes dual dimmers and switches, ThingShields, FGBW controllers or any device you might build a " +
"custom SmartApp to utilize.\n\nCustom commands that are created and saved here will become available for use " +
"in any new or existing rules.\n\nAfter saving at least one command, look for 'Run custom device command' in your " +
"'Select Actions' sections."
}