-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path98_statistics.pm
1505 lines (1340 loc) · 60.2 KB
/
98_statistics.pm
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
##############################################
# $Id: 98_statistics.pm 26152 2022-07-11 Beta-User (commandref) $
#
# 98_statistic.pm
#
# (c) 2014 Torsten Poitzsch
# (c) 2014-2016 tupol http://forum.fhem.de/index.php?action=profile;u=5432
#
# This module computes statistic data of and for readings of other modules
#
# Copyright notice
#
# This script is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# The GNU General Public License can be found at
# http://www.gnu.org/copyleft/gpl.html.
# A copy is found in the text file GPL.txt and important notices to the license
# from the author is found in LICENSE.txt distributed with these scripts.
#
# This script is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# This copyright notice MUST APPEAR in all copies of the script!
#
##############################################################################
#
# define <name> statistics <regexp>
#
##############################################################################
package main;
use strict;
use warnings;
use Time::Local;
sub statistics_PeriodChange($);
sub statistics_DoStatisticsAll($$);
sub statistics_DoStatistics ($$$);
sub statistics_doStatisticMinMax ($$$$$);
sub statistics_doStatisticMinMaxSingle ($$$$$$);
sub statistics_doStatisticTendency ($$$);
sub statistics_doStatisticDelta ($$$$);
sub statistics_doStatisticDuration ($$$$);
sub statistics_doStatisticDurationSingle ($$$$$$);
sub statistics_storeSingularReadings ($$$$$$$$$$);
sub statistics_getStoredDevices($);
sub statistics_FormatDuration($);
sub statistics_maxDecPlaces($$);
sub statistics_UpdateDevReading($$$$);
# Modul Version for remote debugging
my $MODUL = "statistics";
##############################################################
# Syntax: readingName => statisticType
# statisticType: 0=noStatistic | 1=minMaxAvg(daily) | 2=delta | 3=stateDuration | 4=tendency | 5=minMaxAvg(hourly)
##############################################################
my %knownReadings = (
"ambientTemperature" => 5
,"brightness" => 5
,"count" => 2
,"counterHeatQHeating" =>2
,"counterHeatQHotWater" =>2
,"counterHeatQTotal" =>2
,"counterHours2ndHeatSource1" =>2
,"counterHours2ndHeatSource2" =>2
,"counterHours2ndHeatSource3" =>2
,"counterHoursHeatPump" =>2
,"counterHoursHeating" =>2
,"counterHoursHotWater" =>2
,"current" => 1
,"energy" => 2
,"energy_current" => 1
,"energy_total" => 2
,"energyCalc" => 2
,"heatSourceDefrostCounterAir" => 2
,"heatSourceDefrostCounterReverse" => 2
,"Total.Energy" => 2
,"humidity" => 1
,"lightsensor" => 3
,"lock" => 3
,"luminosity" => 1
,"motion" => 3
,"power" => 1
,"pressure" => 4
,"rain" => 2
,"rain_rate" => 1
,"rain_total" => 2
,"temperature" => 1
,"total" => 2
,"voltage" => 1
,"wind" => 5
,"wind_speed" => 5
,"windSpeed" => 5
,"Window" => 3
,"window" => 3
);
##############################################################
# Syntax: attributeName => statisticType
# statisticType: 0=noStatistic | 1=minMaxAvg(daily) | 2=delta | 3=stateDuration | 4=tendency | 5=minMaxAvg(hourly)
##############################################################
my %addedReadingsAttr = (
"deltaReadings" => 2
,"durationReadings" => 3
,"minAvgMaxReadings" => 5
,"tendencyReadings" => 4
);
##############################################################
##########################################
sub statistics_Log($$$)
{
my ( $hash, $loglevel, $text ) = @_;
my $xline = ( caller(0) )[2];
my $xsubroutine = ( caller(1) )[3];
my $sub = ( split( ':', $xsubroutine ) )[2];
$sub =~ s/statistics_//;
my $instName = ( ref($hash) eq "HASH" ) ? $hash->{NAME} : $hash;
Log3 $instName, $loglevel, "$MODUL $instName: $sub.$xline " . $text;
}
##########################################
sub statistics_Initialize($)
{
my ($hash) = @_;
$hash->{DefFn} = "statistics_Define";
$hash->{UndefFn} = "statistics_Undefine";
$hash->{NotifyFn} = "statistics_Notify";
$hash->{SetFn} = "statistics_Set";
$hash->{NotifyOrderPrefix} = "10-"; # Want to be called before the rest
$hash->{AttrList} = "disable:0,1 "
."dayChangeTime "
."deltaReadings "
."durationReadings "
."durationPeriodHour:0,1 "
."excludedReadings "
."ignoreDefaultAssignments:0,1 "
."minAvgMaxReadings "
."periodChangePreset "
."specialDeltaPeriodHours "
."specialDeltaPeriods "
."singularReadings:textField-long "
."tendencyReadings "
.$readingFnAttributes;
}
##########################
sub statistics_Define($$)
{
my ($hash, $def) = @_;
my @a = split("[ \t][ \t]*", $def);
return "Usage: define <name> statistics <devicename-regexp> [prefix]"
if(@a<3 || @a>4);
my $name = $a[0];
my $devName = $a[2];
if (@a == 4) {$hash->{PREFIX} = $a[3];}
else {$hash->{PREFIX} = "stat";}
eval { "Hallo" =~ m/^$devName$/ };
return "Bad regexp: $@" if($@);
$hash->{DEV_REGEXP} = $devName;
# Only global and the devices in devName should trigger the notify sub of statistics
$hash->{NOTIFYDEV} = "global,".$devName;
$hash->{STATE} = "Waiting for notifications";
$hash->{fhem}{modulVersion} = '$Date: 2022-06-16 07:45:59 +0200 (Thu, 16 Jun 2022) $';
RemoveInternalTimer($hash);
InternalTimer( gettimeofday() + 11, "statistics_PeriodChange", $hash, 0);
$hash->{fhem}{nextPeriodChangeTime} = gettimeofday() + 11;
return undef;
}
########################################
sub statistics_Undefine($$)
{
my ($hash, $arg) = @_;
RemoveInternalTimer($hash);
return undef;
}
########################################
sub statistics_Set($$@)
{
my ($hash, $name, $cmd, $val) = @_;
my $resultStr = "";
if ($cmd eq 'resetStatistics') {
if ($val ne "") {
Log3 $name, 3, "statistics: set $name $cmd $val";
my $regExp;
if ($val eq "all") { $regExp = ""; }
else { $regExp = $val.":.*"; }
foreach (sort keys %{ $hash->{READINGS} }) {
if ($_ =~ /^\.$regExp/ && $_ ne "state") {
delete $hash->{READINGS}{$_};
$resultStr .= "\n * " . substr $_, 1;
}
}
}
if ( $resultStr eq "" ) {
$resultStr = "$name: No statistics to reset";
} else {
$resultStr = "$name: Statistic value(s) reset:" . $resultStr;
readingsSingleUpdate($hash,"state","Statistic value(s) reset: $val",1);
}
# statistics_Log $hash, 3, $resultStr;
return $resultStr;
} elsif ($cmd eq 'doStatistics') {
Log3 $name, 3, "statistics: set $name $cmd";
statistics_DoStatisticsAll($hash,0);
return undef;
}
my $list = "resetStatistics:all" . statistics_getStoredDevices($hash);
$list .= " doStatistics:noArg";
return "Unknown argument $cmd, choose one of $list";
}
########################################
sub statistics_Notify($$)
{
my ($hash, $dev) = @_;
my $name = $hash->{NAME};
my $devName = $dev->{NAME};
# At startup: delete old Readings of monitored devices and rebuild from hidden readings
if ($devName eq "global" && grep (m/^INITIALIZED|REREADCFG$/,@{$dev->{CHANGED}})) {
foreach my $r (keys %{$hash->{READINGS}}) {
if ($r =~ /^monitoredDevices.*/) {
statistics_Log $hash,5,"Initialization - Delete old reading '$r'.";
delete($hash->{READINGS}{$r});
}
}
my %unknownDevices;
foreach my $r (keys %{$hash->{READINGS}}) {
if ($r =~ /^\.(.*):.*/) { $unknownDevices{$1}++; }
}
my $val="";
foreach my $device (sort (keys(%unknownDevices))) {
if (not exists ($defs{$device})) {
if ($val ne "") { $val.=","; }
$val .= $device;
}
}
if ($val ne "") {
statistics_Log $hash, 4, "Initialization - Found hidden readings for device(s) '$val'.";
readingsSingleUpdate($hash,"monitoredDevicesUnknown",$val,1);
}
return;
}
# Ignore my own notifications
if($devName eq $name) {
statistics_Log $hash, 5, "Notifications of myself received.";
return "" ;
}
# Return if the notifying device is not monitored
return "" if(!defined($hash->{DEV_REGEXP}));
my $regexp = $hash->{DEV_REGEXP};
if($devName !~ m/^($regexp)$/) {
statistics_Log $hash, 5, "Notification of '".$dev->{NAME}."' received. Device not monitored.";
return "" ;
}
# Check if it notifies only for the statistic values
my $prefix = $hash->{PREFIX};
my $normalReadingFound = 0;
my $max = int(@{$dev->{CHANGED}});
for (my $i = 0; $i < $max; $i++) {
my $s = $dev->{CHANGED}[$i];
next if(!defined($s));
if ($s !~ /^$prefix[A-Z]/) { $normalReadingFound = 1;}
}
if ($normalReadingFound==1) {
statistics_DoStatistics $hash, $dev, 0;
statistics_Log $hash, 5, "Notification of '".$dev->{NAME}."' received. Update statistics.";
} else {
statistics_Log $hash, 5, "Notification of '".$dev->{NAME}."' received but for my own readings only.";
}
return;
}
########################################
sub statistics_PeriodChange($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
my $dummy;
my $val;
my $curPeriodChangeTime = $hash->{fhem}{nextPeriodChangeTime};
$curPeriodChangeTime = gettimeofday() unless defined $curPeriodChangeTime;
my $periodChangePreset = AttrVal($name, "periodChangePreset", 5);
my $isDayChange = ( ReadingsVal($name, "nextPeriodChangeCalc", "") =~ /Day Change/ );
# Determine the next day change time
my @th=localtime();
my $now = gettimeofday();
my $dayChangeDelay = 0;
my $dayChangeTime = timelocal(0,0,0,$th[3],$th[4],$th[5]+1900);
if (AttrVal($name, "dayChangeTime", "00:00") =~ /(\d+):(\d+)/ && $1<24 && $1 >=0 && $2<60 && $2>=0) {
$dayChangeDelay = $1 * 3600 + $2 * 60;
if ($dayChangeDelay == 0) { $dayChangeTime += 24*3600; } # Otherwise it would always lay in the past
$dayChangeTime += $dayChangeDelay - $periodChangePreset;
}
my $dstcorr = HOURSECONDS * ((localtime($now - DAYSECONDS))[8] - $th[8]);
$dayChangeTime += $dstcorr;
RemoveInternalTimer($hash);
# Run period change procedure each full hour ("periodChangePreset" second before).
my $periodEndTime = 3600 * ( int(($now+$periodChangePreset)/3600) + 1 ) - $periodChangePreset ;
# Run procedure also for given dayChangeTime
$val = "";
if ( $now<$dayChangeTime && $dayChangeTime<=$periodEndTime ) {
$periodEndTime = $dayChangeTime;
$val = " (Day Change)";
}
$val = strftime ("%Y-%m-%d %H:%M:%S", localtime($periodEndTime)) . $val;
InternalTimer( $periodEndTime, "statistics_PeriodChange", $hash, 1);
readingsSingleUpdate($hash, "nextPeriodChangeCalc", $val, 0);
$hash->{fhem}{nextPeriodChangeTime} = $periodEndTime;
statistics_Log $hash, 4, "Next period change will be calculated at $val";
return if( AttrVal($name, "disable", 0 ) == 1 );
# Determine if time period switched (day, month, year)
my $periodSwitch = 0;
my $yearLast;
my $monthLast;
my $dayLast;
my $hourLast;
my $hourNow;
my $dayNow;
my $monthNow;
my $yearNow;
if ($isDayChange) {
statistics_Log $hash, 4, "Calculating day change";
# get time values for 50 seconds before a new day
($dummy, $dummy, $hourLast, $dayLast, $monthLast, $yearLast) = localtime ($curPeriodChangeTime - $dayChangeDelay + $periodChangePreset - 59);
# get time values for next day
($dummy, $dummy, $hourNow, $dayNow, $monthNow, $yearNow) = localtime ($now + $periodChangePreset);
$periodSwitch = -2;
if ($yearNow != $yearLast) { $periodSwitch = -4; }
elsif ($monthNow != $monthLast) { $periodSwitch = -3; }
# Positiv Value if periode changes at full hour
$periodSwitch = abs($periodSwitch) if $dayChangeDelay % 3600 == 0;
} else {
($dummy, $dummy, $hourLast, $dummy, $dummy) = localtime($now);
($dummy, $dummy, $hourNow , $dummy, $dummy) = localtime($now + $periodChangePreset);
if ( $hourNow != $hourLast
|| $hourNow == $hourLast && $th[8] != (localtime($now - $dstcorr + $periodChangePreset))[8]) {
$periodSwitch = 1;
statistics_Log $hash,4,"Calculating hour change";
} else {
statistics_Log $hash,4,"Calculating statistics at startup";
}
}
statistics_DoStatisticsAll $hash, $periodSwitch;
return undef;
}
##########################
# Take each notified reading and perform the calculation
sub statistics_DoStatisticsAll($$)
{
my ($hash,$periodSwitch) = @_;
my $name = $hash->{NAME};
return "" if(!defined($hash->{DEV_REGEXP}));
my $regexp = $hash->{DEV_REGEXP};
foreach my $devName (sort keys %defs) {
if ($devName ne $name && $devName =~ m/^($regexp)$/) {
statistics_Log $hash,4,"Doing statistics (period $periodSwitch) for device '$devName'";
statistics_DoStatistics($hash, $defs{$devName}, $periodSwitch);
}
}
# To avoid data loose, store all readings once a day in the state file
if ($periodSwitch < -1 || $periodSwitch > 1 ) { WriteStatefile(); }
}
##########################
sub statistics_DoStatistics($$$)
{
my ($hash, $dev, $periodSwitch) = @_;
my $hashName = $hash->{NAME};
my $devName = $dev->{NAME};
my $devType = $dev->{TYPE};
my $statisticDone = 0;
my %statReadings = ();
return if( AttrVal($hashName, "disable", 0 ) == 1 );
my $ignoreDefAssign = AttrVal($hashName, "ignoreDefaultAssignments", 0);
my $exclReadings = AttrVal($hashName, "excludedReadings", "");
my $regExp = '^'.$devName.'$|^'.$devName.',|,'.$devName.'$|,'.$devName.',';
# Return if the notifying device is already served by another statistics instance with same prefix
my $instanceMarker = "_98_statistics_".$hash->{PREFIX};
if (exists ($dev->{helper}{$instanceMarker})) {
my $servedBy = $dev->{helper}{$instanceMarker};
if ($servedBy ne $hashName) {
my $monReadingValue = ReadingsVal($hashName,"monitoredDevicesUnserved","");
if ($monReadingValue !~ /$regExp/) {
if($monReadingValue eq "") { $monReadingValue = $devName;}
else {$monReadingValue .= ",".$devName;}
readingsSingleUpdate($hash,"monitoredDevicesUnserved",$monReadingValue,1);
statistics_Log $hash, 3, "Device '$devName' identified as supported but already servered by '$servedBy' with some reading prefix.";
}
return;
}
} else {
$dev->{helper}{_98_statistics}=$hashName;
}
# Build up Statistic-Reading-Hash, add readings defined in attributes to Statistic-Reading-Hash
%statReadings = %knownReadings
unless $ignoreDefAssign == 1;
while (my ($aName, $statType) = each (%addedReadingsAttr) )
{
my @addedReadings = split /,/, AttrVal($hashName, $aName, "");
foreach( @addedReadings )
{
statistics_Log $hash, 5, "Assigned reading '$_' from attribute '$aName' to statistic type $statType.";
$statReadings{$_} = $statType;
}
}
readingsBeginUpdate($dev);
# Loop through Statistic-Reading-Hash and start statistic calculation if the readings exists in the notifying device
while ( my ($rName, $statType) = each (%statReadings) )
{
# notifing device has known reading, no statistic for excluded readings
my $completeReadingName = $devName.":".$rName;
next if ($completeReadingName =~ m/^($exclReadings)$/ );
next if not exists ($dev->{READINGS}{$rName});
if ($statType == 1) { statistics_doStatisticMinMax ( $hash, $dev, $rName, $periodSwitch, 0 );}
elsif ($statType == 2) { statistics_doStatisticDelta ( $hash, $dev, $rName, $periodSwitch );}
elsif ($statType == 3) { statistics_doStatisticDuration ( $hash, $dev, $rName, $periodSwitch ); }
elsif ($statType == 4 && $periodSwitch>=1) { statistics_doStatisticTendency ( $hash, $dev, $rName );}
elsif ($statType == 5) { statistics_doStatisticMinMax ( $hash, $dev, $rName, $periodSwitch, 1 );}
$statisticDone = 1;
}
# If no statistic-reading has been found, do a duration stat for the device-state
if ($statisticDone != 1 && $ignoreDefAssign != 1)
{
if ( exists ($dev->{READINGS}{state}) && $dev->{READINGS}{state}{VAL} ne "defined" ) {
statistics_doStatisticDuration $hash, $dev, "state", $periodSwitch;
$statisticDone = 1;
}
}
if ($periodSwitch >0) {readingsEndUpdate($dev,1);}
else {readingsEndUpdate($dev,0);}
# Record device as monitored
my $monReadingName;
if ($statisticDone == 1) {
$monReadingName = "monitoredDevices".$devType;
readingsSingleUpdate($hash,"state","Updated stats for: $devName",1);
} else {
$monReadingName = "monitoredDevicesUnsupported";
$devName .= "#$devType";
$regExp = '^'.$devName.'$|^'.$devName.',|,'.$devName.'$|,'.$devName.',';
}
my $monReadingValue = ReadingsVal($hashName,$monReadingName,"");
if ($monReadingValue !~ /$regExp/) {
if($monReadingValue eq "") { $monReadingValue = $devName;}
else {$monReadingValue .= ",".$devName;}
readingsSingleUpdate($hash,$monReadingName,$monReadingValue,1);
my $monReadingValue = ReadingsVal($hashName,"monitoredDevicesUnknownType","");
if ($monReadingValue =~ /$regExp/) {
$monReadingValue =~ s/$devName,?//;
$monReadingValue =~ s/,$//;
if ($monReadingValue ne "") {
readingsSingleUpdate($hash,"monitoredDevicesUnknownType",$monReadingValue,1);
} else {
delete $hash->{READINGS}{monitoredDevicesUnknownType};
}
}
}
return undef;
}
# Calculates Min/Average/Max Values
########################################
sub statistics_doStatisticMinMax ($$$$$)
{
my ($hash, $dev, $readingName, $periodSwitch, $doHourly) = @_;
my $name = $hash->{NAME};
my $devName = $dev->{NAME};
return if not exists ($dev->{READINGS}{$readingName});
# Get reading, cut out first number without units
my $value = $dev->{READINGS}{$readingName}{VAL};
$value =~ s/\s*(-?[\d.]*).*/$1/e;
statistics_Log $hash, 4, "Calculating min/avg/max statistics for '".$dev->{NAME}.":$readingName = $value'";
# statistics_doStatisticMinMaxSingle: $hash, $readingName, $value, $saveLast
# Hourly statistic (if needed)
if ($doHourly) { statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Hour", $value, ($periodSwitch != 0); }
# Daily statistic
statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Day", $value, ( $periodSwitch >= 2 || $periodSwitch <= -2 );
# Monthly statistic
statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Month", $value, ( $periodSwitch >= 3 || $periodSwitch <= -3 );
# Yearly statistic
statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Year", $value, ( $periodSwitch == 4 || $periodSwitch == -4 );
return ;
}
# Calculates single MaxMin Values and informs about end of day and month
########################################
sub statistics_doStatisticMinMaxSingle ($$$$$$)
{
my ($hash, $dev, $readingName, $period, $value, $saveLast) = @_;
my $result;
my $hiddenReadingName = ".".$dev->{NAME}.":".$readingName.$period;
my $name=$hash->{NAME};
my $devName = $dev->{NAME};
my $statReadingName = $hash->{PREFIX};
$statReadingName .= ucfirst($readingName).$period;
my @hidden;
my @stat;
my $lastValue;
my $firstRun = not exists($hash->{READINGS}{$hiddenReadingName});
if ( $firstRun ) {
# Show since-Value
$hidden[1] = 0; $hidden[3] = 0; $hidden[9] = 1;
$stat[1] = $value; $stat[3] = $value; $stat[5] = $value;
$stat[7] = strftime ("%Y-%m-%d_%H:%M:%S",localtime() );
}
else {
# Do calculations if hidden reading exists
@hidden = split / /, $hash->{READINGS}{$hiddenReadingName}{VAL}; # Internal values
@stat = split / /, $dev->{READINGS}{$statReadingName}{VAL};
my $timeDiff = int(gettimeofday())-$hidden[7];
$hidden[1] += $hidden[5] * $timeDiff; # sum
$hidden[3] += $timeDiff; # time
if ($value < $stat[1]) { $stat[1]=$value; } # Min
if ($hidden[3]>0) {$stat[3] = $hidden[1] / $hidden[3];} # Avg
if ($value > $stat[5]) { $stat[5]=$value; } # Max
}
my $decPlaces = statistics_maxDecPlaces($value, $hidden[11]);
# Prepare new current reading
$result = sprintf( "Min: %.".$decPlaces."f Avg: %.".$decPlaces."f Max: %.".$decPlaces."f", $stat[1], $stat[3], $stat[5]);
if ($hidden[9] == 1) { $result .= " (since: $stat[7] )"; }
# Store current reading as last reading, Reset current reading
if ($saveLast) {
readingsBulkUpdate($dev, $statReadingName . "Last", $result, 1);
statistics_Log $hash, 4, "Set '".$statReadingName . "Last'='$result'";
$hidden[1] = 0; $hidden[3] = 0; $hidden[9] = 0; # No since value anymore
$result = "Min: $value Avg: $value Max: $value";
}
# Store current reading
readingsBulkUpdate($dev, $statReadingName, $result, 0);
statistics_Log $hash, 5, "Set '$statReadingName'='$result'";
# Store single readings
my $singularReadings = AttrVal($name, "singularReadings", "");
$singularReadings=~s/\n|\r//g;
if ($singularReadings ne "") {
# statistics_storeSingularReadings $hashName,$singularReadings,$dev,$statReadingName,$readingName,$statType,$period,$statValue,$lastValue,$saveLast
my $statValue = sprintf "%.".$decPlaces."f", $stat[1];
if ($saveLast) { $lastValue = $statValue; $statValue = $value; }
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Min",$period,$statValue,$lastValue,$saveLast);
$statValue = sprintf "%.".$decPlaces."f", $stat[3];
if ($saveLast) { $lastValue = $statValue; $statValue = $value; }
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Avg",$period,$statValue,$lastValue,$saveLast);
$statValue = sprintf "%.".$decPlaces."f", $stat[5];
if ($saveLast) { $lastValue = $statValue; $statValue = $value; }
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Max",$period,$statValue,$lastValue,$saveLast);
}
# Store hidden reading
$result = "Sum: $hidden[1] Time: $hidden[3] LastValue: ".$value." LastTime: ".int(gettimeofday())." ShowDate: $hidden[9] DecPlaces: $decPlaces";
readingsSingleUpdate($hash, $hiddenReadingName, $result, 0);
statistics_Log $hash, 5, "Set '$hiddenReadingName'='$result'";
return;
}
# Calculates tendency values
########################################
sub statistics_doStatisticTendency ($$$)
{
my ($hash, $dev, $readingName) = @_;
my $name = $hash->{NAME};
my $devName = $dev->{NAME};
my $decPlaces = 0;
return if not exists ($dev->{READINGS}{$readingName});
# Get reading, cut out first number without units
my $value = $dev->{READINGS}{$readingName}{VAL};
$value =~ s/\s*(-?[\d.]*).*/$1/e;
statistics_Log $hash, 4, "Calculating hourly tendency statistics for '".$dev->{NAME}.":$readingName = $value'";
my $statReadingName = $hash->{PREFIX} . ucfirst($readingName) . "Tendency";
my $hiddenReadingName = ".".$dev->{NAME}.":".$readingName."Tendency";
my @hidden; my @stat;
my $firstRun = not exists($hash->{READINGS}{$hiddenReadingName});
if ( $firstRun ) {
@stat = split / /, "1h: - 2h: - 3h: - 6h: -";
statistics_Log $hash,4,"Initializing statistic of '$hiddenReadingName'.";
$hash->{READINGS}{$hiddenReadingName}{VAL} = "";
}
else {
@stat = split / /, $dev->{READINGS}{$statReadingName}{VAL};
}
statistics_Log $hash, 4, "Add $value to $hiddenReadingName";
my $result = $value;
if (exists ($hash->{READINGS}{$hiddenReadingName}{VAL})) { $result .= " " . $hash->{READINGS}{$hiddenReadingName}{VAL}; }
@hidden = split / /, $result; # Internal values
# determine decPlaces with stored values
foreach (@hidden) {
$decPlaces = statistics_maxDecPlaces($_, $decPlaces);
}
if ( exists($hidden[7]) ) {
statistics_Log $hash, 4, "Remove last value ".$hidden[7]." from '$hiddenReadingName'";
delete $hidden[7];
}
if ( exists($hidden[1]) ) {$stat[1] = sprintf "%+.".$decPlaces."f", $value-$hidden[1];}
if ( exists($hidden[2]) ) {$stat[3] = sprintf "%+.".$decPlaces."f", $value-$hidden[2];}
if ( exists($hidden[3]) ) {$stat[5] = sprintf "%+.".$decPlaces."f", $value-$hidden[3];}
if ( exists($hidden[6]) ) {$stat[7] = sprintf "%+.".$decPlaces."f", $value-$hidden[6];}
$result = "1h: " . $stat[1] ." 2h: ". $stat[3] ." 3h: ". $stat[5] ." 6h: ". $stat[7];
readingsBulkUpdate($dev, $statReadingName, $result, 1);
# Store single readings
my $singularReadings = AttrVal($name, "singularReadings", "");
$singularReadings=~s/\n|\r//g;
if ($singularReadings ne "") {
# statistics_storeSingularReadings $hashName,$singularReadings,$dev,$statReadingName,$readingName,$statType,$period,$statValue,$lastValue,$saveLast
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Tendency","1h",$stat[1],0,0);
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Tendency","2h",$stat[3],0,0);
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Tendency","3h",$stat[5],0,0);
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Tendency","6h",$stat[7],0,0);
}
$result = join( " ", @hidden );
readingsSingleUpdate($hash, $hiddenReadingName, $result, 0);
statistics_Log $hash, 4, "Set '$hiddenReadingName = $result'";
return ;
}
# Calculates deltas for day, month and year
########################################
sub statistics_doStatisticDelta ($$$$)
{
my ($hash, $dev, $readingName, $periodSwitch) = @_;
my $dummy;
my $result;
my $showDate;
my $name = $hash->{NAME};
my $decPlaces = 0;
return if not exists ($dev->{READINGS}{$readingName});
# Get reading, extract first number without units
my $value = $dev->{READINGS}{$readingName}{VAL};
$value =~ s/\s*(-?[\d.]*).*/$1/e;
statistics_Log $hash, 4, "Calculating delta statistics for '".$dev->{NAME}.":$readingName = $value'";
my $hiddenReadingName = ".".$dev->{NAME}.":".$readingName;
my $statReadingName = $hash->{PREFIX};
$statReadingName .= ucfirst($readingName);
my @hidden; my @stat; my @last;
my $firstRun = not exists($hash->{READINGS}{$hiddenReadingName});
# Show since-Value and initialize all readings
if ( $firstRun ) {
$showDate = 8;
@stat = split / /, "Hour: 0 Day: 0 Month: 0 Year: 0";
$stat[9] = strftime "%Y-%m-%d_%H:%M:%S", localtime();
@last = split / /, "Hour: - Day: - Month: - Year: -";
statistics_Log $hash, 4, "Initializing statistic of '$hiddenReadingName'.";
}
# Do calculations if hidden reading exists
else {
@stat = split / /, $dev->{READINGS}{$statReadingName}{VAL};
@hidden = split / /, $hash->{READINGS}{$hiddenReadingName}{VAL}; # Internal values
$showDate = $hidden[3];
$decPlaces = statistics_maxDecPlaces($value, $hidden[5]);
if (exists ($dev->{READINGS}{$statReadingName."Last"})) {
@last = split / /, $dev->{READINGS}{$statReadingName."Last"}{VAL};
}
else {
@last = split / /, "Hour: - Day: - Month: - Year: -";
}
my $deltaValue = $value - $hidden[1];
# Do statistic
$stat[1] += $deltaValue;
$stat[3] += $deltaValue;
$stat[5] += $deltaValue;
$stat[7] += $deltaValue;
if ($periodSwitch>=1) { statistics_doStatisticSpecialPeriod ( $hash, $dev, $readingName, $decPlaces, $stat[1] ); }
# Determine if "since" value has to be shown in current and last reading
# If change of year, change yearly statistic
if ($periodSwitch == 4 || $periodSwitch == -4) {
$last[7] = sprintf "%.".$decPlaces."f", $stat[7];
$stat[7] = 0;
if ($showDate == 1) { $showDate = 0; } # Do not show the "since:" value for year changes anymore
if ($showDate >= 2) { $showDate = 1; $last[9] = $stat[9]; } # Shows the "since:" value for the first year change
statistics_Log $hash, 4, "Shifting current year in last value of '$statReadingName'.";
}
# If change of month, change monthly statistic and check for special periods
if ($periodSwitch >= 3 || $periodSwitch <= -3){
statistics_doStatisticSpecialPeriod2 ($hash, $dev, $readingName, "Month", $decPlaces, $stat[5]);
$last[5] = sprintf "%.".$decPlaces."f", $stat[5];
$stat[5] = 0;
if ($showDate == 3) { $showDate = 2; } # Do not show the "since:" value for month changes anymore
if ($showDate >= 4) { $showDate = 3; $last[9] = $stat[9]; } # Shows the "since:" value for the first month change
statistics_Log $hash, 4, "Shifting current month in last value of '$statReadingName'.";
}
# If change of day, change daily statistic and check for special periods
if ($periodSwitch >= 2 || $periodSwitch <= -2){
statistics_doStatisticSpecialPeriod2 ($hash, $dev, $readingName, "Day", $decPlaces, $stat[3]);
$last[3] = sprintf "%.".$decPlaces."f", $stat[3];
$stat[3] = 0;
if ($showDate == 5) { $showDate = 4; } # Do not show the "since:" value for day changes anymore
if ($showDate >= 6) { # Shows the "since:" value for the first day change
$showDate = 5;
$last[9] = $stat[9];
# Next monthly and yearly values start normaly at 00:00 and show only date (no time)
if (AttrVal($name, "dayChangeTime", "00:00") =~ /00:00|0:00/) {
my $periodChangePreset = AttrVal($name, "periodChangePreset", 5);
$stat[5] = 0;
$stat[7] = 0;
$stat[9] = strftime "%Y-%m-%d", localtime(gettimeofday()+$periodChangePreset); # start
}
}
statistics_Log $hash,4,"Shifting current day in last value of '$statReadingName'.";
}
# If change of hour, change hourly statistic and check for special periods
if ($periodSwitch >= 1){
statistics_doStatisticSpecialPeriod2 ($hash, $dev, $readingName, "Hour", $decPlaces, $stat[1]);
$last[1] = sprintf "%.".$decPlaces."f", $stat[1];
$stat[1] = 0;
if ($showDate == 7) { $showDate = 6; } # Do not show the "since:" value for day changes anymore
if ($showDate >= 8) { $showDate = 7; $last[9] = $stat[9]; } # Shows the "since:" value for the first hour change
statistics_Log $hash, 4, "Shifting current hour in last value of '$statReadingName'.";
}
}
# Store hidden reading
$result = "LastValue: $value ShowDate: $showDate DecPlaces: $decPlaces";
readingsSingleUpdate($hash, $hiddenReadingName, $result, 0);
statistics_Log $hash, 5, "Set '$hiddenReadingName'='$result'";
# Store visible statistic readings (delta values)
$result = sprintf "Hour: %.".$decPlaces."f Day: %.".$decPlaces."f Month: %.".$decPlaces."f Year: %.".$decPlaces."f", $stat[1], $stat[3], $stat[5], $stat[7];
if ( $showDate >=2 ) { $result .= " (since: $stat[9] )"; }
readingsBulkUpdate($dev,$statReadingName,$result, 1);
statistics_Log $hash, 5, "Set '$statReadingName'='$result'";
# if changed, store previous visible statistic (delta) values
if ($periodSwitch != 0) {
$result = "Hour: $last[1] Day: $last[3] Month: $last[5] Year: $last[7]";
if ( $showDate =~ /1|3|5|7/ ) { $result .= " (since: $last[9] )"; }
readingsBulkUpdate($dev,$statReadingName."Last",$result, 1);
statistics_Log $hash, 4, "Set '".$statReadingName."Last'='$result'";
}
# Store single readings
my $singularReadings = AttrVal($name, "singularReadings", "");
$singularReadings=~s/\n|\r//g;
if ($singularReadings ne "") {
# statistics_storeSingularReadings $hashName,$singularReadings,$dev,$statReadingName,$readingName,$statType,$period,$statValue,$lastValue,$saveLast
my $statValue = sprintf "%.".$decPlaces."f", $stat[1];
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName, $readingName, "Delta", "Hour", $statValue, $last[1], $periodSwitch >= 1);
$statValue = sprintf "%.".$decPlaces."f", $stat[3];
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName, $readingName, "Delta", "Day", $statValue, $last[3], $periodSwitch >= 2 || $periodSwitch <= -2);
$statValue = sprintf "%.".$decPlaces."f", $stat[5];
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName, $readingName, "Delta", "Month", $statValue, $last[5], $periodSwitch >= 3 || $periodSwitch <= -3);
$statValue = sprintf "%.".$decPlaces."f", $stat[7];
statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName, $readingName, "Delta", "Year", $statValue, $last[7], $periodSwitch == 4 || $periodSwitch == -4);
}
return ;
}
# Calculates deltas for period of several hours
########################################
sub statistics_doStatisticSpecialPeriod ($$$$$)
{
my ($hash, $dev, $readingName, $decPlaces, $value) = @_;
my $name = $hash->{NAME};
my $specialPeriod = AttrVal($name, "specialDeltaPeriodHours", 0);
return if $specialPeriod == 0;
my $statReadingName = $hash->{PREFIX} . ucfirst($readingName) . "SpecialPeriod";
my $hiddenReadingName = ".".$dev->{NAME} . ":" . $readingName . "SpecialPeriod";
# Update hidden stack
my @hidden = ();
if (exists ($hash->{READINGS}{$hiddenReadingName}{VAL}))
{ @hidden = split / /, $hash->{READINGS}{$hiddenReadingName}{VAL}; }
unshift @hidden, $value;
statistics_Log $hash, 4, "Add $value to $hiddenReadingName";
while ( $#hidden >= $specialPeriod ) {
my $lastValue = pop @hidden;
statistics_Log $hash, 4, "Remove last (".$#hidden.") value '$lastValue' from '$hiddenReadingName'";
}
# Calculate specialPeriodValue
my $result = 0;
foreach (@hidden) { $result += $_; }
$result = sprintf "%.".$decPlaces."f", $result;
$result .= " (".($#hidden+1).".hours)" if $#hidden != $specialPeriod-1;
statistics_Log $hash, 4, "Set '$statReadingName = $result'";
readingsBulkUpdate($dev, $statReadingName, $result, 1);
# Store hidden stack
$result = join( " ", @hidden );
readingsSingleUpdate($hash, $hiddenReadingName, $result, 0);
statistics_Log $hash, 4, "Set '$hiddenReadingName = $result'";
}
# Calculates deltas for period of several hours
########################################
sub statistics_doStatisticSpecialPeriod2 ($$$$$$)
{
my ($hash, $dev, $readingName, $periodText, $decPlaces, $value) = @_;
my $name = $hash->{NAME};
my $pattern;
my $specialDeltaPeriods = AttrVal($name, "specialDeltaPeriods", "");
return unless $specialDeltaPeriods;
#Check if reading occures in attribute specialDeltaPeriods, extract period numbers
my $devName = $dev->{NAME};
$pattern = $devName . ":" . $readingName . ":" . $periodText . ':([\d:]+)';
return unless $specialDeltaPeriods =~ $pattern;
#Determine number of periods and maximal number
my @periods = split /:/, $1;
my $maxNumber=0;
@periods = sort { $a <=> $b } @periods;
$maxNumber = $periods[$#periods];
#Determine reading names
my $statReadingName = $hash->{PREFIX} . ucfirst($readingName) . ucfirst($periodText);
my $hiddenReadingName = ".".$devName . ":" . $readingName . $periodText;
# Update hidden stack
my @hidden = ();
if (exists ($hash->{READINGS}{$hiddenReadingName}{VAL}))
{ @hidden = split / /, $hash->{READINGS}{$hiddenReadingName}{VAL}; }
unshift @hidden, $value;
statistics_Log $hash, 4, "Add $value to $hiddenReadingName";
while ( $#hidden > $maxNumber ) {
my $lastValue = pop @hidden;
statistics_Log $hash, 4, "Remove last value '$lastValue' from '$hiddenReadingName'";
}
#Calculate and write specialPeriodValues
my $result = 0;
my $counterHidden = 0;
my $counterPeriods = 0;
foreach (@hidden) {
$result += $_;
$counterHidden++;
if ( $counterHidden == $periods[$counterPeriods] ) {
my $rName = $statReadingName . $periods[$counterPeriods];
my $rValue = sprintf "%.".$decPlaces."f", $result;
statistics_Log $hash, 4, "Set '$rName = $rValue'";
readingsBulkUpdate($dev, $rName, $rValue, 1);
$counterPeriods++;
}
}
#write specialPeriodValues for periods not reached yet
for (my $i = $counterPeriods; $i <= $#periods; $i++) {
my $rName = $statReadingName . $periods[$i];
my $rValue = sprintf "%.".$decPlaces."f (%d %s)", $result, $#hidden+1, $periodText;
statistics_Log $hash, 4, "Set '$rName = $rValue'";
readingsBulkUpdate($dev, $rName, $rValue, 1);
}
# Store hidden stack
$result = join( " ", @hidden );
readingsSingleUpdate($hash, $hiddenReadingName, $result, 0);
statistics_Log $hash, 4, "Set '$hiddenReadingName = $result'";
}
# Calculates single Duration Values and informs about end of day and month
########################################
sub statistics_doStatisticDuration ($$$$)
{
my ($hash, $dev, $readingName, $periodSwitch) = @_;
my $name = $hash->{NAME};
my $devName = $dev->{NAME};
return if not exists ($dev->{READINGS}{$readingName});
# Get reading
my $state = $dev->{READINGS}{$readingName}{VAL};
$state = "(null)" if $state eq "";
statistics_Log $hash, 4, "Calculating duration statistics for '".$dev->{NAME}.":$readingName = $state'";
# Daily Statistic
statistics_doStatisticDurationSingle $hash, $dev, $readingName, "Hour", $state, ($periodSwitch !=0)
if AttrVal($name, "durationPeriodHour", 0) == 1;
# Daily Statistic
statistics_doStatisticDurationSingle $hash, $dev, $readingName, "Day", $state, ($periodSwitch >= 2 || $periodSwitch <= -2);
# Monthly Statistic
statistics_doStatisticDurationSingle $hash, $dev, $readingName, "Month", $state, ($periodSwitch >= 3 || $periodSwitch <= -3);
# Yearly Statistic
statistics_doStatisticDurationSingle $hash, $dev, $readingName, "Year", $state, ($periodSwitch == 4 || $periodSwitch == -4);
return ;
}
# Calculates single duration values
########################################
sub statistics_doStatisticDurationSingle ($$$$$$)
{
my ($hash, $dev, $readingName, $period, $state, $saveLast) = @_;
my $result;
my $hiddenReadingName = ".".$dev->{NAME}.":".$readingName.$period;
my $name=$hash->{NAME};
my $devName = $dev->{NAME};
$state =~ s/ /_/g;
$state = "on" if $state =~ /set_on/;
$state = "off" if $state =~ /set_off/;
my $statReadingName = $hash->{PREFIX};
$statReadingName .= ucfirst($readingName).$period;
my %hidden;
my %stat;
my $firstRun = not exists($hash->{READINGS}{$hiddenReadingName});
my $lastState;
# Show since-Value
if ( $firstRun ) {
$hidden{"showDate:"} = 1;
$saveLast = 0;
$lastState = $state;
$hidden{"(since:"} = strftime ("%Y-%m-%d_%H:%M:%S)",localtime() );
$hidden{$state.":"} = 0;
$hidden{$state."_Count:"} = 1;