Compare commits

..

1 Commits

Author SHA1 Message Date
Matt Miskinnis
c1f91f42db MSA-1677: Not sure what to put here... 2016-12-28 08:54:33 -08:00
4 changed files with 626 additions and 352 deletions

View File

@@ -1,345 +0,0 @@
/**
* Device Type Definition File
*
* Device Type: Fibaro Roller Shutter
* File Name: fibaro-roller-shutter.groovy
* Initial Release: 2015-06-00
* Author: SmartThings
*
* Copyright 2015 SmartThings
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
* for the specific language governing permissions and limitations under the License.
*
*/
metadata {
// Automatically generated. Make future change here.
definition (name: "Fibaro Roller Shutter", namespace: "ADF", author: "ADF") {
capability "Switch Level"
capability "Actuator"
capability "Switch"
capability "Polling"
capability "Refresh"
capability "Sensor"
command "resetParams2StDefaults"
command "listCurrentParams"
command "updateZwaveParam"
fingerprint deviceId: "0x1101", inClusters: "0x72,0x86,0x70,0x85,0x8E,0x26,0x7A,0x27,0x73,0xEF,0x26,0x2B"
}
simulator {
status "on": "command: 2003, payload: FF"
status "off": "command: 2003, payload: 00"
status "09%": "command: 2003, payload: 09"
status "10%": "command: 2003, payload: 0A"
status "33%": "command: 2003, payload: 21"
status "66%": "command: 2003, payload: 42"
status "99%": "command: 2003, payload: 63"
// reply messages
reply "2001FF,delay 5000,2602": "command: 2603, payload: FF"
reply "200100,delay 5000,2602": "command: 2603, payload: 00"
reply "200119,delay 5000,2602": "command: 2603, payload: 19"
reply "200132,delay 5000,2602": "command: 2603, payload: 32"
reply "20014B,delay 5000,2602": "command: 2603, payload: 4B"
reply "200163,delay 5000,2602": "command: 2603, payload: 63"
}
tiles {
multiAttributeTile(name:"switch", type: "lighting", width: 6, height: 4, canChangeIcon: true) {
tileAttribute("device.switch", key: "PRIMARY_CONTROL") {
attributeState("on", label:"open", action:"switch.off", icon:"st.doors.garage.garage-open", backgroundColor:"#79b821", nextState: "turningOff")
attributeState("off", label:"close", action:"switch.on", icon:"st.doors.garage.garage-closed", backgroundColor:"#ffffff", nextState: "turningOn")
attributeState("turningOn", label:"opening", action:"switch.off", icon:"st.doors.garage.garage-opening", backgroundColor:"#79b821", nextState: "turningOff")
attributeState("turningOff", label:"closing", action:"switch.on", icon:"st.doors.garage.garage-closing", backgroundColor:"#ffffff", nextState:"turningOn")
}
tileAttribute ("device.level", key: "SLIDER_CONTROL") {
attributeState("level", action:"switch level.setLevel")
}
}
standardTile("refresh", "device.switch", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
state "default", label:"", action:"refresh.refresh", icon:"st.secondary.refresh"
}
standardTile("on", "device.switch", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
state("on", label:'open', action:"switch.on", icon:"st.doors.garage.garage-opening")
}
standardTile("off", "device.switch", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
state("off", label:'close', action:"switch.off", icon:"st.doors.garage.garage-closing")
}
standardTile("stop", "device.level", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
state("default", label:'stop/my', action:"switch level.setLevel", icon:"st.Transportation.transportation13")
}
main(["switch"])
details(["switch", "refresh", "on", "off", "stop"])
}
}
def parse(String description) {
def item1 = [
canBeCurrentState: false,
linkText: getLinkText(device),
isStateChange: false,
displayed: false,
descriptionText: description,
value: description
]
def result
def cmd = zwave.parse(description, [0x26: 1, 0x70: 2, 072: 2])
//log.debug "cmd: ${cmd}"
if (cmd) {
result = createEvent(cmd, item1)
}
else {
item1.displayed = displayed(description, item1.isStateChange)
result = [item1]
}
if(result?.descriptionText)
log.debug "Parse returned ${result?.descriptionText}"
result
}
def createEvent(physicalgraph.zwave.commands.basicv1.BasicReport cmd, Map item1) {
def result = doCreateEvent(cmd, item1)
for (int i = 0; i < result.size(); i++) {
result[i].type = "physical"
}
result
}
def createEvent(physicalgraph.zwave.commands.basicv1.BasicSet cmd, Map item1) {
def result = doCreateEvent(cmd, item1)
for (int i = 0; i < result.size(); i++) {
result[i].type = "physical"
}
result
}
def createEvent(physicalgraph.zwave.commands.switchmultilevelv1.SwitchMultilevelStartLevelChange cmd, Map item1) {
[]
}
def createEvent(physicalgraph.zwave.commands.switchmultilevelv1.SwitchMultilevelStopLevelChange cmd, Map item1) {
[response(zwave.basicV1.basicGet())]
}
def createEvent(physicalgraph.zwave.commands.switchmultilevelv1.SwitchMultilevelSet cmd, Map item1) {
def result = doCreateEvent(cmd, item1)
for (int i = 0; i < result.size(); i++) {
result[i].type = "physical"
}
result
}
def createEvent(physicalgraph.zwave.commands.switchmultilevelv1.SwitchMultilevelReport cmd, Map item1) {
def result = doCreateEvent(cmd, item1)
result[0].descriptionText = "${item1.linkText} is ${item1.value}"
result[0].handlerName = cmd.value ? "statusOn" : "statusOff"
for (int i = 0; i < result.size(); i++) {
result[i].type = "digital"
}
result
}
def doCreateEvent(physicalgraph.zwave.Command cmd, Map item1) {
def result = [item1]
item1.name = "switch"
item1.value = cmd.value ? "on" : "off"
item1.handlerName = item1.value
item1.descriptionText = "${item1.linkText} was turned ${item1.value}"
item1.canBeCurrentState = true
item1.isStateChange = isStateChange(device, item1.name, item1.value)
item1.displayed = item1.isStateChange
if (cmd.value >= 5) {
def item2 = new LinkedHashMap(item1)
item2.name = "level"
item2.value = cmd.value as String
item2.unit = "%"
item2.descriptionText = "${item1.linkText} dimmed ${item2.value} %"
item2.canBeCurrentState = true
item2.isStateChange = isStateChange(device, item2.name, item2.value)
item2.displayed = false
result << item2
}
result
}
def createEvent(physicalgraph.zwave.Command cmd, Map map) {
// Handles any Z-Wave commands we aren't interested in
log.debug "UNHANDLED COMMAND $cmd"
}
def on() {
log.info "on"
delayBetween([zwave.basicV1.basicSet(value: 0xFF).format(), zwave.switchMultilevelV1.switchMultilevelGet().format()], 5000)
}
def off() {
delayBetween ([zwave.basicV1.basicSet(value: 0x00).format(), zwave.switchMultilevelV1.switchMultilevelGet().format()], 5000)
}
def setLevel(value) {
def level = Math.min(value as Integer, 99)
delayBetween ([zwave.basicV1.basicSet(value: level).format(), zwave.switchMultilevelV1.switchMultilevelGet().format()], 5000)
}
def setLevel(value, duration) {
def level = Math.min(value as Integer, 99)
def dimmingDuration = duration < 128 ? duration : 128 + Math.round(duration / 60)
zwave.switchMultilevelV2.switchMultilevelSet(value: level, dimmingDuration: dimmingDuration).format()
}
def poll() {
zwave.switchMultilevelV1.switchMultilevelGet().format()
}
def refresh() {
zwave.switchMultilevelV1.switchMultilevelGet().format()
}
/**
* Configures the device to settings needed by SmarthThings at device discovery time. Assumes
* device is already at default parameter settings.
*
* @param none
*
* @return none
*/
def configure() {
log.debug "Configuring Device..."
def cmds = []
// send associate to group 3 to get sensor data reported only to hub
cmds << zwave.associationV2.associationSet(groupingIdentifier:3, nodeId:[zwaveHubNodeId]).format()
delayBetween(cmds, 500)
}
def createEvent(physicalgraph.zwave.commands.configurationv2.ConfigurationReport cmd, Map item1) {
log.debug "${device.displayName} parameter '${cmd.parameterNumber}' with a byte size of '${cmd.size}' is set to '${cmd.configurationValue}'"
}
/**
* This method will allow the user to update device parameters (behavior) from an app.
* the user can write his/her own app to envoke this method.
* No type or value checking is done to compare to what device capability or reaction.
* It is up to user to read OEM documentation prio to envoking this method.
*
* <p>THIS IS AN ADVANCED OPERATION. USE AT YOUR OWN RISK! READ OEM DOCUMENTATION!
*
* @param List[paramNumber:80,value:10,size:1]
*
*
* @return none
*/
def updateZwaveParam(params) {
if ( params ) {
def pNumber = params.paramNumber
def pSize = params.size
def pValue = [params.value]
log.debug "Make sure device is awake and in recieve mode"
log.debug "Updating ${device.displayName} parameter number '${pNumber}' with value '${pValue}' with size of '${pSize}'"
def cmds = []
cmds << zwave.configurationV1.configurationSet(configurationValue: pValue, parameterNumber: pNumber, size: pSize).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: pNumber).format()
delayBetween(cmds, 1000)
}
}
/**
* Sets all of available Fibaro parameters back to the device defaults except for what
* SmartThings needs to support the stock functionality as released.
*
* <p>THIS IS AN ADVANCED OPERATION. USE AT YOUR OWN RISK! READ OEM DOCUMENTATION!
*
* @param none
*
* @return none
*/
def resetParams2StDefaults() {
log.debug "Resetting ${device.displayName} parameters to SmartThings compatible defaults"
def cmds = []
cmds << zwave.configurationV1.configurationSet(configurationValue: [255], parameterNumber: 1, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 6, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 7, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 8, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [5], parameterNumber: 9, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 10, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 11, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [99], parameterNumber: 12, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [2], parameterNumber: 13, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 14, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 15, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [1], parameterNumber: 16, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 17, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 18, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 19, size: 1).format()
//Param 20 is different for 50Hz or 60 Hz uncomment the line that will reflect the power frequency used
//cmds << zwave.configurationV1.configurationSet(configurationValue: [101], parameterNumber: 20, size: 1).format() //60 Hz (US)
//cmds << zwave.configurationV1.configurationSet(configurationValue: [110], parameterNumber: 20, size: 1).format() //50 Hz (UK)
cmds << zwave.configurationV1.configurationSet(configurationValue: [3], parameterNumber: 30, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [600], parameterNumber: 39, size: 1).format()
//Param 40 not needed by SmartThings
//cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 40, size: 1).format()
cmds << zwave.configurationV1.configurationSet(configurationValue: [0], parameterNumber: 41, size: 1).format()
delayBetween(cmds, 500)
}
/**
* Lists all of available Fibaro parameters and thier current settings out to the
* logging window in the IDE. This will be called from the "Fibaro Tweaker" or
* user's own app.
*
* <p>THIS IS AN ADVANCED OPERATION. USE AT YOUR OWN RISK! READ OEM DOCUMENTATION!
*
* @param none
*
* @return none
*/
def listCurrentParams() {
log.debug "Listing of current parameter settings of ${device.displayName}"
def cmds = []
cmds << zwave.configurationV1.configurationGet(parameterNumber: 1).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 6).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 7).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 8).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 9).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 10).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 11).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 12).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 13).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 14).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 15).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 16).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 17).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 18).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 19).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 20).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 30).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 39).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 40).format()
cmds << zwave.configurationV1.configurationGet(parameterNumber: 41).format()
delayBetween(cmds, 500)
}

View File

@@ -22,10 +22,9 @@ metadata {
capability "Sensor"
capability "Health Check"
fingerprint mfr:"0063", prod:"4457", deviceJoinName: "GE In-Wall Smart Dimmer "
fingerprint mfr:"0063", prod:"4944", deviceJoinName: "GE In-Wall Smart Dimmer "
fingerprint mfr:"0063", prod:"5044", deviceJoinName: "GE Plug-In Smart Dimmer "
fingerprint mfr:"0063", prod:"4944", model:"3034", deviceJoinName: "GE In-Wall Smart Fan Control"
fingerprint mfr:"0063", prod:"4457", deviceJoinName: "Z-Wave Wall Dimmer"
fingerprint mfr:"0063", prod:"4944", deviceJoinName: "Z-Wave Wall Dimmer"
fingerprint mfr:"0063", prod:"5044", deviceJoinName: "Z-Wave Plug-In Dimmer"
}
simulator {

View File

@@ -25,9 +25,6 @@ metadata {
fingerprint mfr:"0063", prod:"4F50", model:"3031", deviceJoinName: "GE Plug-in Outdoor Switch"
fingerprint mfr:"001D", prod:"1D04", model:"0334", deviceJoinName: "Leviton Outlet"
fingerprint mfr:"001D", prod:"1C02", model:"0334", deviceJoinName: "Leviton Switch"
fingerprint mfr:"001D", prod:"0301", model:"0334", deviceJoinName: "Leviton 15A Switch"
fingerprint mfr:"011A", prod:"0101", model:"0102", deviceJoinName: "Enerwave On/Off Switch"
fingerprint mfr:"011A", prod:"0101", model:"0603", deviceJoinName: "Enerwave Duplex Receptacle"
}
// simulator metadata

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."
}