mirror of
https://github.com/mtan93/SmartThingsPublic.git
synced 2026-03-09 13:21:53 +00:00
Compare commits
1 Commits
MSA-1939-1
...
MSA-1925-2
| Author | SHA1 | Date | |
|---|---|---|---|
|
90d8534b46 |
@@ -1,559 +0,0 @@
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* BlueIris (LocalConnect2)
|
||||
*
|
||||
* Author: Nicolas Neverov
|
||||
* Date: 2017-04-30
|
||||
*/
|
||||
|
||||
metadata {
|
||||
definition (name: "blueiris2", namespace: "df", author: "df") {
|
||||
capability "Sensor"
|
||||
capability "Actuator"
|
||||
capability "Configuration"
|
||||
capability "Refresh"
|
||||
attribute "state", "enum", ["disarmed", "arming", "armed", "disarming", "unknown"]
|
||||
attribute "status", "string"
|
||||
command "arm"
|
||||
command "disarm"
|
||||
command "location" "STRING"
|
||||
command "retry"
|
||||
command "timeout"
|
||||
}
|
||||
|
||||
// simulator metadata
|
||||
simulator {
|
||||
}
|
||||
|
||||
preferences {
|
||||
input name:"username", type:"text", title: "Username", description: "BlueIris Username", required: true
|
||||
input name:"password", type:"password", title: "Password", description: "BlueIris Password", required: true
|
||||
}
|
||||
|
||||
// UI tile definitions
|
||||
tiles(scale: 2) {
|
||||
multiAttributeTile(name:"bi_detail_tile", type:"generic", width:6, height:4) {
|
||||
tileAttribute("device.state", key: "PRIMARY_CONTROL") {
|
||||
attributeState "disarmed", label:"Disarmed", action:"arm", icon:"st.locks.lock.unlocked", backgroundColor:"#ffffff"
|
||||
attributeState "arming", label:"Arming...", action:"arm", icon:"st.locks.lock.locked", backgroundColor:"#79b821"
|
||||
attributeState "armed", label:"Armed", action:"disarm", icon:"st.locks.lock.locked", backgroundColor:"#79b821"
|
||||
attributeState "disarming", label:"Disarming...", action:"disarm", icon:"st.locks.lock.unlocked", backgroundColor:"#ffffff"
|
||||
attributeState "unknown", label:"Unknown", action:"retry", icon:"st.locks.lock.unknown", backgroundColor:"#ff0000"
|
||||
attributeState "refreshing", action:"Refresh.refresh", icon:"st.secondary.refresh", backgroundColor:"#ffffff"
|
||||
}
|
||||
tileAttribute("device.status", key: "SECONDARY_CONTROL") {
|
||||
attributeState("default", label:'${currentValue}', defaultState:true)
|
||||
}
|
||||
}
|
||||
|
||||
standardTile("bi_refresh_tile", "device.refresh", decoration: "flat", width: 2, height: 2) {
|
||||
state "default", action:"Refresh.refresh", icon:"st.secondary.refresh"
|
||||
}
|
||||
|
||||
main "bi_detail_tile"
|
||||
details(["bi_detail_tile", "bi_refresh_tile"])
|
||||
}
|
||||
}
|
||||
|
||||
def fsmExecInternal(fsmDefinition, stateId, Map params)
|
||||
{
|
||||
def actionResult = null;
|
||||
|
||||
def fsmState = fsmDefinition[stateId?.toString()]
|
||||
if(fsmState == null || fsmState.isFinal) {
|
||||
return [error:"fsmExecInternal: state [$stateId] ${fsmState == null ? 'does not exist' : 'is final'} and cannot be actioned upon"]
|
||||
}
|
||||
|
||||
while(!fsmState.isFinal && !actionResult?.isAsync) {
|
||||
actionResult = fsmState.action(params)
|
||||
fsmState = fsmDefinition[actionResult.nextStateId?.toString()]
|
||||
if(fsmState == null) {
|
||||
return [error:"fsmExecInternal: state [${actionResult.nextStateId}] does not exist and cannot be actioned upon"]
|
||||
}
|
||||
log.debug("fsmExecInternal: transitioned state [$stateId] to [$actionResult.nextStateId] (isFinal:${fsmState.isFinal?:false}); result isAsync:${actionResult.isAsync?:false}")
|
||||
stateId = actionResult.nextStateId
|
||||
}
|
||||
return [actionResult:actionResult]
|
||||
}
|
||||
|
||||
def fsmGetStateId(Map persistentStg)
|
||||
{
|
||||
persistentStg.fsmState
|
||||
}
|
||||
|
||||
def fsmExec(Map persistentStg, fsmDefinition, Map params = null)
|
||||
{
|
||||
def stateId = fsmGetStateId(persistentStg) ?: params.fsmInitialState
|
||||
if(!stateId) {
|
||||
return [error: "fsmExec: cannot determine initial state, must be specified via params.fsmInitialState"]
|
||||
}
|
||||
|
||||
log.debug("fsmExec: ${persistentStg.fsmState ? 'proceeding' : 'starting'} with fsm state [$stateId]")
|
||||
params = (params != null ? params : [:])
|
||||
params.persistentStg = (params.persistentStg != null ? params.persistentStg : persistentStg)
|
||||
|
||||
def rc = fsmExecInternal(fsmDefinition, stateId, params)
|
||||
if(rc.actionResult) {
|
||||
persistentStg.fsmState = rc.actionResult.nextStateId
|
||||
}
|
||||
return rc
|
||||
}
|
||||
|
||||
|
||||
def getBlueIrisHubAction(Map body)
|
||||
{
|
||||
final host = getHostAddress();
|
||||
final path = "/json"
|
||||
|
||||
def hubAction = new physicalgraph.device.HubAction(
|
||||
method: "POST",
|
||||
path: path,
|
||||
headers: [HOST:host],
|
||||
body: body
|
||||
)
|
||||
log.info "getBlueIrisHubAction: prepared hubaction $hubAction, requestId: $hubAction.requestId"
|
||||
|
||||
hubAction
|
||||
}
|
||||
|
||||
def sendError(statusMsg)
|
||||
{
|
||||
sendEvent(name:"status", value: statusMsg)
|
||||
sendEvent(name:"state", value: "unknown")
|
||||
parent.onNotification("$device.displayName: $statusMsg");
|
||||
}
|
||||
|
||||
def sendEventInit(cmd)
|
||||
{
|
||||
def state;
|
||||
switch(cmd.id) {
|
||||
case 'status':
|
||||
state = 'unknown'
|
||||
break
|
||||
case 'set':
|
||||
state = (cmd.workflow == 'arm' ? 'arming' : 'disarming')
|
||||
break
|
||||
default:
|
||||
state = 'unknown' //TODO: error
|
||||
}
|
||||
sendEvent(name:"state", value: state)
|
||||
sendEvent(name:"status", value: "Logging in...")
|
||||
}
|
||||
|
||||
def sendEventLogin(cmd)
|
||||
{
|
||||
sendEvent(name:"status", value: "Opening session...")
|
||||
}
|
||||
|
||||
def sendEventStatus(cmd)
|
||||
{
|
||||
sendEvent(name:"status", value: "Getting status...")
|
||||
}
|
||||
|
||||
def sendEventSet(cmd)
|
||||
{
|
||||
log.debug("sendEventSet: executing ${cmd.workflow} workflow, ${cmd.context ? ('context: ' + cmd.context + ',') : ''} signal:${cmd.signal}, profile:${cmd.profile}")
|
||||
sendEvent(name:"status", value: "Executing '${cmd.workflow.toString() == 'arm' ? 'arm' : 'disarm'}${cmd.context ? ' ' + cmd.context : ''}' command")
|
||||
}
|
||||
|
||||
def sendEventFinalize(cmd, signal, profile, workflow)
|
||||
{
|
||||
def isArmed = (workflow.toString() == 'arm')
|
||||
def statusMsg = null
|
||||
def statusDetails = null
|
||||
if(cmd.id == 'set') {
|
||||
statusMsg = "Successfully ${isArmed ? 'armed' : 'disarmed'}${cmd.context ? ' \'' + cmd.context + '\'' : ''} ..."
|
||||
statusDetails = "Successfully ${isArmed ? 'armed' : 'disarmed'} ${cmd.context ? '\'' + cmd.context + '\'' : ''}"
|
||||
} else if(cmd.id == 'status') {
|
||||
statusMsg = "Status is '${isArmed ? 'Armed' : 'Disarmed'}'"
|
||||
statusDetails = "Current status is '${isArmed ? 'Armed' : 'Disarmed'}' [signal:${signal ? 'green' : 'red'}, profile:${profile}]"
|
||||
}
|
||||
|
||||
sendEvent(name:"state", value: isArmed ? "armed" : "disarmed")
|
||||
sendEvent(name:"status", value: statusMsg)
|
||||
parent.onNotification("${device.displayName}: ${statusDetails}");
|
||||
}
|
||||
|
||||
|
||||
def getBIfFsmDef()
|
||||
{
|
||||
[
|
||||
init: [
|
||||
action: {Map params ->
|
||||
def cmd = params.cmd
|
||||
params.persistentStg.cmd = params.cmd
|
||||
sendEventInit(cmd)
|
||||
parent.onBeginAsyncOp(getOperationTimeoutMs())
|
||||
def haction = getBlueIrisHubAction([cmd: 'login']);
|
||||
cmd.requestId = haction.requestId
|
||||
|
||||
[nextStateId:'login', isAsync:true, hubAction:haction]
|
||||
}
|
||||
],
|
||||
login: [
|
||||
action: {Map params ->
|
||||
def cmd = params.persistentStg.cmd
|
||||
def respData = params.respMsg.data
|
||||
|
||||
if(respData?.result == 'fail' && respData.session) {
|
||||
sendEventLogin(cmd)
|
||||
|
||||
final u = settings.username
|
||||
final p = settings.password
|
||||
final token = "$u:${respData.session}:$p"
|
||||
log.debug("getBIfFsmDef[login]: logging in user \"$u\"")
|
||||
def haction = getBlueIrisHubAction([cmd: 'login', session: "${respData.session}", response: "${token.encodeAsMD5()}"]);
|
||||
cmd.requestId = haction.requestId
|
||||
cmd.session = respData.session
|
||||
[nextStateId: (cmd.id == 'set' ? 'set' : 'status'), isAsync:true, hubAction: haction]
|
||||
} else {
|
||||
log.error("getBIfFsmDef[login]: error: unexpected result from login call: $params.respMsg.data")
|
||||
parent.onEndAsyncOp()
|
||||
sendError("Error logging in: unexpected result $params.respMsg.data?.result")
|
||||
[nextStateId: 'error']
|
||||
}
|
||||
}
|
||||
],
|
||||
status: [
|
||||
action: {Map params ->
|
||||
def cmd = params.persistentStg.cmd
|
||||
def respData = params.respMsg.data
|
||||
if(respData?.result == 'success') {
|
||||
sendEventStatus(cmd)
|
||||
def haction = getBlueIrisHubAction([cmd: 'status', session: "${cmd.session}"]);
|
||||
cmd.requestId = haction.requestId
|
||||
[nextStateId: 'finalize', isAsync:true, hubAction: haction]
|
||||
} else {
|
||||
parent.onEndAsyncOp()
|
||||
log.error("getBIfFsmDef[status]: error creating session: unsuccessful result from session login call: ${respData}");
|
||||
sendError("Error establishing session: ${respData?.data?.reason}")
|
||||
[nextStateId:'error']
|
||||
}
|
||||
}
|
||||
],
|
||||
set: [
|
||||
action: {Map params ->
|
||||
def cmd = params.persistentStg.cmd
|
||||
def respData = params.respMsg.data
|
||||
if(respData?.result == 'success') {
|
||||
sendEventSet(cmd)
|
||||
def hubActionParams = [cmd: 'status', session: "${cmd.session}"]
|
||||
if(cmd.signal != null) {
|
||||
hubActionParams.signal = cmd.signal ? 1 : 0
|
||||
}
|
||||
if(cmd.profile != null) {
|
||||
hubActionParams.profile = cmd.profile
|
||||
}
|
||||
def haction = getBlueIrisHubAction(hubActionParams);
|
||||
cmd.requestId = haction.requestId
|
||||
[nextStateId:'finalize', isAsync:true, hubAction: haction]
|
||||
} else {
|
||||
parent.onEndAsyncOp()
|
||||
log.error("getBIfFsmDef[action]: error creating session: unsuccessful result from session login call: ${respData}");
|
||||
sendError("Error establishing session: ${respData.data?.reason}")
|
||||
[nextStateId:'error']
|
||||
}
|
||||
}
|
||||
],
|
||||
finalize: [
|
||||
action: {Map params ->
|
||||
boolean success = false
|
||||
final cmd = params.persistentStg.cmd
|
||||
final respData = params.respMsg.data
|
||||
|
||||
if(respData?.result == 'success') {
|
||||
|
||||
def respSignal = (respData.data?.signal != null ? respData.data.signal == '1' : null);
|
||||
def respProfile = respData.data?.profile
|
||||
|
||||
log.debug("getBIfFsmDef[finalize]: received 'success' response status, finalizing command ${cmd}, "
|
||||
+ "response: [signal:${respSignal}, profile:${respProfile}]")
|
||||
|
||||
if( cmd.id == 'set'
|
||||
&& (cmd.signal == null || cmd.signal == respSignal)
|
||||
&& (cmd.profile == null || respProfile == cmd.profile.toString())) {
|
||||
|
||||
sendEventFinalize(cmd, respSignal, respProfile, cmd.workflow)
|
||||
success = true
|
||||
|
||||
} else if(cmd.id == 'status' && respSignal != null && respProfile != null) {
|
||||
|
||||
def config = parent.onGetConfig()
|
||||
def workflow = deduceWorkflow(respSignal, respProfile, config)
|
||||
sendEventFinalize(cmd, respSignal, respProfile, workflow)
|
||||
success = true
|
||||
}
|
||||
}
|
||||
|
||||
parent.onEndAsyncOp()
|
||||
if(success) {
|
||||
[nextStateId:'success']
|
||||
} else {
|
||||
log.error("getBIfFsmDef[finalize]: error setting status: unsuccessful result from setting status/signal: $params.respMsg.data");
|
||||
sendError("Error setting status/signal: ${respData.data?.reason ?: 'signal mismatch...' }")
|
||||
[nextStateId:'error']
|
||||
}
|
||||
}
|
||||
],
|
||||
timeout: [
|
||||
action: {Map params ->
|
||||
log.error("getBIfFsmDef[timeout]: operation timed out")
|
||||
sendError("Operation timed out...")
|
||||
[nextStateId:'error']
|
||||
}
|
||||
],
|
||||
success: [
|
||||
isFinal:true
|
||||
],
|
||||
error: [
|
||||
isFinal:true
|
||||
]
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
def configure()
|
||||
{
|
||||
log.debug("configure: reseting states")
|
||||
sendEvent(name:"status", value: ".")
|
||||
sendEvent(name:"state", value: "disarmed") //TODO: initial state calc
|
||||
}
|
||||
|
||||
|
||||
private getBIStg(boolean reset = false)
|
||||
{
|
||||
if (state.biStg == null || reset) {
|
||||
state.biStg = [:]
|
||||
}
|
||||
state.biStg
|
||||
}
|
||||
|
||||
private Map getBICommands()
|
||||
{
|
||||
return [
|
||||
set: {Map p ->
|
||||
def rc = [
|
||||
id: 'set',
|
||||
signal: p.signal,
|
||||
profile: p.profile,
|
||||
workflow: p.workflow //one of ['arm', 'disarm']
|
||||
]
|
||||
if (p.context != null) {
|
||||
rc.context = p.context //optional (location mode name)
|
||||
}
|
||||
|
||||
rc
|
||||
},
|
||||
status: {->
|
||||
return [
|
||||
id: 'status',
|
||||
status: true
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
]
|
||||
}
|
||||
|
||||
//signal: null (N/A), true(green), false(red)
|
||||
//profile: null (N/A), number
|
||||
private deduceWorkflow(Boolean signal, String profile, final config)
|
||||
{
|
||||
if ((signal != null && !signal) ||
|
||||
(config.arming?.disarm?.signal == signal && config.arming?.disarm?.profile.toString() == profile)) {
|
||||
|
||||
"disarm"
|
||||
} else {
|
||||
"arm"
|
||||
}
|
||||
}
|
||||
|
||||
def arm()
|
||||
{
|
||||
log.debug('arm: running fsm')
|
||||
|
||||
def config = parent.onGetConfig()
|
||||
log.debug("arm: retrieved config: $config")
|
||||
|
||||
def armConfig = config.arming?.arm
|
||||
if(armConfig) {
|
||||
|
||||
def rc = fsmExec(getBIStg(true), getBIfFsmDef(), [fsmInitialState:'init', cmd:getBICommands().set(
|
||||
signal:armConfig.signal, profile:armConfig.profile, workflow:'arm')])
|
||||
|
||||
if(rc.error || !rc.actionResult.isAsync) {
|
||||
log.error("arm: error executing fsm: ${rc.error ?: 'expected asynchronious action result'}")
|
||||
} else {
|
||||
return rc.actionResult.hubAction
|
||||
}
|
||||
} else {
|
||||
log.error("arm: missing configuration (arming/arm) in $config")
|
||||
// TODO: check return
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
def disarm()
|
||||
{
|
||||
log.debug('disarm: running fsm')
|
||||
|
||||
def config = parent.onGetConfig();
|
||||
log.debug("disarm: retrieved config: $config")
|
||||
|
||||
def disarmConfig = config.arming?.disarm
|
||||
if(disarmConfig) {
|
||||
def rc = fsmExec(getBIStg(true), getBIfFsmDef(), [fsmInitialState:'init', cmd:getBICommands().set(
|
||||
signal:disarmConfig.signal, profile:disarmConfig.profile, workflow:'disarm')])
|
||||
|
||||
if(rc.error || !rc.actionResult.isAsync) {
|
||||
log.error("disarm: error executing fsm: ${rc.error ?: 'expected asynchronious action result'}")
|
||||
} else {
|
||||
return rc.actionResult.hubAction
|
||||
}
|
||||
} else {
|
||||
log.error("disarm: missing configuration (arming/arm) in $config")
|
||||
// TODO: check return
|
||||
}
|
||||
}
|
||||
|
||||
def location(locationId)
|
||||
{
|
||||
def config = parent.onGetConfig()
|
||||
log.debug("location: retrieved config: $config, processing location $locationId")
|
||||
|
||||
def locationConfig = config.location ? config.location[locationId] : null
|
||||
if(locationConfig) {
|
||||
|
||||
def rc = fsmExec(getBIStg(true), getBIfFsmDef(), [fsmInitialState:'init', cmd:getBICommands().set(
|
||||
signal: locationConfig.signal, profile: locationConfig.profile,
|
||||
workflow: deduceWorkflow(locationConfig.signal, locationConfig.profile, config), context: locationConfig.name)])
|
||||
|
||||
if(rc.error || !rc.actionResult.isAsync) {
|
||||
log.error("location: error executing fsm: ${rc.error ?: 'expected asynchronious action result'}")
|
||||
} else {
|
||||
return rc.actionResult.hubAction
|
||||
}
|
||||
|
||||
} else {
|
||||
log.debug("location: no active configuration found for locationId:${locationId}' in configuration [$config]")
|
||||
// TODO: check return
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
def retry()
|
||||
{
|
||||
def stg = getBIStg()
|
||||
|
||||
if(stg.cmd != null) {
|
||||
log.debug("retry: running fsm with cmd:$stg.cmd")
|
||||
def rc = fsmExec(getBIStg(true), getBIfFsmDef(), [fsmInitialState:'init', cmd:stg.cmd])
|
||||
|
||||
if(rc.error || !rc.actionResult.isAsync) {
|
||||
log.error("retry: error executing fsm: ${rc.error ?: 'expected asynchronious action result'}")
|
||||
} else {
|
||||
return rc.actionResult.hubAction
|
||||
}
|
||||
} else {
|
||||
log.debug("retry: no state to retry")
|
||||
}
|
||||
}
|
||||
|
||||
def timeout()
|
||||
{
|
||||
def stg = getBIStg()
|
||||
log.debug("timeout: running fsm with cmd:${stg.cmd}")
|
||||
|
||||
def rc = fsmExec(getBIStg(true), getBIfFsmDef(), [fsmInitialState:'timeout', cmd:stg.cmd])
|
||||
|
||||
if(rc.error || rc.actionResult.isAsync) {
|
||||
log.error("timeout: error executing fsm: ${rc.error ?: 'expected synchronious action result'}")
|
||||
}
|
||||
}
|
||||
|
||||
def refresh()
|
||||
{
|
||||
log.debug('refresh: running fsm: status command')
|
||||
|
||||
def rc = fsmExec(getBIStg(true), getBIfFsmDef(), [fsmInitialState:'init', cmd:getBICommands().status()])
|
||||
|
||||
if(rc.error || !rc.actionResult.isAsync) {
|
||||
log.error("refresh: error executing fsm: ${rc.error ?: 'expected asynchronious action result'}")
|
||||
} else {
|
||||
return rc.actionResult.hubAction
|
||||
}
|
||||
}
|
||||
|
||||
def parse(msg)
|
||||
{
|
||||
def lanMsg = parseLanMessage(msg)
|
||||
log.info "parse: parsed lan message: $lanMsg"
|
||||
|
||||
|
||||
if (lanMsg && lanMsg.headers && lanMsg.body) {
|
||||
log.info "parse: parsed lan message requestId:$lanMsg.requestId, body:$lanMsg.body"
|
||||
|
||||
def stg = getBIStg()
|
||||
|
||||
if(fsmGetStateId(stg) && stg.cmd.requestId == lanMsg.requestId) {
|
||||
log.debug("parse: received expected response mesage; requestId:$lanMsg.requestId, state:${fsmGetStateId(stg)}")
|
||||
|
||||
def rc = fsmExec(stg, getBIfFsmDef(), [respMsg:lanMsg])
|
||||
|
||||
if(rc.error) {
|
||||
log.error("parse: error executing fsm: ${rc.error ?: 'expected asynchronious action result'}")
|
||||
} else if(rc.actionResult.isAsync) {
|
||||
return [rc.actionResult.hubAction]
|
||||
}
|
||||
|
||||
} else {
|
||||
log.error("parse: skipping message: request id does not match: stg.request_id:$stg.cmd.requestId, lanMsg.requestId:$lanMsg.requestId")
|
||||
}
|
||||
|
||||
} else {
|
||||
log.error("parse: skipping message: unrecognized lan message")
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
private getOperationTimeoutMs()
|
||||
{
|
||||
10 * 1000;
|
||||
}
|
||||
|
||||
private Integer convertHexToInt(hex) {
|
||||
Integer.parseInt(hex,16)
|
||||
}
|
||||
|
||||
private String convertHexToIP(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(":")
|
||||
def ip = convertHexToIP(parts[0])
|
||||
def port = convertHexToInt(parts[1])
|
||||
return ip + ":" + port
|
||||
}
|
||||
|
||||
private hashMD5(String somethingToHash) {
|
||||
java.security.MessageDigest.getInstance("MD5").digest(somethingToHash.getBytes("UTF-8")).encodeHex().toString()
|
||||
}
|
||||
|
||||
private calcDigestAuth(String method, String uri) {
|
||||
def HA1 = hashMD5("${getUsername}::${getPassword}")
|
||||
def HA2 = hashMD5("${method}:${uri}")
|
||||
def response = hashMD5("${HA1}::::auth:${HA2}")
|
||||
|
||||
'Digest username="'+ getUsername() + '", realm="", nonce="", uri="'+ uri +'", qop=auth, nc=, cnonce="", response="' + response + '", opaque=""'
|
||||
}
|
||||
@@ -0,0 +1,182 @@
|
||||
/**
|
||||
* SmartSense Open/Closed Sensor
|
||||
*
|
||||
* Copyright 2014 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.
|
||||
*
|
||||
*/
|
||||
import physicalgraph.zigbee.clusters.iaszone.ZoneStatus
|
||||
|
||||
metadata {
|
||||
definition(name: "Sensative ZB Strips", namespace: "sensative", author: "SmartThings") {
|
||||
capability "Battery"
|
||||
capability "Configuration"
|
||||
capability "Contact Sensor"
|
||||
capability "Refresh"
|
||||
capability "Temperature Measurement"
|
||||
capability "Health Check"
|
||||
capability "Sensor"
|
||||
|
||||
command "enrollResponse"
|
||||
|
||||
|
||||
fingerprint inClusters: "0000,0001,0003,0402,0500,0020,0B05", outClusters: "0019", manufacturer: "Sensative", model: "Strips-001"
|
||||
fingerprint inClusters: "0000,0001,0003,0402,0500,0020,0B05", outClusters: "0019", manufacturer: "Sensative", model: "Strips-001"
|
||||
fingerprint inClusters: "0000,0001,0003,0020,0402,0500,0B05", outClusters: "0019", manufacturer: "Sensativee", model: "Strips-001", deviceJoinName: "Sensative ZB Strips"
|
||||
|
||||
}
|
||||
|
||||
simulator {
|
||||
|
||||
}
|
||||
|
||||
preferences {
|
||||
input title: "Temperature Offset", description: "This feature allows you to correct any temperature variations by selecting an offset. Ex: If your sensor consistently reports a temp that's 5 degrees too warm, you'd enter \"-5\". If 3 degrees too cold, enter \"+3\".", displayDuringSetup: false, type: "paragraph", element: "paragraph"
|
||||
input "tempOffset", "number", title: "Degrees", description: "Adjust temperature by this many degrees", range: "*..*", displayDuringSetup: false
|
||||
}
|
||||
|
||||
tiles(scale: 2) {
|
||||
multiAttributeTile(name: "contact", type: "generic", width: 6, height: 4) {
|
||||
tileAttribute("device.contact", key: "PRIMARY_CONTROL") {
|
||||
attributeState "open", label: '${name}', icon: "st.contact.contact.open", backgroundColor: "#e86d13"
|
||||
attributeState "closed", label: '${name}', icon: "st.contact.contact.closed", backgroundColor: "#00A0DC"
|
||||
}
|
||||
}
|
||||
|
||||
valueTile("temperature", "device.temperature", inactiveLabel: false, width: 2, height: 2) {
|
||||
state "temperature", label: '${currentValue}°F',
|
||||
backgroundColors: [
|
||||
[value: 31, color: "#153591"],
|
||||
[value: 44, color: "#1e9cbb"],
|
||||
[value: 59, color: "#90d2a7"],
|
||||
[value: 74, color: "#44b621"],
|
||||
[value: 84, color: "#f1d801"],
|
||||
[value: 95, color: "#d04e00"],
|
||||
[value: 96, color: "#bc2323"]
|
||||
]
|
||||
}
|
||||
valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
|
||||
state "battery", label: 'Battery\n${currentValue}%', unit: ""
|
||||
}
|
||||
|
||||
standardTile("refresh", "device.refresh", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
|
||||
state "default", action: "refresh.refresh", icon: "st.secondary.refresh"
|
||||
}
|
||||
|
||||
main(["contact"])
|
||||
details(["contact", "battery", "temperature", "refresh"])
|
||||
}
|
||||
}
|
||||
|
||||
def parse(String description) {
|
||||
log.debug "description: $description"
|
||||
|
||||
Map map = zigbee.getEvent(description)
|
||||
if (!map) {
|
||||
if (description?.startsWith('zone status')) {
|
||||
map = parseIasMessage(description)
|
||||
} else {
|
||||
Map descMap = zigbee.parseDescriptionAsMap(description)
|
||||
if (descMap?.clusterInt == 0x0001 && descMap.commandInt != 0x07 && descMap?.value) {
|
||||
map = getBatteryResult(Integer.parseInt(descMap.value, 16))
|
||||
} else if (descMap?.clusterInt == zigbee.TEMPERATURE_MEASUREMENT_CLUSTER && descMap.commandInt == 0x07) {
|
||||
if (descMap.data[0] == "00") {
|
||||
log.debug "TEMP REPORTING CONFIG RESPONSE: $descMap"
|
||||
sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
|
||||
} else {
|
||||
log.warn "TEMP REPORTING CONFIG FAILED- error code: ${descMap.data[0]}"
|
||||
}
|
||||
}
|
||||
}
|
||||
} else if (map.name == "temperature") {
|
||||
if (tempOffset) {
|
||||
map.value = (int) map.value + (int) tempOffset
|
||||
}
|
||||
map.descriptionText = temperatureScale == 'C' ? '{{ device.displayName }} was {{ value }}°C' : '{{ device.displayName }} was {{ value }}°F'
|
||||
map.translatable = true
|
||||
}
|
||||
|
||||
log.debug "Parse returned $map"
|
||||
def result = map ? createEvent(map) : [:]
|
||||
|
||||
if (description?.startsWith('enroll request')) {
|
||||
List cmds = zigbee.enrollResponse()
|
||||
log.debug "enroll response: ${cmds}"
|
||||
result = cmds?.collect { new physicalgraph.device.HubAction(it) }
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
|
||||
private Map parseIasMessage(String description) {
|
||||
ZoneStatus zs = zigbee.parseZoneStatus(description)
|
||||
return zs.isAlarm1Set() ? getContactResult('open') : getContactResult('closed')
|
||||
}
|
||||
|
||||
private Map getBatteryResult(rawValue) {
|
||||
log.debug 'Battery'
|
||||
def linkText = getLinkText(device)
|
||||
|
||||
def result = [:]
|
||||
|
||||
def volts = rawValue / 10
|
||||
if (!(rawValue == 0 || rawValue == 255)) {
|
||||
def minVolts = 2.1
|
||||
def maxVolts = 3.0
|
||||
def pct = (volts - minVolts) / (maxVolts - minVolts)
|
||||
def roundedPct = Math.round(pct * 100)
|
||||
if (roundedPct <= 0)
|
||||
roundedPct = 1
|
||||
result.value = Math.min(100, roundedPct)
|
||||
result.descriptionText = "${linkText} battery was ${result.value}%"
|
||||
result.name = 'battery'
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
private Map getContactResult(value) {
|
||||
log.debug 'Contact Status'
|
||||
def linkText = getLinkText(device)
|
||||
def descriptionText = "${linkText} was ${value == 'open' ? 'opened' : 'closed'}"
|
||||
return [
|
||||
name : 'contact',
|
||||
value : value,
|
||||
descriptionText: descriptionText
|
||||
]
|
||||
}
|
||||
|
||||
/**
|
||||
* PING is used by Device-Watch in attempt to reach the Device
|
||||
* */
|
||||
def ping() {
|
||||
return zigbee.readAttribute(0x001, 0x0020) // Read the Battery Level
|
||||
}
|
||||
|
||||
def refresh() {
|
||||
log.debug "Refreshing Temperature and Battery"
|
||||
def refreshCmds = zigbee.readAttribute(zigbee.TEMPERATURE_MEASUREMENT_CLUSTER, 0x0000) +
|
||||
zigbee.readAttribute(zigbee.POWER_CONFIGURATION_CLUSTER, 0x0020)
|
||||
|
||||
return refreshCmds + zigbee.enrollResponse()
|
||||
}
|
||||
|
||||
def configure() {
|
||||
// Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
|
||||
// enrolls with default periodic reporting until newer 5 min interval is confirmed
|
||||
sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
|
||||
|
||||
log.debug "Configuring Reporting, IAS CIE, and Bindings."
|
||||
|
||||
// temperature minReportTime 30 seconds, maxReportTime 5 min. Reporting interval if no activity
|
||||
// battery minReport 30 seconds, maxReportTime 6 hrs by default
|
||||
return refresh() + zigbee.batteryConfig() + zigbee.temperatureConfig(30, 300) // send refresh cmds as part of config
|
||||
}
|
||||
@@ -1,384 +0,0 @@
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* BlueIris (LocalConnect2)
|
||||
*
|
||||
* Author: Nicolas Neverov
|
||||
* Date: 2017-04-30
|
||||
*/
|
||||
|
||||
|
||||
definition(
|
||||
name: "BlueIris (LocalConnect2)",
|
||||
namespace: "df",
|
||||
author: "df",
|
||||
description: "BlueIris local integration",
|
||||
category: "Safety & Security",
|
||||
singleInstance: true,
|
||||
iconUrl: "https://graph.api.smartthings.com/api/devices/icons/st.doors.garage.garage-closed",
|
||||
iconX2Url: "https://graph.api.smartthings.com/api/devices/icons/st.doors.garage.garage-closed?displaySize=2x"
|
||||
)
|
||||
|
||||
preferences {
|
||||
page(name: "setup", title: "Blue Iris Setup", content: "pageSetupCallback")
|
||||
page(name: "mode", title: "Blue Iris Modes Setup", content: "renderModePage")
|
||||
page(name: "validate", title: "Blue Iris Setup", content: "pageValidateCallback")
|
||||
|
||||
}
|
||||
|
||||
def switchHandler(evt)
|
||||
{
|
||||
log.debug "setupDevice: switch event: $evt.value"
|
||||
}
|
||||
|
||||
|
||||
private Map getValidators()
|
||||
{
|
||||
return [
|
||||
hostAddress: { addr ->
|
||||
return addr ==~ /\d+\.\d+\.\d+\.\d+(:\d+)?/
|
||||
},
|
||||
mode: { Map p ->
|
||||
def rc = []
|
||||
|
||||
if (p.aProfileApply) {
|
||||
if (p.aProfile == null) {
|
||||
rc.push("Arming profile is required");
|
||||
} else if (p.aProfile < 1 || p.aProfile > 5) {
|
||||
rc.push("Arming profile must be within [1-5] range")
|
||||
}
|
||||
}
|
||||
|
||||
if (p.dProfileApply) {
|
||||
if (p.dProfile == null) {
|
||||
rc.push("Disarming profile is required");
|
||||
} else if (p.dProfile < 1 || p.dProfile > 5) {
|
||||
rc.push("Disarming profile must be within [1-5] range")
|
||||
}
|
||||
}
|
||||
|
||||
def armProfile = p.aProfileApply ? p.aProfile : 0;
|
||||
def disarmProfile = p.dProfileApply ? p.dProfile : 0;
|
||||
if (p.aSignal == p.dSignal && armProfile == disarmProfile && armProfile != null) {
|
||||
rc.push("Arming and disarming signal/profile combinations must differ")
|
||||
}
|
||||
|
||||
return rc
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
def pageSetupCallback()
|
||||
{
|
||||
if (canInstallLabs()) {
|
||||
log.debug("pageSetupCallback: refreshing")
|
||||
|
||||
def v = getValidators()
|
||||
return dynamicPage(name:"setup", title:"Setting up Blue Iris integration", nextPage:"", install: false, uninstall: true) {
|
||||
|
||||
section("New BlueIris Server setup") {
|
||||
input name:"devicename", type:"text", title: "Device name", required:true, defaultValue: "Blue Iris Server"
|
||||
input name:"hub", type:"hub", title: "Hub gateway", required:true
|
||||
input name:"ip", type:"text", title: "IP address:port", required:true, submitOnChange:true
|
||||
if (!v.hostAddress(ip)) {
|
||||
paragraph(required:true, "Please specify valid IP address")
|
||||
}
|
||||
input name:"username", type:"text", title: "Username", required:true, autoCorrect:false
|
||||
input name:"password", type:"password", title: "Password", required:true, autoCorrect:false
|
||||
}
|
||||
if(v.hostAddress(ip)) {
|
||||
section("") {
|
||||
href(title:"Next", description:"", page:"mode", required:true)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} else {
|
||||
|
||||
return dynamicPage(name:"setup", title:"Upgrade needed", nextPage:"", install:false, uninstall: true) {
|
||||
section("Upgrade needed") {
|
||||
paragraph "Hub firmware needs to be upgraded"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private makeProfileInput(inputName)
|
||||
{
|
||||
input(name:inputName.toString(), type:"number", title:"Select profile [1-5]:", range:"1..5", submitOnChange:true, required:true)
|
||||
}
|
||||
|
||||
def renderModePage() {
|
||||
def v = getValidators()
|
||||
|
||||
return dynamicPage(name:"mode", title:"Setting up Blue Iris modes", nextPage:"", install: false, uninstall: true) {
|
||||
section(hideable:true, "Arming modes") {
|
||||
input(name:"armSignal", type:"enum", title:"When Armed, set signal to", options:["Green","N/A"], defaultValue:"Green", submitOnChange:true, required:false)
|
||||
input(name:"armProfileApply", type:"bool", title:"Also, change profile?", defaultValue:false, submitOnChange:true)
|
||||
if (armProfileApply) {
|
||||
makeProfileInput("armProfile")
|
||||
}
|
||||
|
||||
input(name:"disarmSignal", type:"enum", title:"When Disarmed, set signal to", options: ["Red", "N/A"], defaultValue:"Red", submitOnChange:true, required:false)
|
||||
input(name:"disarmProfileApply", type:"bool", title:"Also, change profile?", defaultValue:false, submitOnChange:true)
|
||||
if (disarmProfileApply) {
|
||||
makeProfileInput("disarmProfile")
|
||||
}
|
||||
}
|
||||
|
||||
section(hideable:true, "Location modes") {
|
||||
location.modes.each {mode->
|
||||
input(name:"locationSignal${mode.id}".toString(), type:"enum", title:"When in \"$mode.name\" mode, set signal to", options: ["Green", "Red", "N/A"], defaultValue:"N/A", required:false, submitOnChange:true)
|
||||
input(name:"locationProfileApply${mode.id}".toString(), type:"bool", title:"Also, change profile?", defaultValue:false, required:false, submitOnChange:true)
|
||||
if (settings["locationProfileApply${mode.id}".toString()] == true) {
|
||||
makeProfileInput("locationProfile${mode.id}")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def p = [
|
||||
aSignal: armSignal,
|
||||
aProfileApply: armProfileApply,
|
||||
aProfile: armProfile,
|
||||
dSignal: disarmSignal,
|
||||
dProfileApply: disarmProfileApply,
|
||||
dProfile: disarmProfile
|
||||
]
|
||||
|
||||
def valRc = v.mode(p)
|
||||
if (valRc) {
|
||||
section("Please correct errors:") {
|
||||
valRc.each {err ->
|
||||
paragraph(required:true, "*** $err")
|
||||
}
|
||||
}
|
||||
} else {
|
||||
section("") {
|
||||
href(title:"Next", description:"", page:"validate", required:true)
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
def pageValidateCallback()
|
||||
{
|
||||
if(ip ==~ /\d+\.\d+\.\d+\.\d+(:\d+)?/) {
|
||||
return dynamicPage(name:"validate", title:"Setting up Blue Iris integration", install:true, uninstall:false) {
|
||||
section() {
|
||||
paragraph(
|
||||
image: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience.png",
|
||||
title:"Ready to install",
|
||||
"Press 'Done' to confirm installation"
|
||||
)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
return dynamicPage(name:"validate", title:"Setting up Blue Iris", nextPage:"", install: false, uninstall:false) {
|
||||
section("Error validating setup preferences") {
|
||||
paragraph(
|
||||
image: "https://s3.amazonaws.com/smartapp-icons/Convenience/Cat-Convenience.png",
|
||||
title:"IP Address",
|
||||
required:true,
|
||||
"Should look similar to 111.222.333.555:8001 (port is optional)"
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
def installed()
|
||||
{
|
||||
log.debug("installed: started") //with $settings
|
||||
init()
|
||||
}
|
||||
|
||||
def updated()
|
||||
{
|
||||
log.debug("updated: started"); //with $settings
|
||||
uninit();
|
||||
init()
|
||||
}
|
||||
|
||||
def uninstalled()
|
||||
{
|
||||
|
||||
uninit(false);
|
||||
}
|
||||
|
||||
def init()
|
||||
{
|
||||
if(!state.subscribed) {
|
||||
subscribe(location, "mode", modeChangeHandler)
|
||||
state.subscribed = true
|
||||
}
|
||||
|
||||
state.config = assembleConfig()
|
||||
|
||||
final dni = ipEpToHex(ip)
|
||||
def d = getChildDevice(dni)
|
||||
|
||||
if(d) {
|
||||
log.debug("init: deleting existing BlueIris Server device, dni:$dni")
|
||||
deleteChildDevice(dni)
|
||||
}
|
||||
|
||||
if(true) {
|
||||
log.debug "init: adding new BlueIris Server device, dni:$dni, username:$username, password:*****, gateway hub id:$hub.id"
|
||||
d = addChildDevice("df", "blueiris2", dni, hub.id,
|
||||
[name:"blueiris", label: devicename, completedSetup:true,
|
||||
"preferences":["username":username, "password":password]
|
||||
])
|
||||
d.configure()
|
||||
subscribe(d, "switch", switchHandler)
|
||||
} else {
|
||||
|
||||
log.debug "init: skipping adding BlueIris Server device, dni:$dni - already exists"
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
def uninit(boolean f_unsubscribe = true)
|
||||
{
|
||||
if(state.subscribed) {
|
||||
|
||||
if(f_unsubscribe) {
|
||||
unsubscribe()
|
||||
}
|
||||
|
||||
getAllChildDevices().each {
|
||||
}
|
||||
|
||||
state.subscribed = false
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
def modeChangeHandler(evt)
|
||||
{
|
||||
def f_arm = (evt.value == 'Away')
|
||||
log.debug("modeChangeHandler: detected mode change: $evt.name:$evt.value: ${f_arm ? 'arming' : 'disarming'}")
|
||||
|
||||
def mode = null
|
||||
location.modes.each {m->
|
||||
if (m.name == evt.value) {
|
||||
mode = m
|
||||
}
|
||||
}
|
||||
|
||||
getAllChildDevices().each {
|
||||
it.location(mode.id)
|
||||
}
|
||||
}
|
||||
|
||||
def asyncOpCallback()
|
||||
{
|
||||
log.debug("asyncOpCallback: timeout:$atomicState.asyncOpTimeout, ${now() - atomicState.asyncOpTs}(msec) elapsed")
|
||||
if(atomicState.asyncOpTimeout) {
|
||||
getAllChildDevices().each {
|
||||
it.timeout()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def onBeginAsyncOp(int timeout_ms)
|
||||
{
|
||||
log.debug("onBeginAsyncOp: ${now()}")
|
||||
atomicState.asyncOpTimeout = true
|
||||
atomicState.asyncOpTs = now()
|
||||
runOnce(new Date(now() + timeout_ms), asyncOpCallback, [overwrite: true])
|
||||
}
|
||||
|
||||
def onEndAsyncOp()
|
||||
{
|
||||
log.debug("onEndAsyncOp: ${now()}")
|
||||
atomicState.asyncOpTimeout = false
|
||||
runOnce(new Date(now() + 1), asyncOpCallback, [overwrite: true])
|
||||
}
|
||||
|
||||
def onNotification(msg)
|
||||
{
|
||||
log.debug("sendNotification: sending $msg")
|
||||
sendNotificationEvent(msg)
|
||||
}
|
||||
|
||||
def onGetConfig()
|
||||
{
|
||||
return state.config
|
||||
}
|
||||
|
||||
private assembleConfig()
|
||||
{
|
||||
def getElementCfg = {prefix, id, name ->
|
||||
def signal = settings["${prefix}Signal${id}".toString()]
|
||||
def profileApply = settings["${prefix}ProfileApply${id}".toString()]
|
||||
def profile = settings["${prefix}Profile${id}".toString()]
|
||||
|
||||
return signal != 'N/A' || profileApply ? [
|
||||
name: name,
|
||||
signal: signal == 'N/A' ? null : (signal == "Green"),
|
||||
profile: profileApply ? profile : null
|
||||
] : null
|
||||
}
|
||||
|
||||
def rc = [
|
||||
arming: [
|
||||
arm: getElementCfg('arm', '', 'Arm'),
|
||||
disarm: getElementCfg('disarm', '', 'Disarm')
|
||||
],
|
||||
location: [:]
|
||||
]
|
||||
|
||||
location.modes.each {mode->
|
||||
rc.location["$mode.id".toString()] = getElementCfg('location', mode.id, mode.name)
|
||||
}
|
||||
|
||||
log.info("onGetConfig: assembled config: [$rc]")
|
||||
rc
|
||||
}
|
||||
|
||||
private Boolean canInstallLabs()
|
||||
{
|
||||
return hasAllHubsOver("000.011.00603")
|
||||
}
|
||||
|
||||
private Boolean hasAllHubsOver(String desiredFirmware)
|
||||
{
|
||||
return realHubFirmwareVersions.every { fw -> fw >= desiredFirmware }
|
||||
}
|
||||
|
||||
private List getRealHubFirmwareVersions()
|
||||
{
|
||||
return location.hubs*.firmwareVersionString.findAll { it }
|
||||
}
|
||||
|
||||
private String ipEpToHex(ep) {
|
||||
final parts = ep.split(':');
|
||||
final ipHex = parts[0].tokenize('.').collect{ String.format('%02X', it.toInteger() ) }.join()
|
||||
final portHex = String.format('%04X', (parts[1]?:80).toInteger())
|
||||
|
||||
return "$ipHex:$portHex"
|
||||
}
|
||||
|
||||
|
||||
private String hexToString(String txtInHex)
|
||||
{
|
||||
byte [] txtInByte = new byte [txtInHex.length() / 2];
|
||||
int j = 0;
|
||||
for (int i = 0; i < txtInHex.length(); i += 2)
|
||||
{
|
||||
txtInByte[j++] = Byte.parseByte(txtInHex.substring(i, i + 2), 16);
|
||||
}
|
||||
return new String(txtInByte);
|
||||
}
|
||||
Reference in New Issue
Block a user