-
Notifications
You must be signed in to change notification settings - Fork 0
/
device-type.lightify-dimming-switch.groovy
610 lines (547 loc) · 17.6 KB
/
device-type.lightify-dimming-switch.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
/**
* SmartThings Lightify Dimmer Switch support
* Copyright (C) 2016 Adam Outler
*
* 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/>.
*
*/
/**
* Command reference
* on 'catchall: 0104 0006 01 01 0140 00 3A68 01 00 0000 01 00 '
* off 'catchall: 0104 0006 01 01 0140 00 3A68 01 00 0000 00 00 '
* held up 'catchall: 0104 0008 01 01 0140 00 3A68 01 00 0000 05 00 0032'
* held down 'catchall: 0104 0008 01 01 0140 00 3A68 01 00 0000 01 00 0132'
* released 'catchall: 0104 0008 01 01 0140 00 3A68 01 00 0000 03 00 '
*/
/**
*sets up fingerprint for autojoin
*sets up commands for polling and others
*sets up capabilities
*sets up variables
*/
metadata {
definition(name: "Lightify Dimming Switch- Zigbee", namespace: "adamoutler", author: "Adam Amber House") {
capability "Battery"
capability "Button"
capability "Switch Level"
attribute "State Array", "string"
attribute 'Awesomeness Level', "string"
attribute 'state', "string"
command "refresh"
command "poll"
command "toggle"
command "configure"
command "installed"
fingerprint profileId: "0104", deviceId: "0001", inClusters: "0000, 0001, 0003, 0020, 0402, 0B05", outClusters: "0003, 0006, 0008, 0019", manufacturer: "OSRAM", model: "LIGHTIFY Dimming Switch", deviceJoinName: "OSRAM Lightify Dimming Switch"
}
simulator {
// Simulations are for loosers, work in production :D
}
preferences {
section("Device1") {
input("device1", "string", title: "Device Network ID 1", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
input("end1", "string", title: "Device Endpoint ID 1", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
}
section("Device2") {
input("device2", "string", title: "Device Network ID 2", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
input("end2", "string", title: "Device Endpoint ID 2", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
}
section("Device3") {
input("device3", "string", title: "Device Network ID 3", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
input("end3", "string", title: "Device Endpoint ID 3", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
}
section("Device4") {
input("device4", "string", title: "Device Network ID 4", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
input("end4", "string", title: "Device Endpoint ID 4", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
}
section("Device5") {
input("device5", "string", title: "Device Network ID 5", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
input("end5", "string", title: "Device Endpoint ID 5", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
}
}
/**
*UI tile definitions
*/
tiles(scale: 2) {
standardTile("button", "device.state", width: 6, height: 4) {
state "off", label: 'Off', action: "toggle", icon: "st.switches.switch.off", backgroundColor: "#ffffff", nextState: "turningOn"
state "on", label: "On", action: "toggle", icon: "st.switches.switch.on", backgroundColor: "#79b821", nextState: "turningOff"
state "turningOn", label: 'Turning on', icon: "st.switches.switch.on", backgroundColor: "#79b821", nextState: "turningOff"
state "turningOff", label: 'Turning off', icon: "st.switches.switch.off", backgroundColor: "#ffffff", nextState: "turningOn"
}
valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
state "battery", label: 'battery ${currentValue}%'
}
valueTile("brightness", "device.level", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
state "brightness", label: 'brightness\n${currentValue}%'
}
standardTile("refresh", "device.button", decoration: "flat", width: 2, height: 2) {
state "default", label: "", action: "refresh", icon: "st.secondary.refresh"
}
controlTile("levelSliderControl", "device.level", "slider", height: 2, width: 6, inactiveLabel: false, range:"(1..100)") {
state "level", action:"setLevel"
}
main "button"
details(["button", "levelSliderControl", "switch", "battery", "brightness", "refresh"])
}
}
/**
*returns a map representing important states
*/
private Map getStatus() {
return [name: 'button',
brightness: state.brightness,
battery: state.battery,
value: state.value,
level: state.level,
lastAction: state.lastAction,
on: state.on,
data: '',
descriptionText: "$device.displayName button $state.buttonNumber was $value"
]
}
/**
*Gets a list of devices in [address,endpoint] format compiled from inputs above
*returns: Arraylist<[address,endpoint]>
*/
final ArrayList < String[] > getDevices() {
String[] devs = [settings.device1, device2, device3, device4, device5]
if (devs == [null, null, null, null, null]) log.info("------No devices configured in $device preferences--------")
String[] ends = [end1, end2, end3, end4, end5]
ArrayList < String[] > list = new ArrayList < > ([])
for (int i = 0; i < 4; i++) {
if (devs[i] != null) {
list.add([devs[i], ends[i]])
}
}
return list
}
/**
*Parse events into attributes.
*/
def parse(String msgFromST) {
log.debug(msgFromST)
if (msgFromST?.startsWith('catchall:')) {
def value = handleMessage(msgFromST)
fireCommands(value.command)
} else if (msgFromST.startsWith("read")) {
if (msgFromST.contains("attrId: 0000")) return state
if (msgFromST.contains("attrId: 0020,")) return batteryHandler(zigbee.parseDescriptionAsMap(msgFromST))
log.error('unrecognized command:' + msgFromST)
} else {
log.error('unrecognized command:' + msgFromST)
}
return getStatus()
}
/**
*fire commands into the hub
*commands - an array of string commands to be fired
*/
private fireCommands(List commands) {
if (commands != null && commands.size() > 0) {
log.trace("Executing commands-- state:" + state + " commands:" + commands)
for (String value : commands){
sendHubCommand([value].collect {new physicalgraph.device.HubAction(it)
})
}
}
}
Map handleMessage(String msgFromST) {
Map msg = zigbee.parseDescriptionAsMap(msgFromST)
switch (Integer.parseInt(msg.clusterId)) {
case 6: //button press
def returnval = handleButtonPress(msg)
return returnval
break
case 8:
handleButtonHeld(msg)
break
case 8021:
log.info("Networking Bind Response received!!!")
updateButtonState("Network binding complete!")
state.boundnetwork=true
return state
break
case 8034:
log.info("Network managment Leave Response!!!")
state.boundnetwork=false
return state
break
default:
log.error("Unhandled message: " + msg)
break
}
}
/**
* This is the handler for button presses. Map is routed here once a button press has been detected
*/
def Map handleButtonPress(Map msg) {
switch (msg.command) {
case "01":
def returnval = on()
updateButtonState("on")
return returnval
break
case "03":
bothButtonsPressed()
break
case "00":
def returnval = off()
updateButtonState("off")
return returnval
break
case "07":
log.info("Button Press Bind Response!!!")
state.boundonoff=true
return state
break
default:
log.error(getLinkText(device)+" got unknown button press command: " + msg.command)
return [name:"error",value:"unknown button press command"]
break
}
}
/**
*this is the handler for button held events. Map is routed here once a button held event has been detected
*/
def Map handleButtonHeld(Map msg) {
switch (Integer.parseInt(msg.command)) {
case 1:
log.debug("Button held- Lowering brightness commanded")
state.dimming = true
updateButtonState("lowering brightness")
state.lastHeld = "down"
return adjustBrightness(false, state.brightness)
break
case 3:
log.debug("stop brightness commanded")
updateButtonState(state.lastHeld + " released")
state.dimming = false
return state
break
case 5:
log.debug("Button held- raising brightness commanded")
state.lastHeld = "up"
updateButtonState("raising brightness")
state.dimming = true
return adjustBrightness(true, state.brightness)
break
case 7:
log.info("Button Held Bind Response - 7!!!")
state.bounddimmer=true
return state
break
case 8:
log.info("Button Held Bind Response - 8!!!")
state.bounddimmer=true
return state
break
default:
log.error("Unhandled button held event: " + msg)
break
}
return msg
}
/**
* adjusts brightness up/down depending on the value of the up boolean true is up, false is down
* continues to adjust until state.dimming is changed
* up- true if we are adjusting brightness up, false if down
* level - first level commanded
*/
def Map adjustBrightness(final boolean up, double level) {
Map result
log.debug("adjusting brightness" + (up?"up" : "down") + " from current " + state.brightness)
if (state.dimming) {
//increase or decrease brightness
if (up) {
state.brightening = true
} else {
state.brightening = false
}
state.brightness = (int) level
executeBrightnessAdjustmentUntilButtonReleased()
} else {
log.debug("Final brightness adjusted to " + state.brightness)
}
sendEvent(name: "brightness", value: state.brightness)
return getStatus()
}
/**
* performs a recursive brightness adjustment based on state.brightening while state.dimming is true
*/
void executeBrightnessAdjustmentUntilButtonReleased() {
if (state.dimming) {
if (state.brightening) {
state.brightness = state.brightness + 20
} else {
state.brightness = state.brightness - 20
}
if (state.brightness > 100) {
state.brightness = 100
state.dimming=false
}
if (state.brightness < 1){
state.brightness = 1
state.dimming=false
}
setLevel((double) state.brightness, 1000)
reportOnState(true) //Manage and report states
runIn(1, executeBrightnessAdjustmentUntilButtonReleased)
}
}
/**
* gets the current brightness in hex format
* length - the length of the number after leading 0's have been applied. This will likely be "2"
*/
String getBrightnessHex(int length) {
StringBuilder sb = new StringBuilder(Integer.toHexString((Integer) Math.round(state.brightness * 2.55)))
if (sb.size() > length) return sb.toString()
for (int i = sb.size(); i < length; i++) {
sb.insert(0, '0')
}
return sb.toString()
}
/**
*formats a decimal value with leading 0's
*value - the value to be formatted
*length - the size of the number after leading 0's have been added
*/
String formatNumber(int value, int length) {
return String.format("%" + length + "d", value);
}
/**
*performs configuration and bindings
*/
def configure() {
if (state.boundnetwork && state.bounddimmer && state.boundonoff){
log.debug("configuration complete")
sendEvent(name:"Configured", value:"true")
return
}
log.debug "Confuguring Reporting and Bindings."
fireCommands(zigbee.onOffConfig() + zigbee.levelConfig() + zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.readAttribute(0x0001, 0x0020))
configureDaemon()
return configCmds
}
/*
* handles binding if switch doesn't pay attention the first time.
*/
def configureDaemon(){
return runIn(8, "configure")
}
def mySleep(int ms) {
def start = now()
while (now() < start + ms) {
}
}
/**
*Refresh support. Causes battery status update and others
*/
def refresh() {
fireCommands(zigbee.readAttribute(0x0001, 0x0020) +zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.onOffConfig() + zigbee.levelConfig() + zigbee.readAttribute(0x0001, 0x0020) )
}
/**
*actions to be taken once the device is installed
*/
def installed() {
log.info(device.name + " installed!!!")
sendEvent(name:"Configured", value:"false")
state.boundnetwork=false
state.bounddimmer=false
state.boundonoff=false
state.on = false
state.lastAction = 0
state.brightness = 0
state.buttonNumber = 1
state.value = "unknown"
state.lastHeld = "none"
state.battery = 100
state.dimming = false
return reportOnState(getOnState())
}
def updated(){
log.info("updated")
return refresh()
}
/**
*handles battery messages
*/
private Map batteryHandler(Map rawValue) {
int value = Integer.valueOf(rawValue.value, 16)
def linkText = getLinkText(device)
def result = [ name: 'battery', value: state.battery ]
def volts = Integer.valueOf(rawValue.value, 16) / 10
def descriptionText
if (rawValue == 0) {
state.battery = "unknown"
} else {
if (volts > 3.5) {
result.descriptionText = "${linkText} battery has too much power (${volts} volts)."
state.battery = "overvoltage"
} else if (volts > 0) {
def minVolts = 2.1
def maxVolts = 3.0
def pct = (volts - minVolts) / (maxVolts - minVolts)
state.battery = Math.min(100, (int) pct * 100)
result.battery = state.battery
result.descriptionText = "${linkText} battery was ${result.value}%"
}
}
sendEvent(name: 'battery', value: state.battery, units: "%")
log.debug "${result?.descriptionText}"
return result
}
/**
* handle level commands,
* level=desired level
* duration=desired time-to-level
*/
def setLevel(Double level, Double duration) {
if (level > 100 || level < 0 || duration < 0 || duration > 9999) {
log.debug("Maximum parameters (level 0-100, duration 0-9999)-- commanded level:" + level + " commanded duration:" + duration)
return
}
log.info("Brightness commanded to " + level + "%")
state.brightness = (int) level
def result = createStCommand(" 8 4 {" + getBrightnessHex(2) + " " + formatNumber((int) duration, 4) + "}")
if (state.on != "on") on()
fireCommands(result.command) //send it to the hub for processing
reportOnState(true)
}
/**
*sets level using a 1-second duration
*level= percent
*/
def setLevel(Double level) {
setLevel(level, 1000)
}
/**
* Returns true if the switch is on. false if off.
*/
Boolean getOnState(){
return (state.on == "on")
}
/**
*poll support, forces an update of states
*/
def poll() {
sendEvent(name: 'brightness', value: state.brightness, units: "%")
reportOnState(getOnState())
}
/**
*takes a command and data, generates an "st cmd" array
*command- string representing the command and data to be send to the device
*returns the command for all devices on the switch
*/
def Map createStCommand(String command) {
List<String> output = []
LinkedHashMap result = getStatus()
for (item in getDevices()) {
output.add("st cmd 0x" + item[0] + " 0x" + item[1] + " " + command)
}
result['command'] = (List)output.flatten()
return result
}
/**
* Handles event updates. All updates go here.
*/
def reportOnState(boolean on) {
String onValue = (on ? "on" : "off")
sendEvent(name: 'state', type:"thing", value:onValue)
sendEvent(name: 'battery', value: state.battery)
sendEvent(name: 'level', value: state.brightness)
sendEvent(name: 'button', value: state.value)
sendEvent(name: 'numberOfButtons', value: 5)
sendEvent(name: 'State Array', value: state)
sendEvent(name: 'Awesomeness Level', value: "over 9000")
state.on = onValue
}
def updateButtonState(def value) {
state.value = value
sendEvent(name: "button", value: value, unit: "")
}
/**
*commands the opposite of the current state
*if on, turn off, if off, turn on.
*/
def toggle() {
Map command
if (state.on == "on") {
log.debug(device.displayName + " toggled on")
command = off()
} else {
command = on()
log.debug(device.displayName + " toggled off")
}
log.debug(command)
fireCommands(command.command)
}
/**
*detects the current state versus commanded
*if curret is off, and commanded is off, returns true and same for inverse
*/
boolean doubleTapped(boolean commanded) {
boolean on=(state.on=="on")
if (on && commanded|| !on && !commanded) return true
return false
}
/**
*This switch does not support pressing the same button in rapid sucession
*this check finds out if user tapped one button and then the other within 1.5 seconds.
*/
boolean onOffTapped(){
return (state.lastAction < now()+1500)
}
//TODO create a up-down tapped mechanism.
/**
*turns light on.
*if already on, commands max
*/
Map on() {
log.debug(device.displayName + " commanded on" )
if (onOffTapped){
}
state.lastAction=now()
if (doubleTapped(true)) setLevel(100, 1000)
reportOnState(true)
return createStCommand("6 1 {}")
}
/**
*turns light off
*if already off, commands on to minimum
*/
Map off() {
log.debug(device.displayName + " commanded off")
if (onOffTapped){
}
state.lastAction=now()
if (doubleTapped(false)){
def value=on()
setLevel(1, 1000)
return value
}
reportOnState(false)
return createStCommand("6 0 {}")
}
/**
*Action to be taken when both buttons are pressed at the same time
*/
def bothButtonsPressed() {
log.error("Both Buttons Pressed" + state)
installed()
state.lastAction = 100
updateButtonState("Initiating configuration routines. Please stand by.")
configure()
return state
}