mirror of
https://github.com/mtan93/SmartThingsPublic.git
synced 2026-03-28 21:04:16 +00:00
MSA-916: This Device Type and SmartApp integrated the Garadget Device Type enable integration of Smartthings With the Garadget Devices
This commit is contained in:
Stuart
406
devicetypes/fuzzysb/garadget.src/garadget.groovy
Normal file
406
devicetypes/fuzzysb/garadget.src/garadget.groovy
Normal file
@@ -0,0 +1,406 @@
|
||||
/**
|
||||
* Garadget Device Handler
|
||||
*
|
||||
* Copyright 2016 Stuart Buchanan based loosely based on original code by Krishnaraj Varma with thanks
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* 12/02/2016 V1.3 updated with to remove token and DeviceId parameters from inputs to retrieving from dni
|
||||
*/
|
||||
|
||||
|
||||
import groovy.json.JsonOutput
|
||||
|
||||
preferences {
|
||||
input("prdt", "text", title: "sensor scan interval in mS (default: 1000)")
|
||||
input("pmtt", "text", title: "door moving time in mS(default: 10000)")
|
||||
input("prlt", "text", title: "button press time mS (default: 300)")
|
||||
input("prlp", "text", title: "delay between consecutive button presses in mS (default: 1000)")
|
||||
input("psrr", "text", title: "number of sensor reads used in averaging (default: 3)")
|
||||
input("psrt", "text", title: "reflection threshold below which the door is considered open (default: 25)")
|
||||
input("paot", "text", title: "alert for open timeout in seconds (default: 320)")
|
||||
input("pans", "text", title: " alert for night time start in minutes from midnight (default: 1320)")
|
||||
input("pane", "text", title: " alert for night time end in minutes from midnight (default: 360)")
|
||||
}
|
||||
|
||||
metadata {
|
||||
definition (name: "Garadget", namespace: "fuzzysb", author: "Stuart Buchanan") {
|
||||
|
||||
capability "Switch"
|
||||
capability "Contact Sensor"
|
||||
capability "Signal Strength"
|
||||
capability "Actuator"
|
||||
capability "Sensor"
|
||||
capability "Refresh"
|
||||
capability "Polling"
|
||||
capability "Configuration"
|
||||
|
||||
attribute "reflection", "string"
|
||||
attribute "status", "string"
|
||||
attribute "time", "string"
|
||||
attribute "lastAction", "string"
|
||||
attribute "reflection", "string"
|
||||
attribute "ver", "string"
|
||||
|
||||
command "stop"
|
||||
command "statusCommand"
|
||||
command "setConfigCommand"
|
||||
command "doorConfigCommand"
|
||||
command "netConfigCommand"
|
||||
}
|
||||
|
||||
simulator {
|
||||
|
||||
}
|
||||
|
||||
tiles(scale: 2) {
|
||||
multiAttributeTile(name:"status", type: "generic", width: 6, height: 4){
|
||||
tileAttribute ("device.status", key: "PRIMARY_CONTROL") {
|
||||
attributeState "open", label:'${name}', action:"switch.off", icon:"st.doors.garage.garage-open", backgroundColor:"#ffa81e"
|
||||
attributeState "opening", label:'${name}', icon:"st.doors.garage.garage-opening", backgroundColor:"#ffa81e"
|
||||
attributeState "closing", label:'${name}', icon:"st.doors.garage.garage-closing", backgroundColor:"#6699ff"
|
||||
attributeState "closed", label:'${name}', action:"switch.on", icon:"st.doors.garage.garage-closed", backgroundColor:"#79b821"
|
||||
}
|
||||
tileAttribute ("device.lastAction", key: "SECONDARY_CONTROL") {
|
||||
attributeState "default", label: 'Time In State: ${currentValue}'
|
||||
}
|
||||
}
|
||||
standardTile("contact", "device.contact", width: 1, height: 1) {
|
||||
state("open", label:'${name}', icon:"st.contact.contact.open", backgroundColor:"#ffa81e")
|
||||
state("closed", label:'${name}', icon:"st.contact.contact.closed", backgroundColor:"#79b821")
|
||||
}
|
||||
valueTile("reflection", "reflection", decoration: "flat", width: 2, height: 1) {
|
||||
state "reflection", label:'Reflection\r\n${currentValue}%'
|
||||
}
|
||||
valueTile("rssi", "device.rssi", decoration: "flat", width: 1, height: 1) {
|
||||
state "rssi", label:'Wifi\r\n${currentValue} dBm', unit: "",backgroundColors:[
|
||||
[value: 16, color: "#5600A3"],
|
||||
[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"]
|
||||
]
|
||||
}
|
||||
standardTile("refresh", "refresh", inactiveLabel: false, decoration: "flat") {
|
||||
state "default", action:"polling.poll", icon:"st.secondary.refresh"
|
||||
}
|
||||
standardTile("stop", "stop") {
|
||||
state "default", label:"", action: "stop", icon:"http://cdn.device-icons.smartthings.com/sonos/stop-btn@2x.png"
|
||||
}
|
||||
valueTile("ip", "ip", decoration: "flat", width: 2, height: 1) {
|
||||
state "ip", label:'IP Address\r\n${currentValue}'
|
||||
}
|
||||
valueTile("ssid", "ssid", decoration: "flat", width: 2, height: 1) {
|
||||
state "ssid", label:'Wifi SSID\r\n${currentValue}'
|
||||
}
|
||||
valueTile("ver", "ver", decoration: "flat", width: 1, height: 1) {
|
||||
state "ver", label:'Version\r\n${currentValue}'
|
||||
}
|
||||
standardTile("configure", "device.button", width: 1, height: 1, decoration: "flat") {
|
||||
state "default", label: "", backgroundColor: "#ffffff", action: "configure", icon:"st.secondary.configure"
|
||||
}
|
||||
|
||||
main "status"
|
||||
details(["status", "contact", "reflection", "ver", "configure", "lastAction", "rssi", "stop", "ip", "ssid", "refresh"])
|
||||
}
|
||||
}
|
||||
|
||||
// handle commands
|
||||
def poll() {
|
||||
log.debug "Executing 'poll'"
|
||||
refresh()
|
||||
}
|
||||
|
||||
def refresh() {
|
||||
log.debug "Executing 'refresh'"
|
||||
statusCommand()
|
||||
netConfigCommand()
|
||||
doorConfigCommand()
|
||||
|
||||
}
|
||||
|
||||
def configure() {
|
||||
log.debug "Resetting Sensor Parameters to SmartThings Compatible Defaults"
|
||||
SetConfigCommand()
|
||||
}
|
||||
|
||||
// Parse incoming device messages to generate events
|
||||
private parseDoorStatusResponse(resp) {
|
||||
log.debug("Executing parseDoorStatusResponse: "+resp.data)
|
||||
log.debug("Output status: "+resp.status)
|
||||
if(resp.status == 200) {
|
||||
log.debug("returnedresult: "+resp.data.result)
|
||||
def results = (resp.data.result).tokenize('|')
|
||||
def statusvalues = (results[0]).tokenize('=')
|
||||
def timevalues = (results[1]).tokenize('=')
|
||||
def sensorvalues = (results[2]).tokenize('=')
|
||||
def signalvalues = (results[3]).tokenize('=')
|
||||
def status = statusvalues[1]
|
||||
sendEvent(name: 'status', value: status)
|
||||
if(status == "open" || status == "closed"){
|
||||
sendEvent(name: 'contact', value: status)
|
||||
}
|
||||
def time = timevalues[1]
|
||||
sendEvent(name: 'lastAction', value: time)
|
||||
def sensor = sensorvalues[1]
|
||||
sendEvent(name: 'reflection', value: sensor)
|
||||
def signal = signalvalues[1]
|
||||
sendEvent(name: 'rssi', value: signal)
|
||||
|
||||
}else if(resp.status == 201){
|
||||
log.debug("Something was created/updated")
|
||||
}
|
||||
}
|
||||
|
||||
private parseDoorConfigResponse(resp) {
|
||||
log.debug("Executing parseResponse: "+resp.data)
|
||||
log.debug("Output status: "+resp.status)
|
||||
if(resp.status == 200) {
|
||||
log.debug("returnedresult: "+resp.data.result)
|
||||
def results = (resp.data.result).tokenize('|')
|
||||
def vervalues = (results[0]).tokenize('=')
|
||||
def rdtvalues = (results[1]).tokenize('=')
|
||||
def mttvalues = (results[2]).tokenize('=')
|
||||
def rltvalues = (results[3]).tokenize('=')
|
||||
def rlpvalues = (results[4]).tokenize('=')
|
||||
def srrvalues = (results[5]).tokenize('=')
|
||||
def srtvalues = (results[6]).tokenize('=')
|
||||
def aotvalues = (results[7]).tokenize('=')
|
||||
def ansvalues = (results[8]).tokenize('=')
|
||||
def anevalues = (results[9]).tokenize('=')
|
||||
def ver = vervalues[1]
|
||||
sendEvent(name: 'ver', value: ver)
|
||||
log.debug("Firmware Version: "+ver)
|
||||
def rdt = rdtvalues[1]
|
||||
log.debug("Sensor Scan Interval (ms): "+rdt )
|
||||
def mtt = mttvalues[1]
|
||||
state.mtt = mtt
|
||||
sendEvent(name: 'mtt', value: mtt)
|
||||
log.debug("Door Moving Time (ms): "+mtt )
|
||||
def rlt = rltvalues[1]
|
||||
log.debug("Button Press Time (ms): "+rlt )
|
||||
def rlp = rlpvalues[1]
|
||||
log.debug("Delay Between Consecutive Button Presses (ms): "+rlp )
|
||||
def srr = srrvalues[1]
|
||||
log.debug("number of sensor reads used in averaging: "+srr )
|
||||
def srt = srtvalues[1]
|
||||
log.debug("reflection threshold below which the door is considered open: "+srt )
|
||||
def aot = aotvalues[1]
|
||||
log.debug("alert for open timeout in seconds: "+aot )
|
||||
def ans = ansvalues[1]
|
||||
log.debug("alert for night time start in minutes from midnight: "+ans )
|
||||
def ane = anevalues[1]
|
||||
log.debug("alert for night time end in minutes from midnight: "+ane )
|
||||
|
||||
}else if(resp.status == 201){
|
||||
log.debug("Something was created/updated")
|
||||
}
|
||||
}
|
||||
|
||||
private parseNetConfigResponse(resp) {
|
||||
log.debug("Executing parseResponse: "+resp.data)
|
||||
log.debug("Output status: "+resp.status)
|
||||
if(resp.status == 200) {
|
||||
log.debug("returnedresult: "+resp.data.result)
|
||||
def results = (resp.data.result).tokenize('|')
|
||||
def ipvalues = (results[0]).tokenize('=')
|
||||
def snetvalues = (results[1]).tokenize('=')
|
||||
def dgwvalues = (results[2]).tokenize('=')
|
||||
def macvalues = (results[3]).tokenize('=')
|
||||
def ssidvalues = (results[4]).tokenize('=')
|
||||
def ip = ipvalues[1]
|
||||
sendEvent(name: 'ip', value: ip)
|
||||
log.debug("IP Address: "+ip)
|
||||
def snet = snetvalues[1]
|
||||
log.debug("Subnet Mask: "+snet)
|
||||
def dgw = dgwvalues[1]
|
||||
log.debug("Default Gateway: "+dgw)
|
||||
def mac = macvalues[1]
|
||||
log.debug("Mac Address: "+mac)
|
||||
def ssid = ssidvalues[1]
|
||||
sendEvent(name: 'ssid', value: ssid)
|
||||
log.debug("Wifi SSID : "+ssid)
|
||||
}else if(resp.status == 201){
|
||||
log.debug("Something was created/updated")
|
||||
}
|
||||
}
|
||||
|
||||
private parseResponse(resp) {
|
||||
log.debug("Executing parseResponse: "+resp.data)
|
||||
log.debug("Output status: "+resp.status)
|
||||
if(resp.status == 200) {
|
||||
log.debug("Executing parseResponse.successTrue")
|
||||
def id = resp.data.id
|
||||
def name = resp.data.name
|
||||
def connected = resp.data.connected
|
||||
def returnValue = resp.data.return_value
|
||||
}else if(resp.status == 201){
|
||||
log.debug("Something was created/updated")
|
||||
}
|
||||
}
|
||||
|
||||
private getDeviceDetails() {
|
||||
def fullDni = device.deviceNetworkId
|
||||
return fullDni
|
||||
}
|
||||
|
||||
private sendCommand(method, args = []) {
|
||||
def DefaultUri = "https://api.particle.io"
|
||||
def cdni = getDeviceDetails().tokenize(':')
|
||||
def deviceId = cdni[0]
|
||||
def token = cdni[1]
|
||||
def methods = [
|
||||
'doorStatus': [
|
||||
uri: "${DefaultUri}",
|
||||
path: "/v1/devices/${deviceId}/doorStatus",
|
||||
requestContentType: "application/json",
|
||||
query: [access_token: token]
|
||||
],
|
||||
'doorConfig': [
|
||||
uri: "${DefaultUri}",
|
||||
path: "/v1/devices/${deviceId}/doorConfig",
|
||||
requestContentType: "application/json",
|
||||
query: [access_token: token]
|
||||
],
|
||||
'netConfig': [
|
||||
uri: "${DefaultUri}",
|
||||
path: "/v1/devices/${deviceId}/netConfig",
|
||||
requestContentType: "application/json",
|
||||
query: [access_token: token]
|
||||
],
|
||||
'setState': [
|
||||
uri: "${DefaultUri}",
|
||||
path: "/v1/devices/${deviceId}/setState",
|
||||
requestContentType: "application/json",
|
||||
query: [access_token: token],
|
||||
body: args[0]
|
||||
],
|
||||
'setConfig': [
|
||||
uri: "${DefaultUri}",
|
||||
path: "/v1/devices/${deviceId}/setConfig",
|
||||
requestContentType: "application/json",
|
||||
query: [access_token: token],
|
||||
body: args[0]
|
||||
]
|
||||
]
|
||||
|
||||
def request = methods.getAt(method)
|
||||
|
||||
log.debug "Http Params ("+request+")"
|
||||
|
||||
try{
|
||||
log.debug "Executing 'sendCommand'"
|
||||
|
||||
if (method == "doorStatus"){
|
||||
httpGet(request) { resp ->
|
||||
parseDoorStatusResponse(resp)
|
||||
}
|
||||
}else if (method == "doorConfig"){
|
||||
log.debug "calling doorConfig Method"
|
||||
httpGet(request) { resp ->
|
||||
parseDoorConfigResponse(resp)
|
||||
}
|
||||
}else if (method == "netConfig"){
|
||||
log.debug "calling netConfig Method"
|
||||
httpGet(request) { resp ->
|
||||
parseNetConfigResponse(resp)
|
||||
}
|
||||
}else if (method == "setState"){
|
||||
log.debug "calling setState Method"
|
||||
httpPost(request) { resp ->
|
||||
parseResponse(resp)
|
||||
}
|
||||
}else if (method == "setConfig"){
|
||||
log.debug "calling setState Method"
|
||||
httpPost(request) { resp ->
|
||||
parseResponse(resp)
|
||||
}
|
||||
}else{
|
||||
httpGet(request)
|
||||
}
|
||||
} catch(Exception e){
|
||||
log.debug("___exception: " + e)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
def on() {
|
||||
log.debug "Executing 'on'"
|
||||
openCommand()
|
||||
statusCommand()
|
||||
log.info("waiting for ${state.mtt} ms")
|
||||
"delay ${state.mtt}"
|
||||
log.info("Initiating Refresh after Transition time")
|
||||
statusCommand()
|
||||
}
|
||||
|
||||
def off() {
|
||||
log.debug "Executing 'off'"
|
||||
closeCommand()
|
||||
statusCommand()
|
||||
log.info("waiting for ${state.mtt} ms")
|
||||
"delay ${state.mtt}"
|
||||
log.info("Initiating Refresh after Transition time")
|
||||
statusCommand()
|
||||
}
|
||||
|
||||
def stop(){
|
||||
log.debug "Executing 'sendCommand.setState'"
|
||||
def jsonbody = new groovy.json.JsonOutput().toJson(arg:"stop")
|
||||
sendCommand("setState",[jsonbody])
|
||||
statusCommand()
|
||||
}
|
||||
|
||||
def statusCommand(){
|
||||
log.debug "Executing 'sendCommand.statusCommand'"
|
||||
sendCommand("doorStatus",[])
|
||||
}
|
||||
|
||||
def openCommand(){
|
||||
log.debug "Executing 'sendCommand.setState'"
|
||||
def jsonbody = new groovy.json.JsonOutput().toJson(arg:"open")
|
||||
sendCommand("setState",[jsonbody])
|
||||
}
|
||||
|
||||
def closeCommand(){
|
||||
log.debug "Executing 'sendCommand.setState'"
|
||||
def jsonbody = new groovy.json.JsonOutput().toJson(arg:"close")
|
||||
sendCommand("setState",[jsonbody])
|
||||
}
|
||||
|
||||
def doorConfigCommand(){
|
||||
log.debug "Executing 'sendCommand.doorConfig'"
|
||||
sendCommand("doorConfig",[])
|
||||
}
|
||||
|
||||
def SetConfigCommand(){
|
||||
def crdt = prdt ?: 1000
|
||||
def cmtt = pmtt ?: 10000
|
||||
def crlt = prlt ?: 300
|
||||
def crlp = prlp ?: 1000
|
||||
def csrr = psrr ?: 3
|
||||
def csrt = psrt ?: 25
|
||||
def caot = paot ?: 320
|
||||
def cans = pans ?: 1320
|
||||
def cane = pane ?: 360
|
||||
log.debug "Executing 'sendCommand.setConfig'"
|
||||
def jsonbody = new groovy.json.JsonOutput().toJson(arg:"rdt=" + crdt +"|mtt=" + cmtt + "|rlt=" + crlt + "|rlp=" + crlp +"|srr=" + csrr + "|srt=" + csrt)
|
||||
sendCommand("setConfig",[jsonbody])
|
||||
jsonbody = new groovy.json.JsonOutput().toJson(arg:"aot=" + caot + "|ans=" + cans + "|ane=" + cane)
|
||||
sendCommand("setConfig",[jsonbody])
|
||||
}
|
||||
|
||||
def netConfigCommand(){
|
||||
log.debug "Executing 'sendCommand.netConfig'"
|
||||
sendCommand("netConfig",[])
|
||||
}
|
||||
Reference in New Issue
Block a user