-
Notifications
You must be signed in to change notification settings - Fork 103
/
Copy pathplugin.yaml
1361 lines (1281 loc) · 47.5 KB
/
plugin.yaml
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
# Metadata for the plugin
plugin:
# Global plugin attributes
type: system # plugin type (gateway, interface, protocol, system, web)
description:
de: Add-On für das database Plugin zur Datenauswertung
en: Add-On for the database plugin for data evaluation
maintainer: sisamiwe
tester: bmx, onkelandy # Who tests this plugin?
state: ready # change to ready when done with development
# keywords: iot xyz
# documentation: https://github.com/smarthomeNG/smarthome/wiki/CLI-Plugin # url of documentation (wiki) page
support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1848494-support-thread-databaseaddon-plugin
version: 1.2.7 # Plugin version (must match the version specified in __init__.py)
sh_minversion: 1.9.3.5 # minimum shNG version to use this plugin
# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
py_minversion: 3.8 # minimum Python version to use for this plugin
# py_maxversion: # maximum Python version to use for this plugin (leave empty if latest)
multi_instance: false # plugin supports multi instance
restartable: unknown
classname: DatabaseAddOn # class containing the plugin
parameters:
database_plugin_config:
type: str
default: database
description:
de: Konfiguration des Plugin 'Database', für die das Plugin 'DatabaseAddOn' verwendet wird
en: Config of Plugin 'Database, for which the Plugin 'DatabaseAddOn' should be active
startup_run_delay:
type: int
default: 60
description:
de: Zeitlicher Abstand in Sekunden, mit der die Berechnungen bei Startup ausgeführt werden sollen
en: Delay in seconds, after which the startup calculations will be run
ignore_0:
type: list(str)
default: []
description:
de: 'Bei Items, bei denen ein String aus der Liste im Pfadnamen vorkommt, werden 0-Werte (val_num = 0) bei Datenbankauswertungen ignoriert. Beispieleintrag: temp | hum'
en: 'At items having a entry of that list in path, val_num=0 will be ignored for database queries. Example: temp | hum'
value_filter:
type: dict
description:
de: "Definition von Wertefiltern als Wörterbuch {'Teil des Itempfades: [Liste von Vergleichsoperatoren als String]} Bsp: {'temp': ['> -10', '< 85'], 'hum': ['>= 0', '<= 100']}"
en: "Definition of value filters as dict {'part of item path': [List of comparison operators als string]} Example: {'temp': ['> -10', '< 85'], 'hum': ['>= 0', '<= 100']}"
optimize_value_filter:
type: bool
default: true
description:
de: Optimierung der gesetzen als Plugin-Parameter oder/und Item-Attribute gesetzten Wertefilter.
en: Optimize value filters set as plugin parameter or/and item attribute
use_oldest_entry:
type: bool
default: false
description:
de: 'True: Verwendung des ältesten Eintrags des Items in der Datenbank, falls der Start des Abfragezeitraums zeitlich vor diesem Eintrag liegt False: Abbruch der Datenbankabfrage'
en: 'True: Use of oldest entry of item in database, if start of query is prior to oldest entry False: Cancel query'
lock_db_for_query:
type: bool
default: false
description:
de: Sperren der Datenbank während der Abfrage
en: Lock the database during queries
item_attributes:
db_addon_fct:
type: str
description:
de: Auswertefunktion des DB-Addon Plugins
en: Evaluation Function of DB-Addon Plugins
valid_list:
# NOTE: valid_list is automatically created by using item_attributes_master.py
- verbrauch_heute
- verbrauch_tag
- verbrauch_woche
- verbrauch_monat
- verbrauch_jahr
- verbrauch_last_24h
- verbrauch_last_7d
- verbrauch_heute_minus1
- verbrauch_heute_minus2
- verbrauch_heute_minus3
- verbrauch_heute_minus4
- verbrauch_heute_minus5
- verbrauch_heute_minus6
- verbrauch_heute_minus7
- verbrauch_heute_minus8
- verbrauch_tag_minus1
- verbrauch_tag_minus2
- verbrauch_tag_minus3
- verbrauch_tag_minus4
- verbrauch_tag_minus5
- verbrauch_tag_minus6
- verbrauch_tag_minus7
- verbrauch_tag_minus8
- verbrauch_woche_minus1
- verbrauch_woche_minus2
- verbrauch_woche_minus3
- verbrauch_woche_minus4
- verbrauch_monat_minus1
- verbrauch_monat_minus2
- verbrauch_monat_minus3
- verbrauch_monat_minus4
- verbrauch_monat_minus12
- verbrauch_jahr_minus1
- verbrauch_jahr_minus2
- verbrauch_jahr_minus3
- verbrauch_rolling_12m_heute_minus1
- verbrauch_rolling_12m_tag_minus1
- verbrauch_rolling_12m_woche_minus1
- verbrauch_rolling_12m_monat_minus1
- verbrauch_rolling_12m_jahr_minus1
- verbrauch_jahreszeitraum_minus1
- verbrauch_jahreszeitraum_minus2
- verbrauch_jahreszeitraum_minus3
- zaehlerstand_heute_minus1
- zaehlerstand_heute_minus2
- zaehlerstand_heute_minus3
- zaehlerstand_tag_minus1
- zaehlerstand_tag_minus2
- zaehlerstand_tag_minus3
- zaehlerstand_woche_minus1
- zaehlerstand_woche_minus2
- zaehlerstand_woche_minus3
- zaehlerstand_monat_minus1
- zaehlerstand_monat_minus2
- zaehlerstand_monat_minus3
- zaehlerstand_jahr_minus1
- zaehlerstand_jahr_minus2
- zaehlerstand_jahr_minus3
- minmax_last_24h_min
- minmax_last_24h_max
- minmax_last_24h_avg
- minmax_last_7d_min
- minmax_last_7d_max
- minmax_last_7d_avg
- minmax_heute_min
- minmax_heute_max
- minmax_heute_avg
- minmax_heute_minus1_min
- minmax_heute_minus1_max
- minmax_heute_minus1_avg
- minmax_heute_minus2_min
- minmax_heute_minus2_max
- minmax_heute_minus2_avg
- minmax_heute_minus3_min
- minmax_heute_minus3_max
- minmax_heute_minus3_avg
- minmax_tag_min
- minmax_tag_max
- minmax_tag_avg
- minmax_tag_minus1_min
- minmax_tag_minus1_max
- minmax_tag_minus1_avg
- minmax_tag_minus2_min
- minmax_tag_minus2_max
- minmax_tag_minus2_avg
- minmax_tag_minus3_min
- minmax_tag_minus3_max
- minmax_tag_minus3_avg
- minmax_woche_min
- minmax_woche_max
- minmax_woche_minus1_min
- minmax_woche_minus1_max
- minmax_woche_minus1_avg
- minmax_woche_minus2_min
- minmax_woche_minus2_max
- minmax_woche_minus2_avg
- minmax_monat_min
- minmax_monat_max
- minmax_monat_minus1_min
- minmax_monat_minus1_max
- minmax_monat_minus1_avg
- minmax_monat_minus2_min
- minmax_monat_minus2_max
- minmax_monat_minus2_avg
- minmax_jahr_min
- minmax_jahr_max
- minmax_jahr_minus1_min
- minmax_jahr_minus1_max
- minmax_jahr_minus1_avg
- tagesmitteltemperatur_heute
- tagesmitteltemperatur_heute_minus1
- tagesmitteltemperatur_heute_minus2
- tagesmitteltemperatur_heute_minus3
- tagesmitteltemperatur_tag
- tagesmitteltemperatur_tag_minus1
- tagesmitteltemperatur_tag_minus2
- tagesmitteltemperatur_tag_minus3
- serie_minmax_monat_min_15m
- serie_minmax_monat_max_15m
- serie_minmax_monat_avg_15m
- serie_minmax_woche_min_30w
- serie_minmax_woche_max_30w
- serie_minmax_woche_avg_30w
- serie_minmax_tag_min_30d
- serie_minmax_tag_max_30d
- serie_minmax_tag_avg_30d
- serie_verbrauch_tag_30d
- serie_verbrauch_woche_30w
- serie_verbrauch_monat_18m
- serie_zaehlerstand_tag_30d
- serie_zaehlerstand_woche_30w
- serie_zaehlerstand_monat_18m
- serie_waermesumme_monat_24m
- serie_kaeltesumme_monat_24m
- serie_tagesmittelwert_0d
- serie_tagesmittelwert_stunde_0d
- serie_tagesmittelwert_stunde_30_0d
- serie_tagesmittelwert_tag_stunde_30d
- general_oldest_value
- general_oldest_log
- kaeltesumme
- waermesumme
- gruenlandtempsumme
- wachstumsgradtage
- wuestentage
- heisse_tage
- tropennaechte
- sommertage
- heiztage
- vegetationstage
- frosttage
- eistage
- tagesmitteltemperatur
- db_request
- minmax
- minmax_last
- verbrauch
- zaehlerstand
valid_list_description:
# NOTE: valid_list_description is automatically created by using item_attributes_master.py
- Verbrauch am heutigen Tag (Differenz zwischen aktuellem Wert und den Wert am Ende des vorherigen Tages)
- Verbrauch am heutigen Tag (Differenz zwischen aktuellem Wert und den Wert am Ende des vorherigen Tages)
- Verbrauch in der aktuellen Woche
- Verbrauch im aktuellen Monat
- Verbrauch im aktuellen Jahr
- Verbrauch innerhalb letzten 24h
- Verbrauch innerhalb letzten 7 Tage
- Verbrauch gestern (heute -1 Tag) (Differenz zwischen Wert am Ende des gestrigen Tages und dem Wert am Ende des Tages davor)
- Verbrauch vorgestern (heute -2 Tage)
- Verbrauch heute -3 Tage
- Verbrauch heute -4 Tage
- Verbrauch heute -5 Tage
- Verbrauch heute -6 Tage
- Verbrauch heute -7 Tage
- Verbrauch heute -8 Tage
- Verbrauch gestern (heute -1 Tag) (Differenz zwischen Wert am Ende des gestrigen Tages und dem Wert am Ende des Tages davor)
- Verbrauch vorgestern (heute -2 Tage)
- Verbrauch heute -3 Tage
- Verbrauch heute -4 Tage
- Verbrauch heute -5 Tage
- Verbrauch heute -6 Tage
- Verbrauch heute -7 Tage
- Verbrauch heute -8 Tage
- Verbrauch Vorwoche (aktuelle Woche -1)
- Verbrauch aktuelle Woche -2 Wochen
- Verbrauch aktuelle Woche -3 Wochen
- Verbrauch aktuelle Woche -4 Wochen
- Verbrauch Vormonat (aktueller Monat -1)
- Verbrauch aktueller Monat -2 Monate
- Verbrauch aktueller Monat -3 Monate
- Verbrauch aktueller Monat -4 Monate
- Verbrauch aktueller Monat -12 Monate
- Verbrauch Vorjahr (aktuelles Jahr -1 Jahr)
- Verbrauch aktuelles Jahr -2 Jahre
- Verbrauch aktuelles Jahr -3 Jahre
- Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Tages
- Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Tages
- Verbrauch der letzten 12 Monate ausgehend im Ende der letzten Woche
- Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Monats
- Verbrauch der letzten 12 Monate ausgehend im Ende des letzten Jahres
- Verbrauch seit dem 1.1. bis zum heutigen Tag des Vorjahres
- Verbrauch seit dem 1.1. bis zum heutigen Tag vor 2 Jahren
- Verbrauch seit dem 1.1. bis zum heutigen Tag vor 3 Jahren
- Zählerstand / Wert am Ende des letzten Tages (heute -1 Tag)
- Zählerstand / Wert am Ende des vorletzten Tages (heute -2 Tag)
- Zählerstand / Wert am Ende des vorvorletzten Tages (heute -3 Tag)
- Zählerstand / Wert am Ende des letzten Tages (heute -1 Tag)
- Zählerstand / Wert am Ende des vorletzten Tages (heute -2 Tag)
- Zählerstand / Wert am Ende des vorvorletzten Tages (heute -3 Tag)
- Zählerstand / Wert am Ende der vorvorletzten Woche (aktuelle Woche -1 Woche)
- Zählerstand / Wert am Ende der vorletzten Woche (aktuelle Woche -2 Wochen)
- Zählerstand / Wert am Ende der aktuellen Woche -3 Wochen
- Zählerstand / Wert am Ende des letzten Monates (aktueller Monat -1 Monat)
- Zählerstand / Wert am Ende des vorletzten Monates (aktueller Monat -2 Monate)
- Zählerstand / Wert am Ende des aktuellen Monats -3 Monate
- Zählerstand / Wert am Ende des letzten Jahres (aktuelles Jahr -1 Jahr)
- Zählerstand / Wert am Ende des vorletzten Jahres (aktuelles Jahr -2 Jahre)
- Zählerstand / Wert am Ende des aktuellen Jahres -3 Jahre
- minimaler Wert der letzten 24h
- maximaler Wert der letzten 24h
- durchschnittlicher Wert der letzten 24h
- minimaler Wert der letzten 7 Tage
- maximaler Wert der letzten 7 Tage
- durchschnittlicher Wert der letzten 7 Tage
- Minimalwert seit Tagesbeginn
- Maximalwert seit Tagesbeginn
- Durschnittswert seit Tagesbeginn
- Minimalwert gestern (heute -1 Tag)
- Maximalwert gestern (heute -1 Tag)
- Durchschnittswert gestern (heute -1 Tag)
- Minimalwert vorgestern (heute -2 Tage)
- Maximalwert vorgestern (heute -2 Tage)
- Durchschnittswert vorgestern (heute -2 Tage)
- Minimalwert heute vor 3 Tagen
- Maximalwert heute vor 3 Tagen
- Durchschnittswert heute vor 3 Tagen
- Minimalwert seit Tagesbeginn
- Maximalwert seit Tagesbeginn
- Durschnittswert seit Tagesbeginn
- Minimalwert gestern (heute -1 Tag)
- Maximalwert gestern (heute -1 Tag)
- Durchschnittswert gestern (heute -1 Tag)
- Minimalwert vorgestern (heute -2 Tage)
- Maximalwert vorgestern (heute -2 Tage)
- Durchschnittswert vorgestern (heute -2 Tage)
- Minimalwert heute vor 3 Tagen
- Maximalwert heute vor 3 Tagen
- Durchschnittswert heute vor 3 Tagen
- Minimalwert seit Wochenbeginn
- Maximalwert seit Wochenbeginn
- Minimalwert Vorwoche (aktuelle Woche -1)
- Maximalwert Vorwoche (aktuelle Woche -1)
- Durchschnittswert Vorwoche (aktuelle Woche -1)
- Minimalwert aktuelle Woche -2 Wochen
- Maximalwert aktuelle Woche -2 Wochen
- Durchschnittswert aktuelle Woche -2 Wochen
- Minimalwert seit Monatsbeginn
- Maximalwert seit Monatsbeginn
- Minimalwert Vormonat (aktueller Monat -1)
- Maximalwert Vormonat (aktueller Monat -1)
- Durchschnittswert Vormonat (aktueller Monat -1)
- Minimalwert aktueller Monat -2 Monate
- Maximalwert aktueller Monat -2 Monate
- Durchschnittswert aktueller Monat -2 Monate
- Minimalwert seit Jahresbeginn
- Maximalwert seit Jahresbeginn
- Minimalwert Vorjahr (aktuelles Jahr -1 Jahr)
- Maximalwert Vorjahr (aktuelles Jahr -1 Jahr)
- Durchschnittswert Vorjahr (aktuelles Jahr -1 Jahr)
- Tagesmitteltemperatur heute
- Tagesmitteltemperatur des letzten Tages (heute -1 Tag)
- Tagesmitteltemperatur des vorletzten Tages (heute -2 Tag)
- Tagesmitteltemperatur des vorvorletzten Tages (heute -3 Tag)
- Tagesmitteltemperatur heute
- Tagesmitteltemperatur des letzten Tages (heute -1 Tag)
- Tagesmitteltemperatur des vorletzten Tages (heute -2 Tag)
- Tagesmitteltemperatur des vorvorletzten Tages (heute -3 Tag)
- monatlicher Minimalwert der letzten 15 Monate (gleitend)
- monatlicher Maximalwert der letzten 15 Monate (gleitend)
- monatlicher Mittelwert der letzten 15 Monate (gleitend)
- wöchentlicher Minimalwert der letzten 30 Wochen (gleitend)
- wöchentlicher Maximalwert der letzten 30 Wochen (gleitend)
- wöchentlicher Mittelwert der letzten 30 Wochen (gleitend)
- täglicher Minimalwert der letzten 30 Tage (gleitend)
- täglicher Maximalwert der letzten 30 Tage (gleitend)
- täglicher Mittelwert der letzten 30 Tage (gleitend)
- Verbrauch pro Tag der letzten 30 Tage
- Verbrauch pro Woche der letzten 30 Wochen
- Verbrauch pro Monat der letzten 18 Monate
- Zählerstand am Tagesende der letzten 30 Tage
- Zählerstand am Wochenende der letzten 30 Wochen
- Zählerstand am Monatsende der letzten 18 Monate
- monatliche Wärmesumme der letzten 24 Monate
- monatliche Kältesumme der letzten 24 Monate
- Tagesmittelwert für den aktuellen Tag
- Stundenmittelwert für den aktuellen Tag
- Stundenmittelwert für den aktuellen Tag
- Stundenmittelwert pro Tag der letzten 30 Tage (bspw. zur Berechnung der Tagesmitteltemperatur basierend auf den Mittelwert der Temperatur pro Stunde
- Ausgabe des ältesten Wertes des entsprechenden "Parent-Items" mit database Attribut
- Ausgabe des Timestamp des ältesten Eintrages des entsprechenden "Parent-Items" mit database Attribut
- 'Berechnet die Kältesumme für einen Zeitraum, db_addon_params: (year=optional, month=optional)'
- 'Berechnet die Wärmesumme für einen Zeitraum, db_addon_params: (year=optional, month=optional)'
- 'Berechnet die Grünlandtemperatursumme für einen Zeitraum, db_addon_params: (year=optional)'
- Berechnet die Wachstumsgradtage auf Basis der stündlichen Durchschnittswerte eines Tages für das laufende Jahr mit an Angabe des Temperaturschwellenwertes (threshold=Schwellentemperatur)
- 'Berechnet die Anzahl der Wüstentage des Jahres, db_addon_params: (year=optional)'
- 'Berechnet die Anzahl der heissen Tage des Jahres, db_addon_params: (year=optional)'
- 'Berechnet die Anzahl der Tropennächte des Jahres, db_addon_params: (year=optional)'
- 'Berechnet die Anzahl der Sommertage des Jahres, db_addon_params: (year=optional)'
- 'Berechnet die Anzahl der Heiztage des Jahres, db_addon_params: (year=optional)'
- 'Berechnet die Anzahl der Vegatationstage des Jahres, db_addon_params: (year=optional)'
- 'Berechnet die Anzahl der Frosttage des Jahres, db_addon_params: (year=optional)'
- 'Berechnet die Anzahl der Eistage des Jahres, db_addon_params: (year=optional)'
- Berechnet die Tagesmitteltemperatur auf Basis der stündlichen Durchschnittswerte eines Tages für die angegebene Anzahl von Tagen (timeframe=day, count=integer)
- 'Abfrage der DB: db_addon_params: (func=mandatory, item=mandatory, timespan=mandatory, start=optional, end=optional, count=optional, group=optional, group2=optional)'
- 'Berechnet einen min/max/avg Wert für einen bestimmen Zeitraum: db_addon_params: (func=mandatory, timeframe=mandatory, start=mandatory)'
- 'Berechnet einen min/max/avg Wert für ein bestimmtes Zeitfenster von jetzt zurück: db_addon_params: (func=mandatory, timeframe=mandatory, start=mandatory, end=mandatory)'
- 'Berechnet einen Verbrauchswert für einen bestimmen Zeitraum: db_addon_params: (timeframe=mandatory, start=mandatory end=mandatory)'
- 'Berechnet einen Zählerstand für einen bestimmen Zeitpunkt: db_addon_params: (timeframe=mandatory, start=mandatory)'
valid_list_item_type:
# NOTE: valid_list_item_type is automatically created by using item_attributes_master.py
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- list
- num
- list
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- num
- list
- list
- num
- num
- num
- num
valid_list_calculation:
# NOTE: valid_list_calculation is automatically created by using item_attributes_master.py
- daily
- daily
- weekly
- monthly
- yearly
- hourly
- hourly
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- weekly
- weekly
- weekly
- weekly
- monthly
- monthly
- monthly
- monthly
- monthly
- yearly
- yearly
- yearly
- daily
- daily
- weekly
- monthly
- yearly
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- weekly
- weekly
- weekly
- monthly
- monthly
- monthly
- yearly
- yearly
- yearly
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- weekly
- weekly
- weekly
- weekly
- weekly
- weekly
- weekly
- weekly
- monthly
- monthly
- monthly
- monthly
- monthly
- monthly
- monthly
- monthly
- yearly
- yearly
- yearly
- yearly
- yearly
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- monthly
- monthly
- monthly
- weekly
- weekly
- weekly
- daily
- daily
- daily
- daily
- weekly
- monthly
- daily
- weekly
- monthly
- monthly
- monthly
- daily
- daily
- daily
- daily
- None
- None
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- daily
- group
- timeframe
- timeframe
- timeframe
- timeframe
db_addon_info:
type: str
description:
de: Info-Funktion des DB-Addon Plugins
en: Info-Function of DB-Addon Plugins
valid_list:
# NOTE: valid_list is automatically created by using item_attributes_master.py
- db_version
valid_list_description:
# NOTE: valid_list_description is automatically created by using item_attributes_master.py
- Version der verbundenen Datenbank
valid_list_item_type:
# NOTE: valid_list_item_type is automatically created by using item_attributes_master.py
- str
valid_list_calculation:
# NOTE: valid_list_calculation is automatically created by using item_attributes_master.py
- no
db_addon_admin:
type: str
description:
de: Admin-Funktion des DB-Addon Plugins
en: Admin-Function of DB-Addon Plugins
valid_list:
# NOTE: valid_list is automatically created by using item_attributes_master.py
- suspend
- recalc_all
- clean_cache_values
valid_list_description:
# NOTE: valid_list_description is automatically created by using item_attributes_master.py
- Unterbricht die Aktivitäten des Plugin
- Startet einen Neuberechnungslauf aller on-demand Items
- Löscht Plugin-Cache und damit alle im Plugin zwischengespeicherten Werte
valid_list_item_type:
# NOTE: valid_list_item_type is automatically created by using item_attributes_master.py
- bool
- bool
- bool
valid_list_calculation:
# NOTE: valid_list_calculation is automatically created by using item_attributes_master.py
- no
- no
- no
db_addon_params:
type: str
description:
de: Parameter für eine Auswertefunktion des DB-Addon Plugins im Format 'kwargs' enclosed in quotes like 'keyword=argument, keyword=argument'
en: Parameters of a DB-Addon Plugin evaluation function. Need to have format of 'kwargs' enclosed in quotes like 'keyword=argument, keyword=argument'
db_addon_params_dict:
type: dict
description:
de: Parameter für eine Auswertefunktion des DB-Addon Plugins im Format eines Dictionary
en: Parameters of a DB-Addon Plugin evaluation function. Need to have format of a dictionary
db_addon_startup:
type: bool
description:
de: Ausführen der Berechnung bei Plugin Start (mit zeitlichem Abstand, wie in den Plugin Parametern definiert)
en: Run function in startup of plugin (with delay, set in plugin parameters)
db_addon_ignore_value:
type: num
description:
de: Wert der bei Abfrage bzw. Auswertung der Datenbank für diese Item ignoriert werden soll
en: Value which will be ignored at database query
db_addon_ignore_value_list:
type: list(str)
description:
de: "Liste von Vergleichsoperatoren, die bei Abfrage bzw. Auswertung der Datenbank für dieses Item berücksichtigt werden sollen. Bsp: ['> 0', '< 35']"
en: List of comparison operators which will be used at database query
db_addon_database_item:
type: str
description:
de: 'Optional: Pfad des zu verwendenden Items mit Database Attribut'
en: 'Optional: Path of item with database attribut to be used'
item_structs:
verbrauch_1:
name: Struct für Verbrauchsauswertung bei Zählern mit stetig ansteigendem Zählerstand (Teil 1)
verbrauch_tag:
name: Verbrauch am heutigen Tag
db_addon_fct: verbrauch_tag
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_last_24h:
name: Verbrauch innerhalb der letzten 24h
db_addon_fct: verbrauch_last_24h
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_woche:
name: Verbrauch seit Wochenbeginn
db_addon_fct: verbrauch_woche
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_monat:
name: Verbrauch seit Monatsbeginn
db_addon_fct: verbrauch_monat
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_jahr:
name: Verbrauch seit Jahresbeginn
db_addon_fct: verbrauch_jahr
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_rolling_12m:
name: Verbrauch innerhalb der letzten 12 Monate ausgehend von gestern
db_addon_fct: verbrauch_rolling_12m_tag_minus1
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_tag_minus1:
name: Verbrauch gestern
db_addon_fct: verbrauch_tag_minus1
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_tag_minus2:
name: Verbrauch vorgestern
db_addon_fct: verbrauch_tag_minus2
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_tag_minus3:
name: Verbrauch vor 3 Tagen
db_addon_fct: verbrauch_tag_minus3
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_woche_minus1:
name: Verbrauch in der Vorwoche
db_addon_fct: verbrauch_woche_minus1
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_woche_minus2:
name: Verbrauch vor 2 Wochen
db_addon_fct: verbrauch_woche_minus2
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_monat_minus1:
name: Verbrauch im Vormonat
db_addon_fct: verbrauch_monat_minus1
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_monat_minus12:
name: Verbrauch vor 12 Monaten
db_addon_fct: verbrauch_monat_minus12
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_vorjahreszeitraum:
name: Verbrauch im Jahreszeitraum 1.1. bis jetzt vor einem Jahr
db_addon_fct: verbrauch_jahreszeitraum_minus1
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_verbrauch_rolling_12m_woche_minus1:
name: Verbrauch innerhalb der letzten 12 Monate ausgehend vom Ende letzter Woche
db_addon_fct: verbrauch_rolling_12m_woche_minus1
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
verbrauch_2:
name: Struct für Verbrauchsauswertung bei Zählern mit stetig ansteigendem Zählerstand (Teil 2)
verbrauch_tag_minus4:
name: Verbrauch vor 4 Tagen
db_addon_fct: verbrauch_tag_minus4
type: num
visu_acl: ro
cache: yes
verbrauch_tag_minus5:
name: Verbrauch vor 5 Tagen
db_addon_fct: verbrauch_tag_minus5
type: num
visu_acl: ro
cache: yes
verbrauch_tag_minus6:
name: Verbrauch vor 6 Tagen
db_addon_fct: verbrauch_tag_minus6
type: num
visu_acl: ro
cache: yes
verbrauch_tag_minus7:
name: Verbrauch vor 7 Tagen
db_addon_fct: verbrauch_tag_minus7
type: num
visu_acl: ro
cache: yes
verbrauch_tag_minus8:
name: Verbrauch vor 8 Tagen
db_addon_fct: verbrauch_tag_minus8
type: num
visu_acl: ro
cache: yes
verbrauch_woche_minus3:
name: Verbrauch vor 3 Wochen
db_addon_fct: verbrauch_woche_minus3
type: num
visu_acl: ro
cache: yes
verbrauch_woche_minus4:
name: Verbrauch vor 4 Wochen
db_addon_fct: verbrauch_woche_minus4
type: num
visu_acl: ro
cache: yes
verbrauch_monat_minus2:
name: Verbrauch vor 2 Monaten
db_addon_fct: verbrauch_monat_minus2
type: num
visu_acl: ro
cache: yes
verbrauch_monat_minus3:
name: Verbrauch vor 3 Monaten
db_addon_fct: verbrauch_monat_minus3
type: num
visu_acl: ro
cache: yes
verbrauch_monat_minus4:
name: Verbrauch vor 4 Monaten
db_addon_fct: verbrauch_monat_minus4
type: num
visu_acl: ro
cache: yes
zaehlerstand_1:
name: Struct für die Erfassung von Zählerständen zu bestimmten Zeitpunkten bei Zählern mit stetig ansteigendem Zählerstand
zaehlerstand_gestern:
name: Zählerstand zum Ende des gestrigen Tages
db_addon_fct: zaehlerstand_tag_minus1
db_addon_startup: yes
type: num
visu_acl: ro
cache: yes
zaehlerstand_woche_minus1:
name: Zählerstand zum Ende der vorigen Woche
db_addon_fct: zaehlerstand_woche_minus1
db_addon_startup: yes
type: num