-
Notifications
You must be signed in to change notification settings - Fork 4
/
app_code
483 lines (425 loc) · 13.8 KB
/
app_code
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
/**
* Hunter Douglas PowerView Hub SmartApp (service manager)
* Copyright (c) 2017 Johnvey Hwang
* Ported to Hubitat by Steve Borenstein 03/2019
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
definition(
name: "Hunter Douglas PowerView",
namespace: "johnvey",
author: "Johnvey Hwang, Ported by Steve Borestein",
description: "Controls shades and scenes managed by your PowerView hub",
category: "My Apps",
iconUrl: "https://silver-saint.netlify.com/assets/powerview-icon.png",
iconX2Url: "https://silver-saint.netlify.com/assets/powerview-icon-2x.png",
iconX3Url: "https://silver-saint.netlify.com/assets/powerview-icon-3x.png"
)
preferences {
page(name: "singlePagePref")
}
def singlePagePref() {
return dynamicPage(
name: "singlePagePref",
install: canInstall(),
uninstall: true,
refreshInterval: getPrefInterval()
) {
// setup basic connection to hub
section("Hub setup") {
input(
name: "hubIP",
title: "IP Address",
type: "text",
required: false,
submitOnChange: true
)
if (hubIP) {
if (state.hubMAC) {
paragraph(title: "Hub name", "${state.hubName} (${state.hubMAC})")
} else {
paragraph "Fetching hub info..."
}
}
}
// manage hub details
if (hubIP) {
fetchHubInfo()
fetchAllShades()
fetchAllScenes()
def foundShades = getDiscoveredShadeList()
def foundScenes = getDiscoveredSceneList()
def shadeCount = foundShades.size()
def sceneCount = foundScenes.size()
log.info("pref.singlePagePref - shadeCount=$shadeCount, sceneCount=$sceneCount")
section("Shades") {
if (shadeCount > 0) {
input(
name: "selectedShades",
title: "Linked shades (${shadeCount} available)",
type: "enum",
options: foundShades,
multiple: true,
required: false
)
} else {
paragraph "Searching for installed shades..."
}
}
section("Scenes") {
if (sceneCount > 0) {
input(
name: "selectedScenes",
title: "Linked scenes (${sceneCount} available)",
type: "enum",
options: foundScenes,
multiple: true,
required: false
)
} else {
paragraph "Searching for installed scenes..."
}
}
}
}
}
// show the "Done" action only when user has input an IP
def canInstall() {
return state.hubIP ? true : false
}
// TODO: should this back off the refresh rate if we have an IP?
def getPrefInterval() {
return 60
// state.hubIP ? 5 : 15
}
// ----------------------------------------------------------------------------
// utility methods
// ----------------------------------------------------------------------------
// returns the currently active hub ID
def getHubID() {
def hubID
if (myHub) {
hubID = myHub.id
} else {
def hubs = location.hubs.findAll {
//it.type == hubitat.device.HubType.PHYSICAL
it.type == location.hubs.findAll{ t -> t.type == "PHYSICAL" }
}
if (hubs.size() == 1) hubID = hubs[0].id
}
return hubID
}
/**
* Generates a device network ID based that is unique to the active PV hub
*/
def getDeviceId(deviceType, pvId) {
switch (deviceType) {
case 'shade':
case 'scene':
// valid
break
default:
log.error("got invalid deviceType: $deviceType")
return
}
return "$deviceType;${state.hubMAC};${pvId}"
}
/**
* Extracts the device type from the child device DNI, as defined above in
* getDeviceId().
*/
def parseDeviceType(deviceNetworkId) {
return deviceNetworkId.tokenize(';')[0]
}
// ----------------------------------------------------------------------------
// discovery methods
// ----------------------------------------------------------------------------
/**
* Fetches PV hub information
*
* Requires that the user input the `hubIP` value
*/
def fetchHubInfo() {
log.info("fetchHubInfo()")
def DEFAULT_HUB_PORT = 80
if (settings.hubIP) {
state.hubIP = settings.hubIP
state.hubPort = DEFAULT_HUB_PORT
sendRequest('GET', '/api/userdata', null, _fetchHubInfoCallback)
} else {
log.debug("no hubIP set, skipping fetch")
}
}
/**
* Handles base hub info response
*/
def _fetchHubInfoCallback(response) {
def userData = response.json.userData
state.hubName = new String(userData.hubName.decodeBase64())
state.hubMAC = userData.macAddress.replaceAll(":", "")
log.info("_fetchHubInfoCallback(status=${response.status}) hubName=${state.hubName} hubMAC=${state.hubMAC}")
}
/**
* Fetches all managed shade configs
*/
def fetchAllShades() {
return sendRequest('GET', '/api/shades', null, _fetchAllShadesCallback)
}
/**
* Handles response for shade configs
*/
def _fetchAllShadesCallback(response) {
state.discoveredShades = [:]
response.json.shadeData?.each {
// start with the config info from PV
def shadeConfig = it.clone()
// add our custom keys
def shadeLabel = new String(it.name.decodeBase64())
def enumLabel = "${shadeLabel} (${it.id})"
shadeConfig.label = shadeLabel // plain english name
shadeConfig.enumLabel = enumLabel // awkward label for use with prefs
shadeConfig.deviceNetworkId = getDeviceId('shade', it.id)
state.discoveredShades[enumLabel] = shadeConfig
}
log.info "_fetchAllShadesCallback(status=${response.status}) scenes=${state.discoveredShades.keySet()}"
return state.discoveredShades
}
/**
* Returns a flat list of shade names that can be rendered by a list control
*/
def getDiscoveredShadeList() {
def ret = []
state.discoveredShades?.each { key, value ->
ret.add(value.enumLabel)
}
return ret
}
/**
* Returns the device ID associated with an enumLabel
*/
def shadeEnumToId(enumLabel) {
return state.discoveredShades[enumLabel]?.deviceNetworkId
}
/**
* Fetches all managed scene configs
*/
def fetchAllScenes() {
return sendRequest('GET', '/api/scenes', null, _fetchAllScenesCallback)
}
/**
* Handles response for scene configs
*/
def _fetchAllScenesCallback(response) {
state.discoveredScenes = [:]
response.json.sceneData?.each {
// start with the config info from PV
def sceneConfig = it.clone()
// add our custom keys
def sceneLabel = new String(it.name.decodeBase64())
def enumLabel = "${sceneLabel} (${it.id})"
sceneConfig.label = sceneLabel // plain english name
sceneConfig.enumLabel = enumLabel // awkward label for use with prefs
sceneConfig.deviceNetworkId = getDeviceId('scene', it.id)
state.discoveredScenes[enumLabel] = sceneConfig
}
log.info "_fetchAllScenesCallback(status=${response.status}) scenes=${state.discoveredScenes.keySet()}"
return state.discoveredScenes
}
/**
* Returns a flat list of scene names that can be rendered by a list control
*/
def getDiscoveredSceneList() {
def ret = []
state.discoveredScenes?.each { key, value ->
ret.add(value.enumLabel)
}
return ret
}
/**
* Returns the device ID associated with an enumLabel
*/
def sceneEnumToId(enumLabel) {
return state.discoveredScenes[enumLabel]?.deviceNetworkId
}
// ----------------------------------------------------------------------------
// device handler methods
// ----------------------------------------------------------------------------
/**
* Install the shades that the user selected in the config
*/
def installSelectedShades() {
log.info("installSelectedShades() selectedShades=${settings.selectedShades}")
// remove the shades that are installed but are not checked by the user
def toRemove = getDiscoveredShadeList() - settings.selectedShades
toRemove?.each {
def deviceId = shadeEnumToId(it)
log.info("Remove shade deviceId=$deviceId")
try {
deleteChildDevice(deviceId)
} catch (e) {
log.warn(e)
}
}
// state.addedShadeIds = []
// iterate over the enum label
settings.selectedShades?.each {
installShade(it)
}
}
/**
* Installs an individual shade device handler
*/
def installShade(enumLabel) {
// get shade info already fetched
def shadeInfo = state.discoveredShades.get(enumLabel)
if (!shadeInfo) {
log.error("installShade failed; did not find $enumLabel in state.discoveredShades")
return
}
// check if device is already installed
def currentChildDevices = getChildDevices()
def selectedDevice = currentChildDevices.find { shadeInfo.deviceNetworkId }
def dev
if (selectedDevice) {
dev = getChildDevices()?.find {
it.deviceNetworkId == shadeInfo.deviceNetworkId
}
}
if (!dev) {
def addedDevice = addChildDevice(
"johnvey",
"Hunter Douglas PowerView Shade",
shadeInfo.deviceNetworkId,
getHubID(),
[name: shadeInfo.id, label: shadeInfo.label, completedSetup: true]
)
log.info "ADDED: label=${shadeInfo.label} deviceId=${shadeInfo.deviceNetworkId}"
} else {
log.info("SKIP: deviceId=${shadeInfo.deviceNetworkId}")
}
}
/**
* Install the scenes that the user selected in the config
*/
def installSelectedScenes() {
log.info("installSelectedScenes() selectedScenes=${settings.selectedScenes}")
// remove the scenes that are installed but are not checked by the user
def toRemove = getDiscoveredSceneList() - settings.selectedScenes
toRemove?.each {
def deviceId = sceneEnumToId(it)
log.info("Remove scene deviceId=$deviceId")
try {
deleteChildDevice(deviceId)
} catch (e) {
log.warn(e)
}
}
// iterate over the enum label
settings.selectedScenes?.each {
installScene(it)
}
}
/**
* Installs an individual scene device handler
*/
def installScene(enumLabel) {
// get scene info already fetched
def sceneInfo = state.discoveredScenes.get(enumLabel)
if (!sceneInfo) {
log.error("installScene failed; did not find $enumLabel in state.discoveredScenes")
return
}
// check if device is already installed
def currentChildDevices = getChildDevices()
log.debug("current child devices: ${currentChildDevices}")
def selectedDevice = currentChildDevices.find { sceneInfo.deviceNetworkId }
def dev
if (selectedDevice) {
dev = getChildDevices()?.find {
it.deviceNetworkId == sceneInfo.deviceNetworkId
}
}
if (!dev) {
def addedDevice = addChildDevice(
"johnvey",
"Hunter Douglas PowerView Scene",
sceneInfo.deviceNetworkId,
getHubID(),
[name: sceneInfo.id, label: sceneInfo.label, completedSetup: true]
)
// log the ID to the app for later use
state.addedSceneIds = state.addedSceneIds ?: []
state.addedSceneIds.add(sceneInfo.deviceNetworkId)
log.info "ADDED: label=${sceneInfo.label} deviceId=${sceneInfo.deviceNetworkId}"
} else {
log.debug("SKIP: deviceId=${sceneInfo.deviceNetworkId}")
}
}
def removeAddedScenes() {
state.addedSceneIds?.each {
log.info("Remove scene deviceId=$it")
deleteChildDevice(it)
}
state.addedSceneIds = []
}
// ----------------------------------------------------------------------------
// HTTP methods
// ----------------------------------------------------------------------------
private sendRequest(method, path, body='', callbackFn) {
def host = state.hubIP
def port = state.hubPort
def hubAction = new hubitat.device.HubAction(
[
method: method,
path: path,
HOST: "$host:$port",
headers: [
'HOST': "$host:$port",
'Content-Type': 'application/json'
],
body: body
],
null,
[ callback: callbackFn ]
)
log.debug("sendRequest: $method $host:$port$path")
sendHubCommand(hubAction)
}
// ----------------------------------------------------------------------------
// app lifecycle hooks
// ----------------------------------------------------------------------------
/**
* called when SmartApp is first added; is a no-op here becuase we handle
* everything via updated()
*/
def installed() {
log.info "CMD installed"
}
/**
* called when SmartApp pref pane clicked 'done'
*/
def updated() {
log.info "CMD updated"
installSelectedShades()
installSelectedScenes()
}
/**
* Called when SmartApp is removed
*/
def uninstalled() {
log.info "CMD uninstalled"
getChildDevices().each {
deleteChildDevice(it.deviceNetworkId)
}
}