Compare commits

..

1 Commits

Author SHA1 Message Date
Nick Clay
def6990de7 MSA-1661: null 2016-12-20 10:38:03 -08:00
3 changed files with 206 additions and 627 deletions

View File

@@ -0,0 +1,206 @@
/**
* Generic Camera Device v1.0.07102014
*
* Copyright 2014 patrick@patrickstuart.com
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
* for the specific language governing permissions and limitations under the License.
*
*/
metadata {
definition (name: "Generic Camera Device", namespace: "ps", author: "patrick@patrickstuart.com") {
capability "Image Capture"
capability "Sensor"
capability "Actuator"
attribute "hubactionMode", "string"
}
preferences {
input("CameraIP", "string", title:"Camera IP Address", description: "Please enter your camera's IP Address", required: true, displayDuringSetup: true)
input("CameraPort", "string", title:"Camera Port", description: "Please enter your camera's Port", defaultValue: 80 , required: true, displayDuringSetup: true)
input("CameraPath", "string", title:"Camera Path to Image", description: "Please enter the path to the image", defaultValue: "/SnapshotJPEG?Resolution=640x480&Quality=Clarity", required: true, displayDuringSetup: true)
input("CameraAuth", "bool", title:"Does Camera require User Auth?", description: "Please choose if the camera requires authentication (only basic is supported)", defaultValue: true, displayDuringSetup: true)
input("CameraPostGet", "string", title:"Does Camera use a Post or Get, normally Get?", description: "Please choose if the camera uses a POST or a GET command to retreive the image", defaultValue: "GET", displayDuringSetup: true)
input("CameraUser", "string", title:"Camera User", description: "Please enter your camera's username", required: false, displayDuringSetup: true)
input("CameraPassword", "string", title:"Camera Password", description: "Please enter your camera's password", required: false, displayDuringSetup: true)
}
simulator {
}
/*
tiles {
standardTile("camera", "device.image", width: 1, height: 1, canChangeIcon: false, inactiveLabel: true, canChangeBackground: true) {
state "default", label: "", action: "", icon: "st.camera.dropcam-centered", backgroundColor: "#FFFFFF"
}
carouselTile("cameraDetails", "device.image", width: 3, height: 2) { }
standardTile("take", "device.image", width: 1, height: 1, canChangeIcon: false, inactiveLabel: true, 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("blank", "device.image", width: 1, height: 1, canChangeIcon: false, canChangeBackground: false, decoration: "flat") {
state "blank", label: "", action: "", icon: "", backgroundColor: "#FFFFFF"
}
main "camera"
details(["cameraDetails", "blank", "take"])
}
*/
tiles {
standardTile("take", "device.image", width: 1, height: 1, canChangeIcon: false, inactiveLabel: true, 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("refresh", "device.alarmStatus", inactiveLabel: false, decoration: "flat") {
state "refresh", action:"polling.poll", icon:"st.secondary.refresh"
}
standardTile("blank", "device.image", width: 1, height: 1, canChangeIcon: false, canChangeBackground: false, decoration: "flat") {
state "blank", label: "", action: "", icon: "", backgroundColor: "#FFFFFF"
}
carouselTile("cameraDetails", "device.image", width: 3, height: 2) { }
main "take"
details([ "take", "blank", "refresh", "cameraDetails"])
}
}
def parse(String description) {
log.debug "Parsing '${description}'"
def map = [:]
def retResult = []
def descMap = parseDescriptionAsMap(description)
//Image
if (descMap["bucket"] && descMap["key"]) {
putImageInS3(descMap)
}
}
// handle commands
def take() {
def userpassascii = "${CameraUser}:${CameraPassword}"
def userpass = "Basic " + userpassascii.encodeAsBase64().toString()
def host = CameraIP
def hosthex = convertIPtoHex(host)
def porthex = convertPortToHex(CameraPort)
device.deviceNetworkId = "$hosthex:$porthex"
log.debug "The device id configured is: $device.deviceNetworkId"
def path = CameraPath
log.debug "path is: $path"
log.debug "Requires Auth: $CameraAuth"
log.debug "Uses which method: $CameraPostGet"
def headers = [:]
headers.put("HOST", "$host:$CameraPort")
if (CameraAuth) {
headers.put("Authorization", userpass)
}
log.debug "The Header is $headers"
def method = "GET"
try {
if (CameraPostGet.toUpperCase() == "POST") {
method = "POST"
}
}
catch (Exception e) { // HACK to get around default values not setting in devices
settings.CameraPostGet = "GET"
log.debug e
log.debug "You must not of set the perference for the CameraPOSTGET option"
}
log.debug "The method is $method"
try {
def hubAction = new physicalgraph.device.HubAction(
method: method,
path: path,
headers: headers
)
hubAction.options = [outputMsgToS3:true]
log.debug hubAction
hubAction
}
catch (Exception e) {
log.debug "Hit Exception $e on $hubAction"
}
}
def putImageInS3(map) {
log.debug "firing s3"
def s3ObjectContent
try {
def imageBytes = getS3Object(map.bucket, map.key + ".jpg")
if(imageBytes)
{
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() }
}
}
def parseDescriptionAsMap(description) {
description.split(",").inject([:]) { map, param ->
def nameAndValue = param.split(":")
map += [(nameAndValue[0].trim()):nameAndValue[1].trim()]
}
}
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
}
private Integer convertHexToInt(hex) {
Integer.parseInt(hex,16)
}
private String convertHexToIP(hex) {
log.debug("Convert hex to ip: $hex")
[convertHexToInt(hex[0..1]),convertHexToInt(hex[2..3]),convertHexToInt(hex[4..5]),convertHexToInt(hex[6..7])].join(".")
}
private getHostAddress() {
def parts = device.deviceNetworkId.split(":")
log.debug device.deviceNetworkId
def ip = convertHexToIP(parts[0])
def port = convertHexToInt(parts[1])
return ip + ":" + port
}

View File

@@ -24,10 +24,6 @@ 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

@@ -1,623 +0,0 @@
/**
* 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."
}