-
Notifications
You must be signed in to change notification settings - Fork 4
/
Hubitat GreenWave PowerNode (Single) Advanced.groovy
1548 lines (1359 loc) · 58.3 KB
/
Hubitat GreenWave PowerNode (Single) Advanced.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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*****************************************************************************************************************
* Copyright: David Lomas (codersaur)
*
* Name: GreenWave PowerNode (Single) Advanced
*
* Date: 2017-03-08
*
* Version: 1.01
*
* Source: https://github.com/codersaur/SmartThings/tree/master/devices/greenwave-powernode-single
*
* Author: David Lomas (codersaur)
*
* Description: An advanced SmartThings device handler for the GreenWave PowerNode (Single socket) Z-Wave power outlet.
*
* For full information, including installation instructions, exmples, and version history, see:
* https://github.com/codersaur/SmartThings/tree/master/devices/greenwave-powernode-single
*
* License:
* 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.
*
*****************************************************************************************************************/
/**
* Notes, updated phyicalgraph to hubitat
* Issue with line 1163
**/
metadata {
definition (name: "GreenWave PowerNode (Single) Advanced", namespace: "codersaur", author: "David Lomas") {
capability "Actuator"
capability "Switch"
capability "Sensor"
capability "Energy Meter"
capability "Power Meter"
capability "Polling"
capability "Refresh"
// Custom (Virtual) Capabilities:
//capability "Fault"
//capability "Logging"
//capability "Protection"
// Standard Attributes:
attribute "switch", "enum", ["on", "off"]
attribute "power", "number"
attribute "energy", "number"
// Custom Attributes:
attribute "energyLastReset", "string" // Last time Accumulated Engergy was reset.
attribute "fault", "string" // Indicates if the device has any faults. 'clear' if no active faults.
attribute "localProtectionMode", "enum", ["unprotected","sequence","noControl"] // Physical protection mode.
attribute "rfProtectionMode", "enum", ["unprotected","noControl","noResponse"] // Wireless protection mode.
attribute "logMessage", "string" // Important log messages.
attribute "syncPending", "number" // Number of config items that need to be synced with the physical device.
attribute "wheelStatus", "enum", ["black","green","blue","red","yellow","violet","orange","aqua","pink","white"]
// Display Attributes:
// These are only required because the UI lacks number formatting and strips leading zeros.
attribute "dispEnergy", "string"
attribute "dispPower", "string"
// Custom Commands:
command "blink" // Causes the Circle LED to blink for ~20 seconds.
command "reset" // Alias for resetEnergy().
command "resetEnergy" // Reset accumulated energy figure to 0.
command "resetFault" // Reset fault alarm to 'clear'.
command "setLocalProtectionMode" // Set physical protection mode.
command "toggleLocalProtectionMode" // Toggle physical protection mode.
command "setRfProtectionMode" // Set wireless protection mode.
command "toggleRfProtectionMode" // Toggle wireless protection mode.
command "sync" // Sync configuration with physical device.
command "test" // Test function.
// Fingerprints:
fingerprint mfr: "0153", prod: "0002", model: "0002"
fingerprint type: "1001", mfr: "0153", cc: "25,27,32,56,70,71,72,75,85,86,87"
fingerprint inClusters: "0x20,0x25,0x27,0x32,0x56,0x70,0x71,0x72,0x75,0x85,0x86,0x87"
}
main(["switch"])
details([
"switch",
"instMode","power",
"wheelStatus",
"energyLastReset","energy",
"blink",
"localProtectionMode",
"rfProtectionMode",
"syncPending",
// "refresh",
"fault"//,
//"test"
])
}
preferences {
section { // GENERAL:
input (
type: "paragraph",
element: "paragraph",
title: "GENERAL:",
description: "General device handler settings."
)
input (
name: "configLoggingLevelIDE",
title: "IDE Live Logging Level:\nMessages with this level and higher will be logged to the IDE.",
type: "enum",
options: [
"0" : "None",
"1" : "Error",
"2" : "Warning",
"3" : "Info",
"4" : "Debug",
"5" : "Trace"
],
defaultValue: "3",
required: false
)
input (
name: "configLoggingLevelDevice",
title: "Device Logging Level:\nMessages with this level and higher will be logged to the logMessage attribute.",
type: "enum",
options: [
"0" : "None",
"1" : "Error",
"2" : "Warning"
],
defaultValue: "2",
required: false
)
input (
name: "configSyncAll",
title: "Force Full Sync:\nAll device settings will be re-sent to the device.",
type: "boolean",
defaultValue: false,
required: false
)
input (
name: "configAutoOffTime",
title: "Timer Function (Auto-off):\nAutomatically switch off the device after a specified time.\n" +
"Values:\n0 = Function Disabled\n1-86400 = time in seconds\nDefault Value: 0",
type: "number",
range: "0..86400",
defaultValue: 0,
required: false
)
input (
name: "configIgnoreCurrentLeakageAlarms",
title: "Ignore Current Leakage Alarms:\nDo not raise a fault on a current leakage alarm.",
type: "boolean",
defaultValue: false,
required: false
)
input (
name: "configSwitchAllMode",
title: "ALL ON/ALL OFF Function:\nResponse to SWITCH_ALL_SET commands.",
type: "enum",
options: [
"0" : "0: All ON not active, All OFF not active",
"1" : "1: All ON not active, All OFF active",
"2" : "2: All ON active, All OFF not active",
"255" : "255: All ON active, All OFF active"],
defaultValue: "255",
required: false
)
}
generatePrefsParams()
//generatePrefsAssocGroups() // All Assoc Groups are HubOnly for this device.
}
/*****************************************************************************************************************
* SmartThings System Commands:
*****************************************************************************************************************/
/**
* installed()
*
* Runs when the device is first installed.
*
* Action: Set initial values for internal state, and request MSR/Version reports.
**/
def installed() {
log.trace "installed()"
state.installedAt = now()
state.energyLastReset = new Date().format("YYYY/MM/dd \n HH:mm:ss", location.timeZone)
state.loggingLevelIDE = 3
state.loggingLevelDevice = 2
state.useSecurity = false
state.useCrc16 = true
state.fwVersion = 4.23 // Will be updated when versionReport is received.
state.protectLocalTarget = 0
state.protectRfTarget = 0
state.autoOffTime = 0
sendEvent(name: "fault", value: "clear", displayed: false)
def cmds = []
cmds << zwave.configurationV1.configurationSet(parameterNumber: 1, size: 1, scaledConfigurationValue: 255) // Set Keep-Alive to 255.
cmds << zwave.configurationV1.configurationGet(parameterNumber: 2) // Wheel Status
cmds << zwave.protectionV2.protectionGet()
cmds << zwave.manufacturerSpecificV2.manufacturerSpecificGet()
cmds << zwave.versionV1.versionGet()
sendCommands(cmds)
}
/**
* updated()
*
* Runs when the user hits "Done" from Settings page.
*
* Action: Process new settings, sync parameters and association group members with the physical device.
*
* Note: Weirdly, update() seems to be called twice. So execution is aborted if there was a previous execution
* within two seconds. See: https://community.smartthings.com/t/updated-being-called-twice/62912
**/
def updated() {
logger("updated()","trace")
def cmds = []
if (!state.updatedLastRanAt || now() >= state.updatedLastRanAt + 2000) {
state.updatedLastRanAt = now()
// Update internal state:
state.loggingLevelIDE = (settings.configLoggingLevelIDE) ? settings.configLoggingLevelIDE.toInteger() : 3
state.loggingLevelDevice = (settings.configLoggingLevelDevice) ? settings.configLoggingLevelDevice.toInteger(): 2
state.syncAll = ("true" == settings.configSyncAll)
state.autoOffTime = (settings.configAutoOffTime) ? settings.configAutoOffTime.toInteger() : 0
state.ignoreCurrentLeakageAlarms = ("true" == settings.configIgnoreCurrentLeakageAlarms)
state.switchAllModeTarget = (settings.configSwitchAllMode) ? settings.configSwitchAllMode.toInteger() : 255
// Update Parameter target values:
getParamsMd().findAll( { !it.readonly & (it.fwVersion <= state.fwVersion) } ).each { // Exclude readonly/newer parameters.
state."paramTarget${it.id}" = settings."configParam${it.id}"?.toInteger()
}
// Update Assoc Group target values:
getAssocGroupsMd().findAll( { !it.hubOnly } ).each {
state."assocGroupTarget${it.id}" = parseAssocGroupInput(settings."configAssocGroup${it.id}", it.maxNodes)
}
getAssocGroupsMd().findAll( { it.hubOnly } ).each {
state."assocGroupTarget${it.id}" = [ zwaveHubNodeId ]
}
// Sync configuration with phyiscal device:
sync(state.syncAll)
// Request device medadata (this just seems the best place to do it):
cmds << zwave.manufacturerSpecificV2.manufacturerSpecificGet()
cmds << zwave.versionV1.versionGet()
return sendCommands(cmds)
}
else {
logger("updated(): Ran within last 2 seconds so aborting.","debug")
}
}
/**
* parse()
*
* Called when messages from the device are received by the hub. The parse method is responsible for interpreting
* those messages and returning event definitions (and command responses).
*
* As this is a Z-wave device, zwave.parse() is used to convert the message into a command. The command is then
* passed to zwaveEvent(), which is overloaded for each type of command below.
*
* Note: There is no longer any need to check if description == "updated".
*
* Parameters:
* String description The raw message from the device.
**/
def parse(description) {
logger("parse(): Parsing raw message: ${description}","trace")
def result = []
def cmd = zwave.parse(description, getCommandClassVersions())
if (cmd) {
result += zwaveEvent(cmd)
} else {
logger("parse(): Could not parse raw message: ${description}","error")
}
return result
}
/*****************************************************************************************************************
* Z-wave Event Handlers.
*****************************************************************************************************************/
/**
* zwaveEvent( COMMAND_CLASS_BASIC (0x20) : BASIC_REPORT (0x03) )
*
* The Basic Report command is used to advertise the status of the primary functionality of the device.
*
* Action: Raise switch event and log an info message if state has changed.
* Schedule autoOff() if an autoOffTime is configured.
*
* cmd attributes:
* Short value
* 0x00 = Off
* 0x01..0x63 = 0..100%
* 0xFE = Unknown
* 0xFF = On
*
* Example: BasicReport(value: 255)
**/
def zwaveEvent(hubitat.zwave.commands.basicv1.BasicReport cmd) {
logger("zwaveEvent(): Basic Report received: ${cmd}","trace")
def result = []
def switchValue = (cmd.value ? "on" : "off")
def switchEvent = createEvent(name: "switch", value: switchValue)
if (switchEvent.isStateChange) logger("Switch turned ${switchValue}.","info")
result << switchEvent
if ( switchEvent.isStateChange & (switchValue == "on") & (state.autoOffTime > 0) ) {
logger("Scheduling Auto-off in ${state.autoOffTime} seconds.","info")
runIn(state.autoOffTime,autoOff)
}
return result
}
/**
* zwaveEvent( COMMAND_CLASS_APPLICATION_STATUS (0x22) : APPLICATION_BUSY (0x01) )
*
* The Application Busy command used to instruct a node that the node that it is trying to communicate with is
* busy and is unable to service the request right now.
*
* Action: Log a warning message.
*
* cmd attributes:
* Short status
* 0 = Try again later.
* 1 = Try again in Wait Time seconds.
* 2 = Request queued, executed later.
* Short waitTime Number of seconds to wait before retrying.
*
* Example: ApplicationBusy(status: 0, waitTime: 0)
**/
def zwaveEvent(hubitat.zwave.commands.applicationstatusv1.ApplicationBusy cmd) {
logger("zwaveEvent(): Application Busy received: ${cmd}","trace")
switch(cmd.status) {
case 0:
logger("Device is busy. Try again later.","warn")
break
case 1:
logger("Device is busy. Retry in ${cmd.waitTime} seconds.","warn")
break
case 2:
logger("Device is busy. Request is queued.","warn")
break
}
}
/**
* zwaveEvent( COMMAND_CLASS_APPLICATION_STATUS (0x22) : APPLICATION_REJECTED_REQUEST (0x02) )
*
* The Application Rejected Request command used to instruct a node that a command was rejected by the receiving node.
*
* Action: Log a warning message.
*
* Note: These will be received if rfProtectionMode is 'No Control'.
*
* cmd attributes:
* Short status Always 0.
*
* Example: ApplicationRejectedRequest(status: 0)
**/
def zwaveEvent(hubitat.zwave.commands.applicationstatusv1.ApplicationRejectedRequest cmd) {
//logger("zwaveEvent(): Application Rejected Request received: ${cmd}","trace")
logger("A command was rejected. Most likely, RF Protection Mode is set to 'No Control'.","warn")
}
/**
* zwaveEvent( COMMAND_CLASS_SWITCH_BINARY (0x25) : SWITCH_BINARY_REPORT (0x03) )
*
* The Binary Switch Report command is used to advertise the status of a device with On/Off or Enable/Disable
* capability.
*
* Action: Raise switch event and log an info message if state has changed.
* Schedule autoOff() if an autoOffTime is configured.
*
* cmd attributes:
* Short value 0xFF for on, 0x00 for off
*
* Example: SwitchBinaryReport(value: 255)
**/
def zwaveEvent(hubitat.zwave.commands.switchbinaryv1.SwitchBinaryReport cmd) {
logger("zwaveEvent(): Switch Binary Report received: ${cmd}","trace")
def result = []
def switchValue = (cmd.value ? "on" : "off")
def switchEvent = createEvent(name: "switch", value: switchValue)
if (switchEvent.isStateChange) logger("Switch turned ${switchValue}.","info")
result << switchEvent
if ( switchEvent.isStateChange & (switchValue == "on") & (state.autoOffTime > 0) ) {
logger("Scheduling Auto-off in ${state.autoOffTime} seconds.","info")
runIn(state.autoOffTime,autoOff)
}
return result
}
/**
* zwaveEvent( COMMAND_CLASS_SWITCH_ALL (0x27) : SWITCH_ALL_REPORT (0x03) )
*
* The All Switch Report Command is used to report if the device is included or excluded from the all on/all off
* functionality.
*
* Action: Cache value, update syncPending, and log an info message.
*
* cmd attributes:
* Short mode
* 0 = MODE_EXCLUDED_FROM_THE_ALL_ON_ALL_OFF_FUNCTIONALITY
* 1 = MODE_EXCLUDED_FROM_THE_ALL_ON_FUNCTIONALITY_BUT_NOT_ALL_OFF
* 2 = MODE_EXCLUDED_FROM_THE_ALL_OFF_FUNCTIONALITY_BUT_NOT_ALL_ON
* 255 = MODE_INCLUDED_IN_THE_ALL_ON_ALL_OFF_FUNCTIONALITY
*
* Example: SwitchAllReport(mode: 255)
**/
def zwaveEvent(hubitat.zwave.commands.switchallv1.SwitchAllReport cmd) {
logger("zwaveEvent(): Switch All Report received: ${cmd}","trace")
state.switchAllModeCache = cmd.mode
def msg = ""
switch (cmd.mode) {
case 0:
msg = "Device is excluded from the all on/all off functionality."
break
case 1:
msg = "Device is excluded from the all on functionality but not all off."
break
case 2:
msg = "Device is excluded from the all off functionality but not all on."
break
default:
msg = "Device is included in the all on/all off functionality."
break
}
logger("Switch All Mode: ${msg}","info")
updateSyncPending()
}
/**
* zwaveEvent( COMMAND_CLASS_METER_V3 (0x32) : METER_REPORT_V3 (0x02) )
*
* The Meter Report Command is used to advertise a meter reading.
*
* Action: Raise appropriate type of event (and disp... event) and log an info message.
* Plus, request a Switch Binary Report if power report suggests switch state has changed.
* (This is necessary because the PowerNode does not report physical switch events reliably).
*
* Note: GreenWave PowerNode supports energy and power reporting only.
*
* cmd attributes:
* Integer deltaTime Time in seconds since last report.
* Short meterType Specifies the type of metering device.
* 0x00 = Unknown
* 0x01 = Electric meter
* 0x02 = Gas meter
* 0x03 = Water meter
* List<Short> meterValue Meter value as an array of bytes.
* Double scaledMeterValue Meter value as a double.
* List<Short> previousMeterValue Previous meter value as an array of bytes.
* Double scaledPreviousMeterValue Previous meter value as a double.
* Short size The size of the array for the meterValue and previousMeterValue.
* Short scale Indicates what unit the sensor uses (dependent on meterType).
* Short precision The decimal precision of the values.
* Short rateType Specifies if it is import or export values to be read.
* 0x01 = Import (consumed)
* 0x02 = Export (produced)
* Boolean scale2 ???
**/
def zwaveEvent(hubitat.zwave.commands.meterv3.MeterReport cmd) {
logger("zwaveEvent(): Meter Report received: ${cmd}","trace")
def result = []
switch (cmd.meterType) {
case 1: // Electric meter:
switch (cmd.scale) {
case 0: // Accumulated Energy (kWh):
result << createEvent(name: "energy", value: cmd.scaledMeterValue, unit: "kWh", displayed: true)
result << createEvent(name: "dispEnergy", value: String.format("%.2f",cmd.scaledMeterValue as BigDecimal) + " kWh", displayed: false)
logger("New meter reading: Accumulated Energy: ${cmd.scaledMeterValue} kWh","info")
break
case 1: // Accumulated Energy (kVAh):
result << createEvent(name: "energy", value: cmd.scaledMeterValue, unit: "kVAh", displayed: true)
result << createEvent(name: "dispEnergy", value: String.format("%.2f",cmd.scaledMeterValue as BigDecimal) + " kVAh", displayed: false)
logger("New meter reading: Accumulated Energy: ${cmd.scaledMeterValue} kVAh","info")
break
case 2: // Instantaneous Power (Watts):
result << createEvent(name: "power", value: cmd.scaledMeterValue, unit: "W", displayed: true)
result << createEvent(name: "dispPower", value: String.format("%.1f",cmd.scaledMeterValue as BigDecimal) + " W", displayed: false)
logger("New meter reading: Instantaneous Power: ${cmd.scaledMeterValue} W","info")
// Request Switch Binary Report if power suggests switch state has changed:
def sw = (cmd.scaledMeterValue) ? "on" : "off"
if ( device.latestValue("switch") != sw) { result << prepCommands([zwave.switchBinaryV1.switchBinaryGet()]) }
break
case 3: // Accumulated Pulse Count:
result << createEvent(name: "pulseCount", value: cmd.scaledMeterValue, unit: "", displayed: true)
logger("New meter reading: Accumulated Electricity Pulse Count: ${cmd.scaledMeterValue}","info")
break
case 4: // Instantaneous Voltage (Volts):
result << createEvent(name: "voltage", value: cmd.scaledMeterValue, unit: "V", displayed: true)
result << createEvent(name: "dispVoltage", value: String.format("%.1f",cmd.scaledMeterValue as BigDecimal) + " V", displayed: false)
logger("New meter reading: Instantaneous Voltage: ${cmd.scaledMeterValue} V","info")
break
case 5: // Instantaneous Current (Amps):
result << createEvent(name: "current", value: cmd.scaledMeterValue, unit: "A", displayed: true)
result << createEvent(name: "dispCurrent", value: String.format("%.1f",cmd.scaledMeterValue as BigDecimal) + " V", displayed: false)
logger("New meter reading: Instantaneous Current: ${cmd.scaledMeterValue} A","info")
break
case 6: // Instantaneous Power Factor:
result << createEvent(name: "powerFactor", value: cmd.scaledMeterValue, unit: "", displayed: true)
result << createEvent(name: "dispPowerFactor", value: String.format("%.1f",cmd.scaledMeterValue as BigDecimal), displayed: false)
logger("New meter reading: Instantaneous Power Factor: ${cmd.scaledMeterValue}","info")
break
default:
logger("zwaveEvent(): Meter Report with unhandled scale: ${cmd}","warn")
break
}
break
default:
logger("zwaveEvent(): Meter Report with unhandled meterType: ${cmd}","warn")
break
}
return result
}
/**
* zwaveEvent( COMMAND_CLASS_CRC16_ENCAP (0x56) : CRC_16_ENCAP (0x01) )
*
* The CRC-16 Encapsulation Command Class is used to encapsulate a command with an additional CRC-16 checksum
* to ensure integrity of the payload. The purpose for this command class is to ensure a higher integrity level
* of payloads carrying important data.
*
* Action: Extract the encapsulated command and pass to zwaveEvent().
*
* Note: Validation of the checksum is not necessary as this is performed by the hub.
*
* cmd attributes:
* Integer checksum Checksum.
* Short command Command identifier of the embedded command.
* Short commandClass Command Class identifier of the embedded command.
* List<Short> data Embedded command data.
*
* Example: Crc16Encap(checksum: 125, command: 2, commandClass: 50, data: [33, 68, 0, 0, 0, 194, 0, 0, 77])
**/
def zwaveEvent(hubitat.zwave.commands.crc16encapv1.Crc16Encap cmd) {
logger("zwaveEvent(): CRC-16 Encapsulation Command received: ${cmd}","trace")
def versions = getCommandClassVersions()
def version = versions[cmd.commandClass as Integer]
def ccObj = version ? zwave.commandClass(cmd.commandClass, version) : zwave.commandClass(cmd.commandClass)
def encapsulatedCommand = ccObj?.command(cmd.command)?.parse(cmd.data)
// TO DO: It should be possible to replace the lines above with this line soon...
//def encapsulatedCommand = cmd.encapsulatedCommand(getCommandClassVersions())
if (!encapsulatedCommand) {
logger("zwaveEvent(): Could not extract command from ${cmd}","error")
} else {
return zwaveEvent(encapsulatedCommand)
}
}
/**
* zwaveEvent( COMMAND_CLASS_CONFIGURATION (0x70) : CONFIGURATION_REPORT (0x03) )
*
* The Configuration Report Command is used to advertise the actual value of the advertised parameter.
*
* Action: Store the value in the parameter cache, update syncPending, and log an info message.
* Update wheelStatus if parameter #2.
*
* Note: Ideally, we want to update the corresponding preference value shown on the Settings GUI, however this
* is not possible due to security restrictions in the SmartThings platform.
*
* cmd attributes:
* List<Short> configurationValue Value of parameter (byte array).
* Short parameterNumber Parameter ID.
* Short size Size of parameter's value (bytes).
*
* Example: ConfigurationReport(configurationValue: [10], parameterNumber: 0, reserved11: 0,
* scaledConfigurationValue: 10, size: 1)
**/
def zwaveEvent(hubitat.zwave.commands.configurationv1.ConfigurationReport cmd) {
logger("zwaveEvent(): Configuration Report received: ${cmd}","trace")
def result = []
def paramMd = getParamsMd().find( { it.id == cmd.parameterNumber })
// Some values are treated as unsigned and some as signed, so we convert accordingly:
def paramValue = (paramMd?.isSigned) ? cmd.scaledConfigurationValue : byteArrayToUInt(cmd.configurationValue)
def signInfo = (paramMd?.isSigned) ? "SIGNED" : "UNSIGNED"
state."paramCache${cmd.parameterNumber}" = paramValue
logger("Parameter #${cmd.parameterNumber} [${paramMd?.name}] has value: ${paramValue} [${signInfo}]","info")
updateSyncPending()
// Update wheelStatus if parameter #2:
if (cmd.parameterNumber == 2) {
def wheelStatus = getWheelColours()[paramValue]
def wheelEvent = createEvent(name: "wheelStatus", value: wheelStatus)
if (wheelEvent.isStateChange) logger("Room Colour Wheel changed to ${wheelStatus}.","info")
result << wheelEvent
}
return result
}
/**
* zwaveEvent( COMMAND_CLASS_ALARM (0x71) : ALARM_REPORT (0x05) )
*
* The Alarm Report command used to report the type and level of an alarm.
*
* Action: Raise a fault event and log a warning message.
*
* Note: The GreenWave PowerNode seems especially eager to raise current leakage alarms, so there is an
* optional setting to ignore them.
*
* cmd attributes:
* Short alarmLevel Application specific
* Short alarmType Application specific
*
* Example: AlarmReport(alarmLevel: 1, alarmType: 1)
**/
def zwaveEvent(hubitat.zwave.commands.alarmv1.AlarmReport cmd) {
logger("zwaveEvent(): Alarm Report received: ${cmd}","trace")
def result = []
switch(cmd.alarmType) {
case 1: // Current Leakage:
if (!state.ignoreCurrentLeakageAlarms) { result << createEvent(name: "fault", value: "currentLeakage",
descriptionText: "Current Leakage detected!", displayed: true) }
logger("Current Leakage detected!","warn")
break
// TO DO: Check other alarm codes.
default: // Over-current:
result << createEvent(name: "fault", value: "current", descriptionText: "Over-current detected!", displayed: true)
logger("Over-current detected!","warn")
break
}
return result
}
/**
* zwaveEvent( COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2 (0x72) : MANUFACTURER_SPECIFIC_REPORT_V2 (0x05) )
*
* Manufacturer-Specific Reports are used to advertise manufacturer-specific information, such as product number
* and serial number.
*
* Action: Publish values as device 'data'. Log a warn message if manufacturerId and/or productId do not match.
*
* Example: ManufacturerSpecificReport(manufacturerId: 153, manufacturerName: GreenWave Reality Inc.,
* productId: 2, productTypeId: 2)
**/
def zwaveEvent(hubitat.zwave.commands.manufacturerspecificv2.ManufacturerSpecificReport cmd) {
logger("zwaveEvent(): Manufacturer-Specific Report received: ${cmd}","trace")
// Display as hex strings:
def manufacturerIdDisp = String.format("%04X",cmd.manufacturerId)
def productIdDisp = String.format("%04X",cmd.productId)
def productTypeIdDisp = String.format("%04X",cmd.productTypeId)
logger("Manufacturer-Specific Report: Manufacturer ID: ${manufacturerIdDisp}, Manufacturer Name: ${cmd.manufacturerName}" +
", Product Type ID: ${productTypeIdDisp}, Product ID: ${productIdDisp}","info")
if ( 153 != cmd.manufacturerId) logger("Device Manufacturer is not GreenWave Reality. " +
"Using this device handler with a different device may damage your device!","warn")
if ( 2 != cmd.productId) logger("Product ID does not match GreenWave PowerNode (Single). " +
"Using this device handler with a different device may damage you device!","warn")
updateDataValue("manufacturerName",cmd.manufacturerName)
updateDataValue("manufacturerId",manufacturerIdDisp)
updateDataValue("productId",productIdDisp)
updateDataValue("productTypeId",productTypeIdDisp)
}
/**
* zwaveEvent( COMMAND_CLASS_PROTECTION_V2 (0x75) : PROTECTION_REPORT_V2 (0x03) )
*
* The Protection Report is used to report the protection state of a device.
* I.e. measures to prevent unintentional control (e.g. by a child).
*
* Action: Cache values, update syncPending, and log an info message.
*
* cmd attributes:
* Short localProtectionState Local protection state (i.e. physical switches/buttons)
* Short rfProtectionState RF protection state.
*
* Example: ProtectionReport(localProtectionState: 0, reserved01: 0, reserved11: 0, rfProtectionState: 0)
**/
def zwaveEvent(hubitat.zwave.commands.protectionv2.ProtectionReport cmd) {
logger("zwaveEvent(): Protection Report received: ${cmd}","trace")
def result = []
state.protectLocalCache = cmd.localProtectionState
state.protectRfCache = cmd.rfProtectionState
def lpStates = ["unprotected","sequence","noControl"]
def lpValue = lpStates[cmd.localProtectionState]
def lpEvent = createEvent(name: "localProtectionMode", value: lpValue)
if (lpEvent.isStateChange) logger("Local Protection set to ${lpValue}.","info")
result << lpEvent
def rfpStates = ["unprotected","noControl","noResponse"]
def rfpValue = rfpStates[cmd.rfProtectionState]
def rfpEvent = createEvent(name: "rfProtectionMode", value: rfpValue)
if (rfpEvent.isStateChange) logger("RF Protection set to ${rfpValue}.","info")
result << rfpEvent
logger("Protection Report: Local Protection: ${lpValue}, RF Protection: ${rfpValue}","info")
updateSyncPending()
return result
}
/**
* zwaveEvent( COMMAND_CLASS_ASSOCIATION_V2 (0x85) : ASSOCIATION_REPORT_V2 (0x03) )
*
* The Association Report command is used to advertise the current destination nodes of a given association group.
*
* Action: Cache value and log info message only.
*
* Note: Ideally, we want to update the corresponding preference value shown on the Settings GUI, however this
* is not possible due to security restrictions in the SmartThings platform.
*
* Example: AssociationReport(groupingIdentifier: 1, maxNodesSupported: 1, nodeId: [1], reportsToFollow: 0)
**/
def zwaveEvent(hubitat.zwave.commands.associationv2.AssociationReport cmd) {
logger("zwaveEvent(): Association Report received: ${cmd}","trace")
state."assocGroupCache${cmd.groupingIdentifier}" = cmd.nodeId
// Display to user in hex format (same as IDE):
def hexArray = []
cmd.nodeId.each { hexArray.add(String.format("%02X", it)) };
def assocGroupMd = getAssocGroupsMd().find( { it.id == cmd.groupingIdentifier })
logger("Association Group ${cmd.groupingIdentifier} [${assocGroupMd?.name}] contains nodes: ${hexArray} (hexadecimal format)","info")
updateSyncPending()
}
/**
* zwaveEvent( COMMAND_CLASS_VERSION (0x86) : VERSION_REPORT (0x12) )
*
* The Version Report Command is used to advertise the library type, protocol version, and application version.
*
* Action: Publish values as device 'data' and log an info message.
* Store fwVersion as state.fwVersion.
*
* cmd attributes:
* Short applicationSubVersion
* Short applicationVersion
* Short zWaveLibraryType
* Short zWaveProtocolSubVersion
* Short zWaveProtocolVersion
*
* Example: VersionReport(applicationSubVersion: 4, applicationVersion: 3, zWaveLibraryType: 3,
* zWaveProtocolSubVersion: 5, zWaveProtocolVersion: 4)
**/
def zwaveEvent(hubitat.zwave.commands.versionv1.VersionReport cmd) {
logger("zwaveEvent(): Version Report received: ${cmd}","trace")
def zWaveLibraryTypeDisp = String.format("%02X",cmd.zWaveLibraryType)
def zWaveLibraryTypeDesc = ""
switch(cmd.zWaveLibraryType) {
case 1:
zWaveLibraryTypeDesc = "Static Controller"
break
case 2:
zWaveLibraryTypeDesc = "Controller"
break
case 3:
zWaveLibraryTypeDesc = "Enhanced Slave"
break
case 4:
zWaveLibraryTypeDesc = "Slave"
break
case 5:
zWaveLibraryTypeDesc = "Installer"
break
case 6:
zWaveLibraryTypeDesc = "Routing Slave"
break
case 7:
zWaveLibraryTypeDesc = "Bridge Controller"
break
case 8:
zWaveLibraryTypeDesc = "Device Under Test (DUT)"
break
case 0x0A:
zWaveLibraryTypeDesc = "AV Remote"
break
case 0x0B:
zWaveLibraryTypeDesc = "AV Device"
break
default:
zWaveLibraryTypeDesc = "N/A"
}
def applicationVersionDisp = String.format("%d.%02d",cmd.applicationVersion,cmd.applicationSubVersion)
def zWaveProtocolVersionDisp = String.format("%d.%02d",cmd.zWaveProtocolVersion,cmd.zWaveProtocolSubVersion)
state.fwVersion = new BigDecimal(applicationVersionDisp)
logger("Version Report: Application Version: ${applicationVersionDisp}, " +
"Z-Wave Protocol Version: ${zWaveProtocolVersionDisp}, " +
"Z-Wave Library Type: ${zWaveLibraryTypeDisp} (${zWaveLibraryTypeDesc})","info")
updateDataValue("applicationVersion","${cmd.applicationVersion}")
updateDataValue("applicationSubVersion","${cmd.applicationSubVersion}")
updateDataValue("zWaveLibraryType","${zWaveLibraryTypeDisp}")
updateDataValue("zWaveProtocolVersion","${cmd.zWaveProtocolVersion}")
updateDataValue("zWaveProtocolSubVersion","${cmd.zWaveProtocolSubVersion}")
}
/**
* zwaveEvent( COMMAND_CLASS_INDICATOR (0x87) : INDICATOR_REPORT (0x03) )
*
* The Indicator Report command is used to advertise the state of an indicator.
*
* Action: Do nothing. It doesn't tell us anything useful.
*
* cmd attributes:
* Short value Indicator status.
* 0x00 = Off/Disabled
* 0x01..0x63 = Indicator Range.
* 0xFF = On/Enabled.
*
* Example: IndicatorReport(value: 0)
**/
def zwaveEvent(hubitat.zwave.commands.indicatorv1.IndicatorReport cmd) {
logger("zwaveEvent(): Indicator Report received: ${cmd}","trace")
}
/**
* zwaveEvent( DEFAULT CATCHALL )
*
* Called for all commands that aren't handled above.
**/
def zwaveEvent(hubitat.zwave.Command cmd) {
logger("zwaveEvent(): No handler for command: ${cmd}","error")
}
/*****************************************************************************************************************
* Capability-related Commands:
*****************************************************************************************************************/
/**
* on() [Capability: Switch]
*
* Turn the switch on.
**/
def on() {
logger("on(): Turning switch on.","info")
sendCommands([
zwave.basicV1.basicSet(value: 0xFF).format(),
zwave.switchBinaryV1.switchBinaryGet().format(),
"delay 3000",
zwave.meterV2.meterGet(scale: 2).format()
])
}
/**
* off() [Capability: Switch]
*
* Turn the switch off.
**/
def off() {
logger("off(): Turning switch off.","info")
sendCommands([
zwave.basicV1.basicSet(value: 0x00).format(),
zwave.switchBinaryV1.switchBinaryGet().format(),
"delay 3000",
zwave.meterV2.meterGet(scale: 2).format()
])
}
/**
* poll() [Capability: Polling]
*
* Calls refresh().
**/
def poll() {
logger("poll()","trace")
refresh()
}
/**
* refresh() [Capability: Refresh]
*
* Action: Request switchBinary, energy, and power reports. Plus, get wheel status.
* Trigger a sync too.
**/
def refresh() {
logger("refresh()","trace")
sendCommands([
zwave.switchBinaryV1.switchBinaryGet().format(),
zwave.meterV2.meterGet(scale: 0).format(),
zwave.meterV2.meterGet(scale: 2).format(),
zwave.configurationV1.configurationGet(parameterNumber: 2) // Wheel Status
])
sync()
}
/*****************************************************************************************************************
* Custom Commands:
*****************************************************************************************************************/
/**
* blink()
*
* Causes the Circle LED to blink for ~20 seconds.
**/
def blink() {
logger("blink(): Blinking Circle LED","info")
sendCommands([zwave.indicatorV1.indicatorSet(value: 255)])
}
/**
* autoOff()
*
* Calls off(), but with additional log message.
**/
def autoOff() {
logger("autoOff(): Automatically turning off the device.","info")
off()
}
/**
* reset()
*
* Alias for resetEnergy().
*
* Note: this used to be part of the official 'Energy Meter' capability, but isn't anymore.
**/
def reset() {
logger("reset()","trace")
resetEnergy()
}
/**