-
Notifications
You must be signed in to change notification settings - Fork 39
/
influxdb-logger.groovy
1321 lines (1219 loc) · 50.1 KB
/
influxdb-logger.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
/* groovylint-disable LineLength, MethodParameterTypeRequired, MethodReturnTypeRequired, MethodSize, NestedBlockDepth, NoDef, ParameterReassignment, PublicMethodsBeforeNonPublicMethods, UnnecessaryGString, UnnecessaryGetter, UnnecessaryObjectReferences, UnusedMethodParameter, VariableTypeRequired */
/*****************************************************************************************************************
* Source: https://github.com/HubitatCommunity/InfluxDB-Logger
*
* Raw Source: https://raw.githubusercontent.com/HubitatCommunity/InfluxDB-Logger/master/influxdb-logger.groovy
*
* Forked from: https://github.com/codersaur/SmartThings/tree/master/smartapps/influxdb-logger
* Original Author: David Lomas (codersaur)
* Previous Author: Joshua Marker (tooluser)
* Hubitat Elevation version maintained by HubitatCommunity (https://github.com/HubitatCommunity/InfluxDB-Logger)
*
* 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.
*
* Modifcation History
* Date Name Change
* 2019-02-02 Dan Ogorchock Use asynchttpPost() instead of httpPost() call
* 2019-09-09 Caleb Morse Support deferring writes and doing bulk writes to influxdb
* 2022-06-20 Denny Page Remove nested sections for device selection.
* 2023-01-08 Denny Page Address whitespace related lint issues. No functional changes.
* 2023-01-09 Craig King Added InfluxDb2.x support.
* 2023-01-12 Denny Page Automatic migration of Influx 1.x settings.
* 2023-01-15 Denny Page Clean up various things:
* Remove Group ID/Name which are not supported on Hubitat.
* Remove Location ID and Hub ID which are not supported on Hubitat (always 1).
* Remove blocks of commented out code.
* Don't set page sections hidden to false where hideable is false.
* Remove state.queuedData.
* 2023-01-22 PJ Add filterEvents option for subscribe.
* Fix event timestamps.
* 2023-01-23 Denny Page Allow multiple instances of the application to be installed.
* NB: This requires Hubitat 2.2.9 or above.
* 2023-01-25 Craig King Updated Button selection to valid capability for Hubitat
* 2023-02-16 PJ Add error message to log for http response >= 400
* Allow ssl cert verification to be disabled (self signed certificates)
* 2023-02-26 Denny Page Cleanup and rationalize UI
* Use time since first data value to trigger post rather than periodic timer
* Only create a keep alive event (softpoll) when no real event has been seen
* Cleanup and rationalize logging
* Further code cleanup
* 2023-02-28 Denny Page Retry failed posts
* Enhance post logging
* Allow Hub Name and Location tags to be disabled for device events
* Further code cleanup
* 2023-03-04 Denny Page Clean up event processing code
* Fix button event handling
* Fix thermostat fan mode event handling
* Fix threeAxis event encoding
* Add device event handling for filters, gas detectors, power source
* Remove handling for non-existent device capabilities
* Move unnecessary info messages to debug
* Disable debug logging of post data which drives hubs into the ground
* Provide info logging of event data to replace post data logging
* Allow backlog to be set as low as 1, allowing bad records to be cleared
* 2023-03-12 Denny Page Use a unified device type / attribute map (deviceTypeMap)
* Unify advanced and non-advanced device selection processing
* Move device event encoding out to a separate function
* Enhance queueToInfluxDb to accept a list of events
* Complete rewrite of softpoll (take advantage of queueToInfluxDb lists)
* Remove unnecessary state variables
* Don't re-schedule batch post based on batch size, wait for existing timer
* Improve backlog warnings
* Lower backlog limits to prevent issues with app database size
* Normalize Hub information logging
* 2023-03-14 Denny Page If post of size one fails, log the actual failed record
* Ignore momentary attributes for keep alive
* Display full uri in config page for convenience
* 2023-03-15 Denny Page Always treat valid numbers (such as buttons) as numeric values for InfluxDB
* 2023-03-16 Denny Page Fix issue of quotes surrounding hub name
* Fix issue of invalid three axis values being posted as a string
* 2023-03-18 Denny Page Fix valve attribute
* Clean up logging
* 2023-04-24 Denny Page Don't send null units to InfluxDB
* 2023-10-26 Denny Page Add support for publishing queue length as a hub variable
* Add support for publishing hub variable events (idea from Scott Chen)
* 2023-11-14 Denny Page Remove default values for Influx Version and Authorization Type
* 2023-11-17 Denny Page Add warning about special characters in Database, Org and Bucket names
* 2024-03-17 Denny Page Add failsafe call to writeQueuedDataToInfluxDb when new events are queued
* Remove old migration items
*****************************************************************************************************************/
definition(
name: "InfluxDB Logger",
namespace: "nowhereville",
author: "Hubitat Community",
description: "Log device states to InfluxDB",
category: "Utility",
importUrl: "https://raw.githubusercontent.com/HubitatCommunity/InfluxDB-Logger/master/influxdb-logger.groovy",
iconUrl: "",
iconX2Url: "",
iconX3Url: "",
singleThreaded: true
)
import groovy.transform.Field
// Device type list
@Field static final Map<String,Map> deviceTypeMap = [
'accelerometers': [ title: 'Accelerometers', capability: 'accelerationSensor', attributes: ['acceleration'] ],
'alarms': [ title: 'Alarms', capability: 'alarm', attributes: ['alarm'] ],
'batteries': [ title: 'Batteries', capability: 'battery', attributes: ['battery'] ],
'beacons': [ title: 'Beacons', capability: 'beacon', attributes: ['presence'] ],
'buttons': [ title: 'Buttons', capability: 'pushableButton', attributes: ['pushed', 'doubleTapped', 'held', 'released'] ],
'cos': [ title: 'Carbon Monoxide Detectors', capability: 'carbonMonoxideDetector', attributes: ['carbonMonoxide'] ],
'co2s': [ title: 'Carbon Dioxide Detectors', capability: 'carbonDioxideMeasurement', attributes: ['carbonDioxide'] ],
'colors': [ title: 'Color Controllers', capability: 'colorControl', attributes: ['hue', 'saturation', 'color'] ],
'consumables': [ title: 'Consumables', capability: 'consumable', attributes: ['consumableStatus'] ],
'contacts': [ title: 'Contact Sensors', capability: 'contactSensor', attributes: ['contact'] ],
'currentMeters': [ title: 'Current Meters', capability: 'currentMeter', attributes: ['amperage'] ],
'doorsControllers': [ title: 'Door Controllers', capability: 'doorControl', attributes: ['door'] ],
'energyMeters': [ title: 'Energy Meters', capability: 'energyMeter', attributes: ['energy'] ],
'filters': [ title: 'Filters', capability: 'filterStatus', attributes: ['filterStatus'] ],
'gasDetectors': [ title: 'Gas Detectors', capability: 'gasDetector', attributes: ['naturalGas'] ],
'humidities': [ title: 'Humidity Meters', capability: 'relativeHumidityMeasurement', attributes: ['humidity'] ],
'illuminances': [ title: 'Illuminance Meters', capability: 'illuminanceMeasurement', attributes: ['illuminance'] ],
'liquidFlowMeters': [ title: 'Liquid Flow Meters', capability: 'liquidFlowRate', attributes: ['rate'] ],
'locks': [ title: 'Locks', capability: 'lock', attributes: ['lock'] ],
'motions': [ title: 'Motion Sensors', capability: 'motionSensor', attributes: ['motion'] ],
'musicPlayers': [ title: 'Music Players', capability: 'musicPlayer', attributes: ['status', 'level', 'trackDescription', 'trackData', 'mute'] ],
'peds': [ title: 'Pedometers', capability: 'stepSensor', attributes: ['steps', 'goal'] ],
'phMeters': [ title: 'pH Meters', capability: 'pHMeasurement', attributes: ['pH'] ],
'powerMeters': [ title: 'Power Meters', capability: 'powerMeter', attributes: ['power'] ],
'powerSources': [ title: 'Power Sources', capability: 'powerSource', attributes: ['powerSource'] ],
'presences': [ title: 'Presence Sensors', capability: 'presenceSensor', attributes: ['presence'] ],
'pressures': [ title: 'Pressure Sensors', capability: 'pressureMeasurement', attributes: ['pressure'] ],
'shockSensors': [ title: 'Shock Sensors', capability: 'shockSensor', attributes: ['shock'] ],
'signalStrengthMeters': [ title: 'Signal Strength Meters', capability: 'signalStrength', attributes: ['lqi', 'rssi'] ],
'sleepSensors': [ title: 'Sleep Sensors', capability: 'sleepSensor', attributes: ['sleeping'] ],
'smokeDetectors': [ title: 'Smoke Detectors', capability: 'smokeDetector', attributes: ['smoke'] ],
'soundSensors': [ title: 'Sound Sensors', capability: 'soundSensor', attributes: ['sound'] ],
'spls': [ title: 'Sound Pressure Level Sensors', capability: 'soundPressureLevel', attributes: ['soundPressureLevel'] ],
'switches': [ title: 'Switches', capability: 'switch', attributes: ['switch'] ],
'switchLevels': [ title: 'Switch Levels', capability: 'switchLevel', attributes: ['level'] ],
'tamperAlerts': [ title: 'Tamper Alerts', capability: 'tamperAlert', attributes: ['tamper'] ],
'temperatures': [ title: 'Temperature Sensors', capability: 'temperatureMeasurement', attributes: ['temperature'] ],
'thermostats': [ title: 'Thermostats', capability: 'thermostat', attributes: ['temperature', 'heatingSetpoint', 'coolingSetpoint', 'thermostatSetpoint', 'thermostatMode', 'thermostatFanMode', 'thermostatOperatingState', 'thermostatSetpointMode', 'scheduledSetpoint'] ],
'threeAxis': [ title: 'Three-axis (Orientation) Sensors', capability: 'threeAxis', attributes: ['threeAxis'] ],
'touchs': [ title: 'Touch Sensors', capability: 'touchSensor', attributes: ['touch'] ],
'uvs': [ title: 'UV Sensors', capability: 'ultravioletIndex', attributes: ['ultravioletIndex'] ],
'valves': [ title: 'Valves', capability: 'valve', attributes: ['valve'] ],
'volts': [ title: 'Voltage Meters', capability: 'voltageMeasurement', attributes: ['voltage'] ],
'waterSensors': [ title: 'Water Sensors', capability: 'waterSensor', attributes: ['water'] ],
'windowShades': [ title: 'Window Shades', capability: 'windowShade', attributes: ['windowShade'] ]
]
// Momentary attributes that should be ignored for keep alive
@Field static final List<String> momentaryAttributes = [
'pushed', 'doubleTapped', 'held', 'released'
]
@Field static final Map<Integer,String> logOptions = [
0 : "None",
1 : "Error",
2 : "Warning",
3 : "Info",
4 : "Debug"
]
@Field static final Integer logNone = 0
@Field static final Integer logError = 1
@Field static final Integer logWarn = 2
@Field static final Integer logInfo = 3
@Field static final Integer logDebug = 4
preferences {
page(name: "setupMain")
page(name: "connectionPage")
}
def setupMain() {
dynamicPage(name: "setupMain", title: "<h2>InfluxDB Logger</h2>", install: true, uninstall: true) {
section("<h3>\nGeneral Settings:</h3>") {
input(
"appName",
"text",
title: "Aplication Name",
multiple: false,
required: true,
submitOnChange: true,
defaultValue: app.getLabel()
)
input(
name: "configLoggingLevelIDE",
title: "System log level - messages with this level and higher will be sent to the system log",
type: "enum",
options: logOptions,
defaultValue: "${logWarn}",
required: false
)
}
section("\n<h3>InfluxDB Settings:</h3>") {
href(
name: "href",
title: "InfluxDB connection",
description: prefDatabaseHost == null ? "Configure database connection parameters" : uriString(),
required: true,
page: "connectionPage"
)
input(
name: "prefBatchTimeLimit",
title: "Batch time limit - maximum number of seconds before writing a batch to InfluxDB (range 1-300)",
type: "number",
range: "1..300",
defaultValue: "60",
required: true
)
input(
name: "prefBatchSizeLimit",
title: "Batch size limit - maximum number of events in a batch to InfluxDB (range 1-250)",
type: "number",
range: "1..250",
defaultValue: "50",
required: true
)
input(
name: "prefBacklogLimit",
title: "Backlog size limit - maximum number of queued events before dropping failed posts (range 1-10000)",
type: "number",
range: "1..10000",
defaultValue: "5000",
required: true
)
input(
name: "prefQueueSizeVariable",
title: "Record InfluxDB backlog size in hub variable (optional, off by default)",
type: "enum",
required: false,
options: getGlobalVarsByType("integer").keySet().sort(){ it.capitalize() }
)
paragraph "Notes: Queue size variable must be type integer (Number), and is updated following each post to InfluxDB."
}
section("\n<h3>Event Handling:</h3>") {
input(
// NB: Called prefSoftPollingInterval for backward compatibility with prior versions
name: "prefSoftPollingInterval",
title: "Post keep alive events (aka softpoll) - check every softpoll interval and re-post last value if a new event has not occurred in this time",
type: "enum",
options: [
"0" : "disabled",
"1" : "1 minute (not recommended)",
"5" : "5 minutes",
"10" : "10 minutes",
"15" : "15 minutes",
"30" : "30 minutes",
"60" : "60 minutes",
"180" : "3 hours"
],
defaultValue: "15",
submitOnChange: true,
required: true
)
if (prefSoftPollingInterval?.toInteger()) {
input(
"prefPostHubInfo",
"bool",
title: "Post Hub information (IP, firmware, uptime, mode, sunrise/sunset) to InfluxDB",
defaultValue: false
)
}
input(
"includeHubInfo",
"bool",
title: "Include Hub Name as a tag for events",
defaultValue: true
)
input(
"filterEvents",
"bool",
title: "Only post device events to InfluxDB when the data value changes",
defaultValue: true
)
}
section("Devices To Monitor:", hideable:true, hidden:false) {
input(
"accessAllAttributes",
"bool",
title: "Advanced attribute selection?",
defaultValue: false,
submitOnChange: true
)
if (accessAllAttributes) {
input(
name: "allDevices",
type: "capability.*",
title: "Selected Devices",
multiple: true,
required: false,
submitOnChange: true
)
settings.allDevices.each { device ->
deviceId = device.getId()
attrList = device.getSupportedAttributes().unique()
if (attrList) {
options = []
attrList.each { attr ->
options.add("${attr}")
}
input(
name:"attrForDev${deviceId}",
type: "enum",
title: "$device",
options: options.sort(),
multiple: true,
required: false,
submitOnChange: true )
}
}
}
else {
deviceTypeMap.each { name, entry ->
input(
"${name}",
"capability.${entry.capability}",
title: "${entry.title}",
multiple: true,
required: false
)
}
}
}
section("Variables To Monitor:", hideable:true, hidden:false) {
List vars = []
getAllGlobalVars().each {
// The format of datetime variables is a bit of a show, making
// them very difficult to normalize. Also, datetime values are
// of limited value for time series data, so they are excluded.
switch (it.value.type) {
case 'integer':
case 'bigdecimal':
case 'boolean':
case 'string':
vars += it.key
break
}
}
input(
"variableList",
"enum",
title: "Selected Variables (datetime variables are not supported)",
multiple: true,
required: false,
submitOnChange: true,
options: vars.sort(){ it.capitalize() }
)
}
}
}
def connectionPage() {
dynamicPage(name: "connectionPage", title: "Connection Properties", install: false, uninstall: false) {
section {
input(
"prefDatabaseTls",
"bool",
title: "Use TLS?",
defaultValue: false,
submitOnChange: true
)
if (prefDatabaseTls) {
input(
"prefIgnoreSSLIssues",
"bool",
title: "Ignore SSL cert verification issues",
defaultValue: false
)
}
input(
"prefDatabaseHost",
"text",
title: "Host",
defaultValue: "",
required: true
)
input(
"prefDatabasePort",
"text",
title: "Port",
defaultValue: prefDatabaseTls ? "443" : "8086",
required: false
)
input(
name: "prefInfluxVer",
title: "Influx Version",
type: "enum",
options: [
"1" : "v1.x",
"2" : "v2.x"
],
required: true,
submitOnChange: true
)
if (prefInfluxVer == "1") {
input(
"prefDatabaseName",
"text",
title: "Database Name",
defaultValue: "Hubitat",
required: true
)
paragraph "Do not use special characters (including spaces) in Database Names"
}
else if (prefInfluxVer == "2") {
input(
"prefOrg",
"text",
title: "Org",
defaultValue: "",
required: true
)
input(
"prefBucket",
"text",
title: "Bucket",
defaultValue: "",
required: true
)
paragraph "Do not use special characters (including spaces) in Org or Bucket Names"
}
input(
name: "prefAuthType",
title: "Authorization Type",
type: "enum",
options: [
"none" : "None",
"basic" : "Username / Password",
"token" : "Token"
],
required: true,
submitOnChange: true
)
if (prefAuthType == "basic") {
input(
"prefDatabaseUser",
"text",
title: "Username",
defaultValue: "",
required: true
)
input(
"prefDatabasePass",
"text",
title: "Password",
defaultValue: "",
required: true
)
}
else if (prefAuthType == "token") {
input(
"prefDatabaseToken",
"text",
title: "Token",
required: true
)
}
}
}
}
/**
* installed()
*
* Runs when the app is first installed.
**/
void installed() {
state.installedAt = now()
state.loggerQueue = []
state.postCount = 0
updated()
log.info "${app.label}: Installed"
}
/**
* uninstalled()
*
* Runs when the app is uninstalled.
**/
void uninstalled() {
log.info "${app.label}: Uninstalled"
}
/**
* updated()
*
* Runs when app settings are changed.
**/
void updated() {
// Update application name
app.updateLabel(settings.appName)
logger("${app.label}: Updated", logInfo)
// Database config:
setupDB()
// Clear out any prior subscriptions
unsubscribe()
removeAllInUseGlobalVar()
// Register use and create subscriptions for variables
if (prefQueueSizeVariable) {
logger("Queue size available in variable ${prefQueueSizeVariable}", logInfo)
addInUseGlobalVar(prefQueueSizeVariable)
}
variableList.each { variable ->
logger("Subscribing to variable ${variable}", logInfo)
subscribe(location, "variable:${variable}", "handleVariableEvent")
addInUseGlobalVar(variable)
}
// Create device subscriptions
Map<String,List> deviceAttrMap = getDeviceAttrMap()
deviceAttrMap.each { device, attrList ->
attrList.each { attr ->
logger("Subscribing to ${device}: ${attr}", logInfo)
subscribe(device, attr, handleEvent, ["filterEvents": filterEvents])
}
}
// Subscribe to system start
subscribe(location, "systemStart", hubRestartHandler)
// Subscribe to mode events if requested
if (prefPostHubInfo) {
subscribe(location, "mode", handleModeEvent)
}
// Clear out any prior schedules
unschedule()
// Set up softpoll if requested
// NB: This is called softPoll to maintain backward compatibility wirh prior versions
state.softPollingInterval = settings.prefSoftPollingInterval.toInteger()
switch (state.softPollingInterval) {
case 1:
runEvery1Minute(softPoll)
break
case 5:
runEvery5Minutes(softPoll)
break
case 10:
runEvery10Minutes(softPoll)
break
case 15:
runEvery15Minutes(softPoll)
break
case 30:
runEvery30Minutes(softPoll)
break
case 60:
runEvery1Hour(softPoll)
break
case 180:
runEvery3Hours(softPoll)
break
}
// Flush any pending batch
runIn(1, writeQueuedDataToInfluxDb)
}
/**
* getDeviceAttrMap()
*
* Build a device attribute map.
*
* If using attribute selection, a device will appear only once in the array, with one or more attributes.
* If using capability selection, a device may appear multiple times in the array, each time with a single attribue.
**/
private Map<String,List> getDeviceAttrMap() {
deviceAttrMap = [:]
if (settings.accessAllAttributes) {
settings.allDevices.each { device ->
deviceId = device.getId()
deviceAttrMap[device] = settings["attrForDev${deviceId}"]
}
}
else {
deviceTypeMap.each { name, entry ->
deviceList = settings."${name}"
if (deviceList) {
deviceList.each { device ->
deviceAttrMap[device] = entry.attributes
}
}
}
}
return deviceAttrMap
}
/**
* hubRestartHandler()
*
* Handle hub restarts.
**/
void hubRestartHandler(evt) {
if (prefPostHubInfo) {
handleModeEvent(null)
}
if (state.loggerQueue.size()) {
runIn(60, writeQueuedDataToInfluxDb)
}
}
/**
* encodeVariableEvent(evt)
*
* Builds data to send to InfluxDB for variable events.
**/
private String encodeVariableEvent(evt) {
//
// Variables are strongly typed, so no guessing is required.
//
// Variable types are mapped to InfluxDB types as follows:
// Number -> Integer
// Decimal -> Float
// String -> String
// Boolean -> Boolean
// DateTime <not supported>
String name = evt.name - 'variable:'
def variable = getGlobalVar(name)
String type = variable.type
String value
// Determine the value
// NB: value must be escaped here if necessary
switch (type) {
case 'integer':
value = "${evt.value}i"
break
case 'bigdecimal':
value = "${evt.value}"
break
case 'boolean':
value = evt.value == 'true' ? 'T' : 'F'
break
case 'string':
value = '"' + escapeStringForInfluxDB(evt.value) + '"'
break
}
// Set up the measurement and variable name
String variableName = escapeStringForInfluxDB(name)
String data = "${type}Variable,variableName=${variableName}"
// Add hub name (location) tag if requested
if (settings.includeHubInfo == null || settings.includeHubInfo) {
String hubName = escapeStringForInfluxDB(location.name)
data += ",hubName=${hubName}"
}
// Add the value
data += " value=${value}"
// Add the event timestamp
long eventTimestamp = evt.unixTime * 1e6 // milliseconds to nanoseconds
data += " ${eventTimestamp}"
return(data)
}
/**
* encodeDeviceEvent(evt)
*
* Builds data to send to InfluxDB for device events.
* - Escapes and quotes string values.
* - Calculates logical binary values where string values can be
* represented as binary values (e.g. contact: closed = 1, open = 0)
**/
private String encodeDeviceEvent(evt) {
//
// This switch handles special processing for various events types
//
// Entries in the switch may optionally set the unit, value, or valueBinary fields.
// Any fields set in the switch are "final" and do not receive further processing,
// so all field assignments must be escaped as necessary.
//
// If not set in the switch, the unit and value fields will be defaulted as follows:
//
// Unit: If valueBinary has been set in the switch, the unit tag will be the
// will be set to the name of the event (evt.name). Otherwise, the unit
// tag will be set to the unit of the event (evt.unit). Both will be
// escaped.
// Value: If the value in the event (evt.value) is a valid number, the value
// will be InfluxDB's default numeric type (float). Othersie, the value
// will be escaped and inclosed in double quotes as a string.
//
// NB: While valueBinary is actuall a true/false Boolean, it is inserted into
// InfluxDB as an integer for backward compatibility reasons.
//
String unit = ''
String value = ''
String valueBinary = ''
switch (evt.name) {
case 'acceleration':
// binary value: active = 1, <any other value> = 0
valueBinary = (evt.value == 'active') ? '1i' : '0i'
break
case 'alarm':
// binary value: <any other value> = 1, off = 0
valueBinary = (evt.value == 'off') ? '0i' : '1i'
break
case 'carbonMonoxide':
// binary value: detected = 1, <any other value> = 0
valueBinary = (evt.value == 'detected') ? '1i' : '0i'
break
case 'consumableStatus':
// binary value: good = 1, <any other value> = 0
valueBinary = (evt.value == 'good') ? '1i' : '0i'
break
case 'contact':
// binary value: closed = 1, <any other value> = 0
valueBinary = (evt.value == 'closed') ? '1i' : '0i'
break
case 'door':
// binary value: closed = 1, <any other value> = 0
valueBinary = (evt.value == 'closed') ? '1i' : '0i'
break
case 'filterStatus':
// binary value: normal = 1, <any other value> = 0
valueBinary = (evt.value == 'normal') ? '1i' : '0i'
break
case 'lock':
// binary value: locked = 1, <any other value> = 0
valueBinary = (evt.value == 'locked') ? '1i' : '0i'
break
case 'motion':
// binary value: active = 1, <any other value> = 0
valueBinary = (evt.value == 'active') ? '1i' : '0i'
break
case 'mute':
// binary value: muted = 1, <any other value> = 0
valueBinary = (evt.value == 'muted') ? '1i' : '0i'
break
case 'naturalGas':
// binary value: detected = 1, <any other value> = 0
valueBinary = (evt.value == 'detected') ? '1i' : '0i'
break
case 'powerSource':
// binary value: mains = 1, <any other value> = 0
valueBinary = (evt.value == 'mains') ? '1i' : '0i'
break
case 'presence':
// binary value: present = 1, <any other value> = 0
valueBinary = (evt.value == 'present') ? '1i' : '0i'
break
case 'shock':
// binary value: detected = 1, <any other value> = 0
valueBinary = (evt.value == 'detected') ? '1i' : '0i'
break
case 'sleeping':
// binary value: sleeping = 1, <any other value> = 0
valueBinary = (evt.value == 'sleeping') ? '1i' : '0i'
break
case 'smoke':
// binary value: detected = 1, <any other value> = 0
valueBinary = (evt.value == 'detected') ? '1i' : '0i'
break
case 'sound':
// binary value: detected = 1, <any other value> = 0
valueBinary = (evt.value == 'detected') ? '1i' : '0i'
break
case 'switch':
// binary value: on = 1, <any other value> = 0
valueBinary = (evt.value == 'on') ? '1i' : '0i'
break
case 'tamper':
// binary value: detected = 1, <any other value> = 0
valueBinary = (evt.value == 'detected') ? '1i' : '0i'
break
case 'thermostatMode':
// binary value: <any other value> = 1, off = 0
valueBinary = (evt.value == 'off') ? '0i' : '1i'
break
case 'thermostatFanMode':
// binary value: <any other value> = 1, auto = 0
valueBinary = (evt.value == 'auto') ? '0i' : '1i'
break
case 'thermostatOperatingState':
// binary value: heating or cooling = 1, <any other value> = 0
valueBinary = (evt.value == 'heating' || evt.value == 'cooling') ? '1i' : '0i'
break
case 'thermostatSetpointMode':
// binary value: followSchedule = 0, <any other value> = 1
valueBinary = (evt.value == 'followSchedule') ? '0i' : '1i'
break
case 'threeAxis':
// threeAxis: Format to x,y,z values
unit = evt.name
try {
/* groovylint-disable-next-line UnusedVariable, VariableName */
def (_,x,y,z) = (evt.value =~ /^\[x:(-?[0-9]{1,3}),y:(-?[0-9]{1,3}),z:(-?[0-9]{1,3})\]$/)[0]
value = "valueX=${x}i,valueY=${y}i,valueZ=${z}i" // values are integers
}
catch (e) {
value = "valueX=0i,valueY=0i,valueZ=0i"
logger("Invalid threeAxis format: ${evt.value}", logWarn)
}
break
case 'touch':
// binary value: touched = 1, <any other value> = 0
valueBinary = (evt.value == 'touched') ? '1i' : '0i'
break
case 'valve':
// binary value: open = 1, <any other value> = 0
valueBinary = (evt.value == 'open') ? '1i' : '0i'
break
case 'water':
// binary value: wet = 1, <any other value> = 0
valueBinary = (evt.value == 'wet') ? '1i' : '0i'
break
case 'windowShade':
// binary value: closed = 1, <any other value> = 0
valueBinary = (evt.value == 'closed') ? '1i' : '0i'
break
// The Mysterious Case of The Button
// binary value: released = 0, <any other value> = 1
// Note that button attributes are excluded from softpoll
case 'doubleTapped':
case 'held':
case 'pushed':
unit = 'button'
valueBinary = '1i'
break
case 'released':
unit = 'button'
valueBinary = '0i'
break
}
// If a unit tag has not been assigned above, assign it from the event.
if (!unit) {
if (valueBinary) {
// If a binary value was set, use the event name as the unit tag.
unit = escapeStringForInfluxDB(evt.name)
}
else if (evt.unit) {
// Otherwise, use the event unit if defined.
unit = escapeStringForInfluxDB(evt.unit)
}
}
// If a value has not been assigned above, assign it from the event value.
if (!value) {
if (evt.value.isNumber()) {
// It's a number. Common numerical events such as carbonDioxide, power, energy,
// humidity, level, temperature, ultravioletIndex, voltage, etc. are handled here.
value = evt.value
}
else {
// Everything else is a string.
value = '"' + escapeStringForInfluxDB(evt.value) + '"'
}
}
// Build the data string to send to InfluxDB:
// Format: <measurement>[,<tag_name>=<tag_value>] field=<field_value>
// If value is an integer, it must have a trailing "i"
// If value is a string, it must be enclosed in double quotes.
String measurement = escapeStringForInfluxDB((evt.name))
String deviceId = evt.deviceId
String deviceName = escapeStringForInfluxDB(evt.displayName)
String data = "${measurement},deviceName=${deviceName},deviceId=${deviceId}"
// Add hub name (location) tag if requested
if (settings.includeHubInfo == null || settings.includeHubInfo) {
String hubName = escapeStringForInfluxDB(location.name)
data += ",hubName=${hubName}"
}
// Add the unit and value(s)
if (unit) {
data += ",unit=${unit}"
}
if (value ==~ /^value.*/) {
// Assignment has already been done above (e.g. threeAxis)
data += " ${value}"
}
else {
data += " value=${value}"
}
if (valueBinary) {
data += ",valueBinary=${valueBinary}"
}
// Add the event timestamp
long eventTimestamp = evt.unixTime * 1e6 // milliseconds to nanoseconds
data += " ${eventTimestamp}"
// Return the completed string
return(data)
}
/**
* encodeHubInfo(evt)
*
* Build a Hub Information record to send to InfluxDB.
**/
private String encodeHubInfo(evt) {
String hubName = escapeStringForInfluxDB(location.name)
String localIP = escapeStringForInfluxDB(location.hub.localIP)
String firmwareVersion = escapeStringForInfluxDB(location.hub.firmwareVersionString)
String upTime = escapeStringForInfluxDB(location.hub.uptime.toString())
String mode = escapeStringForInfluxDB(evt?.value ? evt.value : location.getMode())
def times = getSunriseAndSunset()
String sunriseTime = escapeStringForInfluxDB(times.sunrise.format("HH:mm", location.timeZone))
String sunsetTime = escapeStringForInfluxDB(times.sunset.format("HH:mm", location.timeZone))
Long eventTimestamp = (evt?.unixTime ? evt.unixTime : now()) * 1e6 // Time is in milliseconds, but InfluxDB expects nanoseconds
String data = "_hubInfo,hubName=${hubName} localIP=\"${localIP}\",firmwareVersion=\"${firmwareVersion}\",upTime=\"${upTime}\",mode=\"${mode}\",sunriseTime=\"${sunriseTime}\",sunsetTime=\"${sunsetTime}\" ${eventTimestamp}"
return data
}
/**
* handleVariableEvent(evt)
*
* Handle variable events
**/
void handleVariableEvent(evt) {
logger("Handle Variable Event: ${evt}", logDebug)
// Encode the event
data = encodeVariableEvent(evt)
// Add event to the queue for InfluxDB
queueToInfluxDb([data])
}
/**
* handleEvent(evt)
*
* Handle device events
**/
void handleEvent(evt) {
logger("Handle Event: ${evt}", logDebug)
// Encode the event
data = encodeDeviceEvent(evt)
// Add event to the queue for InfluxDB
queueToInfluxDb([data])
}
/**
* handleModeEvent(evt)
*
* Log hub information when mode changes.
**/
void handleModeEvent(evt) {
logger("Handle Mode Event: ${evt}", logDebug)
// Encode the event
data = encodeHubInfo(evt)
// Add event to the queue for InfluxDB
queueToInfluxDb([data])
}
/**
* softPoll()
*
* Re-queues last value to InfluxDB unless an event has already been seen in the last softPollingInterval.
* Also calls LogSystemProperties().
*
* NB: Function name softPoll must be kept for backward compatibility
**/
void softPoll() {
logger("Keepalive check", logDebug)
// Create the list
Long timeNow = now()
List<String> eventList = []
// Generate variable records
variableList.each { name ->
logger("Keep alive for variable ${name}", logDebug)
event = encodeVariableEvent([
name: "variable:${name}",
value: getGlobalVar(name).value,
unixTime: timeNow
])
eventList.add(event)
}
// Generate device records