mirror of
https://github.com/mtan93/SmartThingsPublic.git
synced 2026-03-13 05:11:51 +00:00
Compare commits
3 Commits
MSA-1671-1
...
MSA-1677-1
| Author | SHA1 | Date | |
|---|---|---|---|
|
c1f91f42db | ||
|
|
5b874e8f3a | ||
|
|
5b1da30a47 |
@@ -1,360 +0,0 @@
|
||||
/**
|
||||
* LANnouncer Alerter (Formerly LANdroid - but Google didn't like that much.)
|
||||
*
|
||||
* Requires the LANnouncer android app; https://play.google.com/store/apps/details?id=com.keybounce.lannouncer
|
||||
* See http://www.keybounce.com/LANdroidHowTo/LANdroid.html for full downloads and instructions.
|
||||
* SmartThings thread: https://community.smartthings.com/t/android-as-a-speech-alarm-device-released/30282/12
|
||||
*
|
||||
* Note: Only Siren and Strobe from the U.I. or Alarm capabilities default to continuous.
|
||||
*
|
||||
* Version 1.25 22 July 2016
|
||||
*
|
||||
*
|
||||
* Copyright 2015-2016 Tony McNamara
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* To Do: Add string return to Image Capture attribute
|
||||
*
|
||||
*/
|
||||
|
||||
metadata {
|
||||
definition (name: "LANnouncer Alerter", namespace: "KeyBounce", author: "Tony McNamara") {
|
||||
capability "Alarm"
|
||||
capability "Speech Synthesis"
|
||||
capability "Notification"
|
||||
capability "Tone"
|
||||
capability "Image Capture"
|
||||
attribute "LANdroidSMS","string"
|
||||
/* Per http://docs.smartthings.com/en/latest/device-type-developers-guide/overview.html#actuator-and-sensor */
|
||||
capability "Sensor"
|
||||
capability "Actuator"
|
||||
|
||||
// Custom Commands
|
||||
/** Retrieve image, formatted for SmartThings, from camera by name. */
|
||||
command "chime"
|
||||
command "doorbell"
|
||||
command "ipCamSequence", ["number"]
|
||||
command "retrieveAndWait", ["string"]
|
||||
command "retrieveFirstAndWait"
|
||||
command "retrieveSecondAndWait"
|
||||
}
|
||||
preferences {
|
||||
input("DeviceLocalLan", "string", title:"Android IP Address", description:"Please enter your tablet's I.P. address", defaultValue:"" , required: false, displayDuringSetup: true)
|
||||
input("DevicePort", "string", title:"Android Port", description:"Port the Android device listens on", defaultValue:"1035", required: false, displayDuringSetup: true)
|
||||
input("ReplyOnEmpty", "bool", title:"Say Nothing", description:"When no speech is found, announce LANdroid? (Needed for the speech and notify tiles to work)", defaultValue: true, displayDuringSetup: true)
|
||||
input("AlarmContinuous", "bool", title:"Continuous Alarm (vs 10 sec.)", description: "When on, the alarm will sound until Stop is issued.", defaultValue: false, displayDuringSetup: true)
|
||||
}
|
||||
|
||||
simulator {
|
||||
// reply messages
|
||||
["strobe","siren","both","off"].each
|
||||
{
|
||||
reply "$it": "alarm:$it"
|
||||
}
|
||||
}
|
||||
|
||||
tiles {
|
||||
standardTile("alarm", "device.alarm", width: 2, height: 2) {
|
||||
state "off", label:'off', action:'alarm.both', icon:"st.alarm.alarm.alarm", backgroundColor:"#ffffff"
|
||||
state "strobe", label:'strobe!', action:'alarm.off', icon:"st.Lighting.light11", backgroundColor:"#e86d13"
|
||||
state "siren", label:'siren!', action:'alarm.off', icon:"st.alarm.alarm.alarm", backgroundColor:"#e86d13"
|
||||
state "both", label:'alarm!', action:'alarm.off', icon:"st.alarm.alarm.alarm", backgroundColor:"#e86d13"
|
||||
}
|
||||
standardTile("strobe", "device.alarm", inactiveLabel: false, decoration: "flat") {
|
||||
state "default", label:'', action:"alarm.strobe", icon:"st.secondary.strobe"
|
||||
}
|
||||
|
||||
standardTile("siren", "device.alarm", inactiveLabel: false, decoration: "flat") {
|
||||
state "default", label:'', action:"alarm.siren", icon:"st.secondary.siren"
|
||||
}
|
||||
standardTile("off", "device.alarm", inactiveLabel: false, decoration: "flat") {
|
||||
state "default", label:'Off', action:"alarm.off", icon:"st.quirky.spotter.quirky-spotter-sound-off"
|
||||
}
|
||||
|
||||
/* Apparently can't show image attributes on tiles. */
|
||||
standardTile("take", "device.image", width: 1, height: 1, canChangeIcon: false, canChangeBackground: false)
|
||||
{
|
||||
state "take", label: "Take", action: "Image Capture.take", icon: "st.camera.camera", backgroundColor: "#FFFFFF", nextState:"taking"
|
||||
state "taking", label:'Taking', action: "", icon: "st.camera.take-photo", backgroundColor: "#53a7c0"
|
||||
state "image", label: "Take", action: "Image Capture.take", icon: "st.camera.camera", backgroundColor: "#FFFFFF", nextState:"taking"
|
||||
}
|
||||
|
||||
|
||||
standardTile("speak", "device.speech", inactiveLabel: false, decoration: "flat")
|
||||
{
|
||||
state "default", label:'Speak', action:"Speech Synthesis.speak", icon:"st.Electronics.electronics13"
|
||||
}
|
||||
standardTile("toast", "device.notification", inactiveLabel: false, decoration: "flat") {
|
||||
state "default", label:'Notify', action:"notification.deviceNotification", icon:"st.Kids.kids1"
|
||||
}
|
||||
standardTile("beep", "device.tone", inactiveLabel: false, decoration: "flat") {
|
||||
state "default", label:'Tone', action:"tone.beep", icon:"st.Entertainment.entertainment2"
|
||||
}
|
||||
carouselTile("cameraDetails", "device.image", width: 3, height: 2) { }
|
||||
|
||||
main (["alarm", "take"]);
|
||||
details(["alarm","strobe","siren","off","speak", "take","toast","beep", "cameraDetails"]);
|
||||
}
|
||||
}
|
||||
|
||||
/** Generally matches TTSServer/app/build.gradle */
|
||||
String getVersion() {return "24 built July 2016";}
|
||||
|
||||
|
||||
/** Alarm Capability, Off.
|
||||
* Turns off both the strobe and the alarm.
|
||||
* Necessary when in continuous mode.
|
||||
*/
|
||||
def off() {
|
||||
log.debug "Executing 'off'"
|
||||
sendEvent(name:"alarm", value:"off")
|
||||
def command="&ALARM=STOP&FLASH=STOP&"+getDoneString();
|
||||
return sendCommands(command)
|
||||
}
|
||||
|
||||
/** Alarm Capability: Strobe
|
||||
* Flashes the camera light, if any.
|
||||
*/
|
||||
def strobe() {
|
||||
log.debug "Executing 'strobe'"
|
||||
// For illustration, switch to siren and sendEvent after.
|
||||
def command= (AlarmContinuous?"&FLASH=CONTINUOUS&":"&FLASH=STROBE&")+getDoneString();
|
||||
// def command=(AlarmContinuous?"&ALARM=SIREN:CONTINUOUS&":"&ALARM=SIREN&")+getDoneString();
|
||||
def hubAction = sendCommands(command)
|
||||
sendEvent(name:"alarm", value:"strobe")
|
||||
return hubAction;
|
||||
}
|
||||
|
||||
/** Alarm Capability: Siren
|
||||
* Sounds the siren, either continuous or for a brief period, depending on setting.
|
||||
* If continuous, Stop should be called later.
|
||||
*/
|
||||
def siren() {
|
||||
log.debug "Executing 'siren'"
|
||||
sendEvent(name:"alarm", value:"siren")
|
||||
def command=(AlarmContinuous?"&ALARM=SIREN:CONTINUOUS&":"&ALARM=SIREN&")+getDoneString();
|
||||
return sendCommands(command);
|
||||
}
|
||||
|
||||
/** Tone Capability: Beep
|
||||
* Sounds a short beep
|
||||
*/
|
||||
def beep() {
|
||||
log.debug "Executing 'beep'"
|
||||
def command="&ALARM=CHIME&"+getDoneString()
|
||||
return sendCommands(command);
|
||||
}
|
||||
|
||||
def both() {
|
||||
log.debug "Executing 'both'"
|
||||
sendEvent(name:"alarm", value:"both")
|
||||
def command="&ALARM=ON&FLASH=ON&"+getDoneString()
|
||||
if (AlarmContinuous)
|
||||
{
|
||||
command="&ALARM=SIREN:CONTINUOUS&FLASH=CONTINUOUS&"+getDoneString()
|
||||
}
|
||||
return sendCommands(command);
|
||||
}
|
||||
|
||||
/** speechSynthesis Capability: Speak
|
||||
*/
|
||||
def speak(toSay) {
|
||||
log.debug "Executing 'speak'"
|
||||
if (!toSay?.trim()) {
|
||||
if (ReplyOnEmpty) {
|
||||
toSay = "LANnouncer Version ${version}"
|
||||
}
|
||||
}
|
||||
|
||||
if (toSay?.trim()) {
|
||||
def command="&SPEAK="+toSay+"&"+getDoneString()
|
||||
return sendCommands(command)
|
||||
}
|
||||
}
|
||||
|
||||
/** Notification capability: deviceNotification
|
||||
*/
|
||||
def deviceNotification(toToast) {
|
||||
log.debug "Executing notification with "+toToast
|
||||
if (!toToast?.trim()) {
|
||||
if (ReplyOnEmpty) {
|
||||
toToast = "LANnouncer Version ${version}";
|
||||
}
|
||||
}
|
||||
if (toToast?.trim()) {
|
||||
def command="&TOAST="+toToast+"&"+getDoneString()
|
||||
return sendCommands(command)
|
||||
}
|
||||
}
|
||||
|
||||
def chime() {
|
||||
log.debug "Executing 'chime'"
|
||||
// TODO: handle 'siren' command
|
||||
def command="&ALARM=CHIME&"+getDoneString()
|
||||
return sendCommands(command)
|
||||
}
|
||||
|
||||
def doorbell() {
|
||||
log.debug "Executing 'doorbell'"
|
||||
// TODO: handle 'siren' command
|
||||
def command="&ALARM=DOORBELL&"+getDoneString()
|
||||
return sendCommands(command)
|
||||
}
|
||||
|
||||
def ipCamSequence(cameraNumber) {
|
||||
def camera = (cameraNumber==1?"FIRST":"SECOND");
|
||||
def command="&RETRIEVESEQ="+cameraNumber+"&"+getDoneString()
|
||||
return sendIPCommand(command, true)
|
||||
}
|
||||
|
||||
|
||||
def retrieveFirstAndWait() {
|
||||
retrieveAndWait("FIRST");
|
||||
}
|
||||
def retrieveSecondAndWait() {
|
||||
retrieveAndWait("SECOND");
|
||||
}
|
||||
def retrieveAndWait(cameraName) {
|
||||
log.info("Requesting image from camera ${cameraName}");
|
||||
def command="&RETRIEVE="+cameraName+"&STSHRINK=TRUE&"+getDoneString()
|
||||
return sendIPCommand(command, true)
|
||||
}
|
||||
|
||||
|
||||
def take() {
|
||||
// This won't result in received file. Can't handle large or binaries in hub.
|
||||
log.debug "Executing 'take'"
|
||||
def command="&PHOTO=BACK&STSHRINK=TRUE&"+getDoneString()
|
||||
return sendIPCommand(command, true)
|
||||
}
|
||||
|
||||
/** Send to IP and to SMS as appropriate
|
||||
* The caller MUST return the value, which is the hubAction.
|
||||
* As of version 1.25, does not "send" the command so much as
|
||||
* request that the calling service send it.
|
||||
*/
|
||||
private sendCommands(command) {
|
||||
log.info "Command request: "+command
|
||||
sendSMSCommand(command)
|
||||
return sendIPCommand(command)
|
||||
}
|
||||
|
||||
/** Prepares the hubAction to be executed.
|
||||
* Pre-V25, this was executed in-line.
|
||||
* Now it is returned, not executed, and must be returned up the calling chain.
|
||||
*/
|
||||
private sendIPCommand(commandString, sendToS3 = false) {
|
||||
log.info "Sending command "+ commandString+" to "+DeviceLocalLan+":"+DevicePort
|
||||
if (DeviceLocalLan?.trim()) {
|
||||
def hosthex = convertIPtoHex(DeviceLocalLan)
|
||||
def porthex = convertPortToHex(DevicePort)
|
||||
device.deviceNetworkId = "$hosthex:$porthex"
|
||||
|
||||
def headers = [:]
|
||||
headers.put("HOST", "$DeviceLocalLan:$DevicePort")
|
||||
|
||||
def method = "GET"
|
||||
|
||||
def hubAction = new physicalgraph.device.HubAction(
|
||||
method: method,
|
||||
path: "/"+commandString,
|
||||
headers: headers
|
||||
);
|
||||
if (sendToS3 == true)
|
||||
{
|
||||
hubAction.options = [outputMsgToS3:true];
|
||||
}
|
||||
log.debug hubAction
|
||||
return hubAction;
|
||||
}
|
||||
}
|
||||
|
||||
private sendSMSCommand(commandString) {
|
||||
def preface = "+@TTSSMS@+"
|
||||
def smsValue = preface+"&"+commandString
|
||||
state.lastsmscommand = smsValue
|
||||
sendEvent(name: "LANdroidSMS", value: smsValue, isStateChange: true)
|
||||
/*
|
||||
if (SMSPhone?.trim()) {
|
||||
sendSmsMessage(SMSPhone, preface+"&"+commandString)
|
||||
}
|
||||
*/
|
||||
}
|
||||
|
||||
private String getDoneString() {
|
||||
return "@DONE@"
|
||||
}
|
||||
|
||||
def parse(String description) {
|
||||
log.debug "Parsing '${description}'"
|
||||
def map = parseLanMessage(description);
|
||||
log.debug "As LAN: " + map;
|
||||
if ((map.headers) && (map.headers.'Content-Type' != null) && (map.headers.'Content-Type'.contains("image/jpeg")) )
|
||||
{ // Store the file
|
||||
if(map.body)
|
||||
{
|
||||
storeImage(getPictureName(), map.body);
|
||||
}
|
||||
}
|
||||
/* 'index:0F, mac:0073E023A13A, ip:C0A80114, port:040B, requestId:f9036fb2-9637-40b8-b2c5-71ba5a09fd3e, bucket:smartthings-device-conn-temp, key:fc8e3dfd-5035-40a2-8adc-a312926f9034' */
|
||||
|
||||
else if (map.bucket && map.key)
|
||||
{ // S3 pointer; retrieve image from it to store.
|
||||
try {
|
||||
def s3ObjectContent; // Needed for scope of try-catch
|
||||
def imageBytes = getS3Object(map.bucket, map.key + ".jpg")
|
||||
|
||||
if(imageBytes)
|
||||
{
|
||||
log.info ("Got image bytes; saving them.")
|
||||
s3ObjectContent = imageBytes.getObjectContent()
|
||||
def bytes = new ByteArrayInputStream(s3ObjectContent.bytes)
|
||||
storeImage(getPictureName(), bytes)
|
||||
}
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
log.error e
|
||||
}
|
||||
finally {
|
||||
//explicitly close the stream
|
||||
if (s3ObjectContent) { s3ObjectContent.close() }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Image Capture handling
|
||||
/* Note that images are stored in https://graph.api.smartthings.com/api/s3/smartthings-smartsense-camera/[IMAGE-ID4],
|
||||
* where [IMAGE-ID] is listed in the IDE under My Devices > [Camera] > Current States: Image. That page is updated as pictures are taken.
|
||||
*/
|
||||
|
||||
|
||||
private getPictureName() {
|
||||
def pictureUuid = java.util.UUID.randomUUID().toString().replaceAll('-', '')
|
||||
log.debug pictureUuid
|
||||
def picName = device.deviceNetworkId.replaceAll(':', '') + "_$pictureUuid" + ".jpg"
|
||||
return picName
|
||||
}
|
||||
|
||||
|
||||
private String convertIPtoHex(ipAddress) {
|
||||
String hex = ipAddress.tokenize( '.' ).collect { String.format( '%02X', it.toInteger() ) }.join()
|
||||
log.debug "IP address entered is $ipAddress and the converted hex code is $hex"
|
||||
return hex
|
||||
|
||||
}
|
||||
|
||||
private String convertPortToHex(port) {
|
||||
String hexport = port.toString().format( '%04X', port.toInteger() )
|
||||
log.debug hexport
|
||||
return hexport
|
||||
}
|
||||
@@ -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 {
|
||||
|
||||
623
smartapps/bravenel/rule-machine.src/rule-machine.groovy
Normal file
623
smartapps/bravenel/rule-machine.src/rule-machine.groovy
Normal 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."
|
||||
}
|
||||
Reference in New Issue
Block a user