-
Notifications
You must be signed in to change notification settings - Fork 0
/
MyEcobeeInit.groovy
637 lines (515 loc) · 19.4 KB
/
MyEcobeeInit.groovy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
/**
* My ecobee Init (Service Manager)
*
* Author: scott
* Date: 2013-08-07
*
* Last Modification:
* JLH - 01-23-2014 - Update for Correct SmartApp URL Format
* JLH - 02-15-2014 - Fuller use of ecobee API
* Y.Racine Nov 2014 - Simplified the Service Manager as much as possible to reduce tight coupling with
* its child device types (device handlers) for better performance and reliability.
* linkedIn profile: ca.linkedin.com/pub/yves-racine-m-sc-a/0/406/4b/
**/
definition(
name: "MyEcobeeInit",
namespace: "yracine",
author: "Yves Racine",
description: "Connect your Ecobee thermostat to SmartThings.",
category: "My Apps",
iconUrl: "https://s3.amazonaws.com/smartapp-icons/Partner/ecobee.png",
iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Partner/ecobee@2x.png"
)
preferences {
page(name: "about", title: "About", nextPage: "auth")
page(name: "auth", title: "ecobee", content:"authPage", nextPage:"deviceList")
page(name: "deviceList", title: "ecobee", content:"ecobeeDeviceList",nextPage: "otherSettings")
page(name: "otherSettings", title: "Other Settings", content:"otherSettings", install:true)
/*
Removed the 2nd page as this is not efficient workaround for the ST max execution time constraint
page(name: "deviceList2", title: "ecobee", content:"ecobeeDeviceList2", install:true)
*/
}
mappings {
path("/swapToken") {
action: [
GET: "swapToken"
]
}
}
def about() {
dynamicPage(name: "about", install: false, uninstall: true) {
section("About") {
paragraph "My Ecobee Init, the smartapp that connects your Ecobee thermostat to SmartThings via cloud-to-cloud integration"
paragraph "Version 2.0.4\n\n" +
paragraph "If you like this smartapp, please support the developer via PayPal and click on the Paypal link below "
href url: "https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=yracine%40yahoo%2ecom&lc=US&item_name=Maisons%20ecomatiq&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest",
title:"Paypal donation..."
paragraph "Copyright©2014 Yves Racine"
href url:"http://github.com/yracine/device-type.myecobee", style:"embedded", required:false, title:"More information...",
description: "http://github.com/yracine/device-type.myecobee"
}
}
}
def otherSettings() {
dynamicPage(name: "otherSettings", title: "Other Settings", install: true, uninstall: false) {
section("Polling at which interval in minutes (range=[5..59],default=10 min.)?") {
input "givenInterval", "number", title:"Interval", required: false
}
section("Notifications") {
input "sendPushMessage", "enum", title: "Send a push notification?", metadata: [values: ["Yes", "No"]], required:
false
input "phoneNumber", "phone", title: "Send a text message?", required: false
}
section([mobileOnly:true]) {
label title: "Assign a name for this SmartApp", required: false
}
}
}
def authPage() {
log.debug "authPage(),state.oauthTokenProvided=${state?.oauthTokenProvided}"
if (!atomicState.accessToken) {
log.debug "about to create access token"
createAccessToken()
atomicState.accessToken = state.accessToken
}
def description = "Required"
def uninstallAllowed = false
if (atomicState.authToken) {
// TODO: Check if it's valid
if (true) {
description = "You are connected."
uninstallAllowed = true
state?.oauthTokenProvided=true
} else {
description = "Required" // Worth differentiating here vs. not having atomicState.authToken?
}
}
def redirectUrl = oauthInitUrl()
log.debug "authPage>atomicState.authToken=${atomicState.authToken},state.oauthTokenProvided=${state?.oauthTokenProvided}, RedirectUrl = ${redirectUrl}"
// get rid of next button until the user is actually auth'd
if (!state?.oauthTokenProvided) {
return dynamicPage(name: "auth", title: "Login", nextPage:null, uninstall:uninstallAllowed, submitOnChange: true) {
section(){
paragraph "Tap below to log in to the ecobee portal and authorize SmartThings access. Be sure to scroll down on page 2 and press the 'Allow' button."
href url:redirectUrl, style:"embedded", required:true, title:"ecobee", description:description
}
}
} else {
return dynamicPage(name: "auth", title: "Log In", nextPage:"deviceList", uninstall:uninstallAllowed,submitOnChange: true) {
section(){
paragraph "Tap Next to continue to setup your thermostats."
href url:redirectUrl, style:"embedded", state:"complete", title:"ecobee", description:description
}
}
}
}
def ecobeeDeviceList() {
log.debug "ecobeeDeviceList()"
def stats = getEcobeeThermostats()
log.debug "device list: $stats"
def ems = getEcobeeThermostats("ems")
log.debug "device list: $ems"
stats = stats + ems
/*
def p = dynamicPage(name: "deviceList", title: "Select Your Thermostats", nextPage: "deviceList2") {
*/
def p = dynamicPage(name: "deviceList", title: "Select Your Thermostats", uninstall: true) {
section(""){
paragraph "Tap below to see the list of ecobee thermostats available in your ecobee account and select the ones you want to connect to SmartThings (3 max)."
input(name: "thermostats", title:"", type: "enum", required:true, multiple:true, description: "Tap to choose", metadata:[values:stats])
}
}
log.debug "list p: $p"
return p
}
def ecobeeDeviceList2() {
log.debug "ecobeeDeviceList2()"
def stats = getEcobeeThermostats()
log.debug "device list: $stats"
def ems = getEcobeeThermostats("ems")
log.debug "device list: $ems"
stats = stats + ems
def p = dynamicPage(name: "deviceList2", title: "Select Your Thermostats", uninstall: true) {
section(""){
paragraph "page 2: select the ones you want to connect to SmartThings (3 max per page due to ST execution time constraints)."
input(name: "thermostats", title:"", type: "enum", required:true, multiple:true, description: "Tap to choose", metadata:[values:stats])
}
}
log.debug "list p: $p"
return p
}
def getEcobeeThermostats(String type="") {
log.debug "getting device list"
def msg
def requestBody
if ((type == "") || (type == null)) {
requestBody = '{"selection":{"selectionType":"registered","selectionMatch":""}}'
} else {
requestBody = '{"selection":{"selectionType":"managementSet","selectionMatch":"/"}}'
}
def deviceListParams = [
uri: "https://api.ecobee.com",
path: "/1/thermostat",
headers: ["Content-Type": "text/json", "Authorization": "Bearer ${atomicState.authToken}"],
query: [format: 'json', body: requestBody]
]
log.debug "_______AUTH______ ${atomicState.authToken}"
log.debug "device list params: $deviceListParams"
def stats = [:]
try {
httpGet(deviceListParams) { resp ->
if (resp.status == 200) {
resp.data.thermostatList.each { stat ->
def dni = [ app.id, stat.name, stat.identifier ].join('.')
stats[dni] = getThermostatDisplayName(stat)
}
} else {
log.debug "http status: ${resp.status}"
//refresh the auth token
if (resp.status == 500 && resp.data.status.code == 14) {
log.debug "Storing the failed action to try later"
data.action = "getEcobeeThermostats"
log.error "getEcobeeThermostats>Need to refresh your auth_token!"
state?.msg ="Need to refresh your authorization token!"
log.error state.msg
runIn(30, "sendMsgWithDelay")
atomicState.authToken= null
} else {
log.error "getEcobeeThermostats>Authentication error, invalid authentication method, lack of credentials, etc."
}
}
}
} catch (java.net.UnknownHostException e) {
state?.msg ="Unknown host - check the URL " + deviceListParams.uri
log.error state.msg
runIn(30, "sendMsgWithDelay")
} catch (java.net.NoRouteToHostException t) {
state?.msg= "No route to host - check the URL " + deviceListParams.uri
log.error state.msg
runIn(30, "sendMsgWithDelay")
} catch (java.io.IOException e) {
log.debug "getEcobeeThermostats>$e while getting list of thermostats, probable cause: not the right account for this type (${type}) of thermostat " +
deviceListParams
} catch (e) {
state?.msg= "exception $e while getting list of thermostats"
log.error state.msg
runIn(30, "sendMsgWithDelay")
}
log.debug "thermostats: $stats"
return stats
}
def setParentAuthTokens(auth_data) {
/*
For Debugging purposes, due to the fact that logging is not working when called (separate thread)
send("setParentAuthTokens>begin auth_data: $auth_data")
*/
atomicState.refreshToken = auth_data?.refresh_token
atomicState.authToken = auth_data?.access_token
atomicState.expiresIn=auth_data?.expires_in
atomicState.tokenType = auth_data?.token_type
atomicState.authexptime= auth_data?.authexptime
refreshAllChildAuthTokens()
/*
For Debugging purposes, due to the fact that logging is not working when called (separate thread)
send("setParentAuthTokens>New atomicState: $atomicState")
*/
}
def refreshAllChildAuthTokens() {
/*
For Debugging purposes, due to the fact that logging is not working when called (separate thread)
send("refreshAllChildAuthTokens>begin updating children with $atomicState")
*/
def children= getChildDevices()
/*
For Debugging purposes, due to the fact that logging is not working when called (separate thread)
send("refreshAllChildAuthtokens> refreshing ${children.size()} thermostats")
*/
children.each {
/*
For Debugging purposes, due to the fact that logging is not working when called (separate thread)
send("refreshAllChildAuthTokens>begin updating $it.deviceNetworkId with $atomicState")
*/
it.refreshChildTokens(atomicState)
}
}
def refreshThisChildAuthTokens(child) {
/*
For Debugging purposes, due to the fact that logging is not working when called (separate thread)
send("refreshThisChildAuthTokens>begin child id: ${child.device.deviceNetworkId}, updating it with ${atomicState}")
*/
child.refreshChildTokens(atomicState)
/*
For Debugging purposes, due to the fact that logging is not working when called (separate thread)
send("refreshThisChildAuthTokens>end")
*/
}
def getThermostatDisplayName(stat) {
log.debug "getThermostatDisplayName"
if(stat?.name) {
return stat.name.toString()
}
return (getThermostatTypeName(stat) + " (${stat.identifier})").toString()
}
def getThermostatId(stat) {
log.debug "getThermostatId"
return (stat?.idenfifier)
}
def getThermostatTypeName(stat) {
log.debug "getThermostatTypeName"
return stat.modelNumber == "siSmart" ? "Smart Si" : (stat.modelNumber=="idtSmart") ? "Smart" : (stat.modelNumber=="athenaSmart") ? "Ecobee3" : "Ems"
}
def installed() {
log.debug "Installed with settings: ${settings}"
initialize()
}
def updated() {
log.debug "Updated with settings: ${settings}"
unsubscribe()
unschedule()
initialize()
}
private def delete_child_devices() {
def delete
// Delete any that are no longer in settings
if(!thermostats) {
log.debug "delete_child_devices>delete all ecobee thermostats"
delete = getAllChildDevices()
} else {
delete = getChildDevices().findAll { !thermostats.contains(it.deviceNetworkId) }
}
try {
delete.each { deleteChildDevice(it.deviceNetworkId) }
log.debug "delete_child_devices>deleting ${delete.size()} ecobee thermostats"
} catch (e) {
log.debug "delete_child_devices>exception $e while deleting ${delete.size()} ecobee thermostats"
}
}
private def create_child_devices() {
int i =0
def devices = thermostats.collect { dni ->
def d = getChildDevice(dni)
log.debug "create_child_devices>looping thru thermostats, found id $dni"
if(!d) {
def tstat_info = dni.tokenize('.')
def thermostatId = tstat_info.last()
def name = tstat_info[1]
/*
i++ // Used to simulate many thermostats
def labelName = 'My ecobee ' + "${name}_${i}"
*/
def labelName = 'My ecobee ' + "${name}"
log.debug "create_child_devices>about to create child device with id $dni, thermostatId = $thermostatId, name= ${name}"
d = addChildDevice(getChildNamespace(), getChildName(), dni, null,
[label: "${labelName}"])
d.initialSetup( getSmartThingsClientId(), atomicState, thermostatId ) // initial setup of the Child Device
log.debug "create_child_devices>created ${d.displayName} with id $dni"
} else {
log.debug "create_child_devices>found ${d.displayName} with id $dni already exists"
}
}
log.debug "create_child_devices>created ${devices.size()} thermostats"
}
def initialize() {
log.debug "initialize"
state?.exceptionCount=0
state?.msg=null
delete_child_devices()
create_child_devices()
takeAction()
Integer delay = givenInterval ?: 10 // By default, do it every 10 min.
if ((delay < 5) || (delay>59)) {
state?.msg= "MyEcobeeInit>scheduling interval not in range (${delay} min), exiting..."
log.debug state.msg
runIn(30, "sendMsgWithDelay")
return
}
log.trace "initialize>setting poll to ${delay}"
schedule("0 0/${delay} * * * ?", takeAction)
}
def takeAction() {
log.trace "takeAction>begin"
def msg, exceptionCheck
def MAX_EXCEPTION_COUNT=5
def devices = thermostats.collect { dni ->
def d = getChildDevice(dni)
log.debug "takeAction>Looping thru thermostats, found id $dni, about to poll"
try {
d.poll()
exceptionCheck = d.currentVerboseTrace.toString()
if ((exceptionCheck.contains("exception") || (exceptionCheck.contains("error")) &&
(!exceptionCheck.contains("Java.util.concurrent.TimeoutException")))) {
// check if there is any exception or an error reported in the verboseTrace associated to the device (except the ones linked to rate limiting).
state.exceptionCount=state.exceptionCount+1
log.error "found exception/error after polling, exceptionCount= ${state?.exceptionCount}: $exceptionCheck"
} else {
// reset exception counter
state?.exceptionCount=0
}
} catch (e) {
state.exceptionCount=state.exceptionCount+1
log.error "MyEcobeeInit>exception $e while trying to poll the device $d, exceptionCount= ${state?.exceptionCount}"
}
}
if ((state?.exceptionCount>=MAX_EXCEPTION_COUNT) || (exceptionCheck.contains("Unauthorized"))) {
// need to authenticate again
atomicState.authToken=null
state?.oauthTokenProvided=false
msg="too many exceptions/errors or unauthorized exception, $exceptionCheck (${state?.exceptionCount} errors), press on 'ecobee' and re-login..."
send "MyEcobeeInit> ${msg}"
log.error msg
}
log.trace "takeAction>end"
}
private void sendMsgWithDelay() {
if (state?.msg) {
send "MyEcobeeInit> ${state.msg}"
}
}
private send(msg) {
if (sendPushMessage != "No") {
log.debug("sending push message")
sendPush(msg)
}
if (phoneNumber) {
log.debug("sending text message")
sendSms(phoneNumber, msg)
}
log.debug msg
}
def oauthInitUrl() {
log.debug "oauthInitUrl"
def stcid = getSmartThingsClientId();
atomicState.oauthInitState = UUID.randomUUID().toString()
def oauthParams = [
response_type: "code",
scope: "ems,smartWrite",
client_id: stcid,
state: atomicState.oauthInitState,
redirect_uri: buildRedirectUrl()
]
return "https://api.ecobee.com/authorize?" + toQueryString(oauthParams)
}
def buildRedirectUrl() {
log.debug "buildRedirectUrl: ${serverUrl}/api/token/${atomicState.accessToken}/smartapps/installations/${app.id}/swapToken"
return serverUrl + "/api/token/${atomicState.accessToken}/smartapps/installations/${app.id}/swapToken"
}
def swapToken() {
log.debug "swapping token: $params"
debugEvent ("swapping token: $params", true)
def code = params.code
def oauthState = params.state
def stcid = getSmartThingsClientId()
def tokenParams = [
grant_type: "authorization_code",
code: params.code,
client_id: stcid,
redirect_uri: buildRedirectUrl()
]
def tokenUrl = "https://api.ecobee.com/token?" + toQueryString(tokenParams)
log.debug "Swapping token $params"
def jsonMap
httpPost(uri:tokenUrl) { resp ->
jsonMap = resp.data
}
log.debug "Swapped token for $jsonMap"
debugEvent ("swapped token for $jsonMap", true)
atomicState.refreshToken = jsonMap.refresh_token
atomicState.authToken = jsonMap.access_token
atomicState.expiresIn=jsonMap.expires_in
atomicState.tokenType = jsonMap.token_type
def authexptime = new Date((now() + (atomicState.expiresIn * 60 * 1000))).getTime()
atomicState.authexptime = authexptime
def html = """
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=640">
<title>Withings Connection</title>
<style type="text/css">
@font-face {
font-family: 'Swiss 721 W01 Thin';
src: url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-thin-webfont.eot');
src: url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-thin-webfont.eot?#iefix') format('embedded-opentype'),
url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-thin-webfont.woff') format('woff'),
url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-thin-webfont.ttf') format('truetype'),
url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-thin-webfont.svg#swis721_th_btthin') format('svg');
font-weight: normal;
font-style: normal;
}
@font-face {
font-family: 'Swiss 721 W01 Light';
src: url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-light-webfont.eot');
src: url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-light-webfont.eot?#iefix') format('embedded-opentype'),
url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-light-webfont.woff') format('woff'),
url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-light-webfont.ttf') format('truetype'),
url('https://s3.amazonaws.com/smartapp-icons/Partner/fonts/swiss-721-light-webfont.svg#swis721_lt_btlight') format('svg');
font-weight: normal;
font-style: normal;
}
.container {
width: 560px;
padding: 40px;
/*background: #eee;*/
text-align: center;
}
img {
vertical-align: middle;
}
img:nth-child(2) {
margin: 0 30px;
}
p {
font-size: 2.2em;
font-family: 'Swiss 721 W01 Thin';
text-align: center;
color: #666666;
padding: 0 40px;
margin-bottom: 0;
}
/*
p:last-child {
margin-top: 0px;
}
*/
span {
font-family: 'Swiss 721 W01 Light';
}
</style>
</head>
<body>
<div class="container">
<img src="https://s3.amazonaws.com/smartapp-icons/Partner/ecobee%402x.png" width="216" height="216" alt="ecobee icon" />
<img src="https://s3.amazonaws.com/smartapp-icons/Partner/support/connected-device-icn%402x.png" alt="connected device icon" />
<img src="https://s3.amazonaws.com/smartapp-icons/Partner/support/st-logo%402x.png" alt="SmartThings logo" />
<p>Your ecobee Account is now connected to SmartThings!</p>
<p>Click 'Done' to finish setup.</p>
</div>
</body>
</html>
"""
render contentType: 'text/html', data: html
}
def getChildDeviceIdsString() {
return thermostats.collect { it.split(/\./).last() }.join(',')
}
def toJson(Map m) {
return new org.codehaus.groovy.grails.web.json.JSONObject(m).toString()
}
def toQueryString(Map m) {
return m.collect { k, v -> "${k}=${URLEncoder.encode(v.toString())}" }.sort().join("&")
}
def getChildNamespace() { "yracine" }
def getChildName() { "My Ecobee Device" }
//def getServerUrl() { return "https://graph.api.smartthings.com" }
def getServerUrl() { return getApiServerUrl() }
def getSmartThingsClientId() { "qqwy6qo0c2lhTZGytelkQ5o8vlHgRsrO" }
def debugEvent(message, displayEvent) {
def results = [
name: "appdebug",
descriptionText: message,
displayed: displayEvent
]
log.debug "Generating AppDebug Event: ${results}"
sendEvent (results)
}