############################################## # $Id$ # # 98_statistic.pm # # (c) 2014 Torsten Poitzsch < torsten . poitzsch at gmx . de > # # 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 statistics # ############################################################################## 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: deviceType, readingName, statisticType, decimalPlaces # statisticType: 0=noStatistic | 1=minMaxAvg(daily) | 2=delta | 3=stateDuration | 4=tendency | 5=minMaxAvg(hourly) ############################################################## my @knownReadings = ( ["brightness", 1, 0] ,["count", 2] ,["current", 1, 3] ,["energy", 2] ,["energy_current", 1, 1] ,["energy_total", 2] ,["Total.Energy", 2] ,["humidity", 1, 0] ,["lightsensor", 3] ,["lock", 3] ,["motion", 3] ,["power", 1, 1] ,["pressure", 4, 1] ,["rain", 2] ,["rain_rate", 1, 1] ,["rain_total", 2] ,["temperature", 1, 1] ,["total", 2] ,["voltage", 1, 1] ,["wind", 5, 0] ,["wind_speed", 5, 1] ,["windSpeed", 5, 0] ,["Window", 3] ,["window", 3] ); ############################################################## 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->{NOTIFYDEV} = "global"; $hash->{SetFn} = "statistics_Set"; $hash->{NotifyOrderPrefix} = "10-"; # Want to be called before the rest $hash->{AttrList} = "disable:0,1 " ."dayChangeTime " ."deltaReadings " ."durationReadings " ."excludedReadings " ."minAvgMaxReadings " ."periodChangePreset " ."specialDeltaPeriodHours " ."singularReadings " ."tendencyReadings " .$readingFnAttributes; } ########################## sub statistics_Define($$) { my ($hash, $def) = @_; my @a = split("[ \t][ \t]*", $def); return "Usage: define statistics [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; $hash->{STATE} = "Waiting for notifications"; $hash->{fhem}{modulVersion} = '$Date$'; RemoveInternalTimer($hash); InternalTimer( gettimeofday() + 11, "statistics_PeriodChange", $hash, 0); 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 "") { 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') { 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 $periodChangePreset = AttrVal($name, "periodChangePreset", 5); my $isDayChange = ( ReadingsVal($name, "nextPeriodChangeCalc", "") =~ /Day Change/ ); # Determine the next day change time my @th=localtime(); 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; } RemoveInternalTimer($hash); # Run period change procedure each full hour ("periodChangePreset" second before). my $periodEndTime = 3600 * ( int((gettimeofday()+$periodChangePreset)/3600) + 1 ) - $periodChangePreset ; # Run procedure also for given dayChangeTime $val = ""; if ( gettimeofday()<$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); 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"; ($dummy, $dummy, $hourLast, $dayLast, $monthLast, $yearLast) = localtime (gettimeofday() - $dayChangeDelay + $periodChangePreset - 59); ($dummy, $dummy, $hourNow, $dayNow, $monthNow, $yearNow) = localtime (gettimeofday() + $periodChangePreset); if ($yearNow != $yearLast) { $periodSwitch = -4; } elsif ($monthNow != $monthLast) { $periodSwitch = -3; } elsif ($dayNow != $dayLast) { $periodSwitch = -2; } if ($dayChangeDelay % 3600 == 0) { $periodSwitch = abs($periodSwitch); } } else { ($dummy, $dummy, $hourLast, $dummy, $dummy, $dummy) = localtime (gettimeofday()); ($dummy, $dummy, $hourNow, $dummy, $dummy, $dummy) = localtime (gettimeofday() + $periodChangePreset); if ($hourNow != $hourLast) { $periodSwitch = 1; statistics_Log $hash,4,"Calculating hour change"; } else { statistics_Log $hash,4,"Calculating statistics at startup"; } } statistics_DoStatisticsAll $hash, $periodSwitch; return undef; } ########################## 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 (type $periodSwitch) for device '$devName'"; statistics_DoStatistics($hash, $defs{$devName}, $periodSwitch); } } if ($periodSwitch != 0 ) { WriteStatefile(); } } ########################## sub statistics_DoStatistics($$$) { my ($hash, $dev, $periodSwitch) = @_; my $hashName = $hash->{NAME}; my $devName = $dev->{NAME}; my $devType = $dev->{TYPE}; my $statisticDone = 0; return if( AttrVal($hashName, "disable", 0 ) == 1 ); my $readingName; my $exclReadings = AttrVal($hashName, "excludedReadings", ""); my $regExp = '^'.$devName.'$|^'.$devName.',|,'.$devName.'$|,'.$devName.','; # Return if the notifying device is already served by another statistics instance if (exists ($dev->{helper}{_98_statistics})) { my $servedBy = $dev->{helper}{_98_statistics}; 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'."; } return; } } else { $dev->{helper}{_98_statistics}=$hashName; } readingsBeginUpdate($dev); # Loop through all known readings foreach my $f (@knownReadings) { # notifing device has known reading, no statistic for excluded readings $readingName = $$f[0]; my $completeReadingName = $devName.":".$readingName; next if ($completeReadingName =~ m/^($exclReadings)$/ ); next if not exists ($dev->{READINGS}{$readingName}); $statisticDone = 1; if ($$f[1] == 1) { statistics_doStatisticMinMax ($hash, $dev, $readingName, $$f[2], $periodSwitch, 0);} if ($$f[1] == 2) { statistics_doStatisticDelta ($hash, $dev, $readingName, $periodSwitch );} if ($$f[1] == 3) { statistics_doStatisticDuration ($hash, $dev, $readingName, $periodSwitch ); } if ($$f[1] == 4 && $periodSwitch>=1) { statistics_doStatisticTendency ($hash, $dev, $readingName, $$f[2]);} if ($$f[1] == 5) { statistics_doStatisticMinMax ($hash, $dev, $readingName, $$f[2], $periodSwitch, 1);} } my @specialReadings = split /,/, AttrVal($hashName, "deltaReadings", ""); foreach $readingName (@specialReadings) { my $completeReadingName = $devName.":".$readingName; next if ($completeReadingName =~ m/^($exclReadings)$/ ); next if not exists ($dev->{READINGS}{$readingName}); $statisticDone = 1; statistics_doStatisticDelta ($hash, $dev, $readingName, $periodSwitch); } @specialReadings = split /,/, AttrVal($hashName, "durationReadings", ""); foreach $readingName (@specialReadings) { my $completeReadingName = $devName.":".$readingName; next if ($completeReadingName =~ m/^($exclReadings)$/ ); next if not exists ($dev->{READINGS}{$readingName}); $statisticDone = 1; statistics_doStatisticDuration ($hash, $dev, $readingName, $periodSwitch); } @specialReadings = split /,/, AttrVal($hashName, "minAvgMaxReadings", ""); foreach $readingName (@specialReadings) { my $completeReadingName = $devName.":".$readingName; next if ($completeReadingName =~ m/^($exclReadings)$/ ); next if not exists ($dev->{READINGS}{$readingName}); $statisticDone = 1; statistics_doStatisticMinMax ($hash, $dev, $readingName, 1, $periodSwitch, 1); } if ($periodSwitch>=1) { @specialReadings = split /,/, AttrVal($hashName, "tendencyReadings", ""); foreach $readingName (@specialReadings) { my $completeReadingName = $devName.":".$readingName; next if ($completeReadingName =~ m/^($exclReadings)$/ ); next if not exists ($dev->{READINGS}{$readingName}); $statisticDone = 1; statistics_doStatisticTendency ($hash, $dev, $readingName, 1); } } if ($statisticDone != 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, $decPlaces, $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/(-?[\d.]*).*/$1/e; statistics_Log $hash, 4, "Calculating min/avg/max statistics for '".$dev->{NAME}.":$readingName = $value'"; # statistics_doStatisticMinMaxSingle: $hash, $readingName, $value, $saveLast, decPlaces # Hourly statistic (if needed) if ($doHourly) { statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Hour", $value, ($periodSwitch >= 1), $decPlaces; } # Daily statistic statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Day", $value, ($periodSwitch >= 2), $decPlaces; # Monthly statistic statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Month", $value, ($periodSwitch >= 3), $decPlaces; # Yearly statistic statistics_doStatisticMinMaxSingle $hash, $dev, $readingName, "Year", $value, ($periodSwitch == 4), $decPlaces; return ; } # Calculates single MaxMin Values and informs about end of day and month sub ######################################## statistics_doStatisticMinMaxSingle ($$$$$$$) { my ($hash, $dev, $readingName, $period, $value, $saveLast, $decPlaces) = @_; 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 } # 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, 5, "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", ""); 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]"; readingsSingleUpdate($hash, $hiddenReadingName, $result, 0); statistics_Log $hash, 5, "Set '$hiddenReadingName'='$result'"; return; } # Calculates tendency values sub ######################################## statistics_doStatisticTendency ($$$$) { my ($hash, $dev, $readingName, $decPlaces) = @_; 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/([-\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}; } my $result = $value; statistics_Log $hash, 4, "Add $value to $hiddenReadingName"; if (exists ($hash->{READINGS}{$hiddenReadingName}{VAL})) { $result .= " " . $hash->{READINGS}{$hiddenReadingName}{VAL}; } @hidden = split / /, $result; # Internal values 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", ""); 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[1],0,0); statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Tendency","3h",$stat[1],0,0); statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,"Tendency","6h",$stat[1],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/([-\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}); if ( $firstRun ) { # Show since-Value and initialize all readings $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'."; } else { # Do calculations if hidden reading exists @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 if ($periodSwitch >= 3 || $periodSwitch <= -3){ $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 if ($periodSwitch >= 2 || $periodSwitch <= -2){ $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 if ($periodSwitch >= 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 >= 1) { $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", ""); 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 value '$lastValue' from '$hiddenReadingName'"; } # Calculate specialPeriodValue my $result = 0; foreach (@hidden) { $result += $_; } $result = sprintf "%.".$decPlaces."f", $result; if ($#hidden + 1 != $specialPeriod) { $result .= " (".($#hidden+1).".hours)"; } readingsBulkUpdate($dev, $statReadingName, $result, 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}; statistics_Log $hash, 4, "Calculating duration statistics for '".$dev->{NAME}.":$readingName = $state'"; # 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); 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}; my $statReadingName = $hash->{PREFIX}; $statReadingName .= ucfirst($readingName).$period; my %hidden; my $firstRun = not exists($hash->{READINGS}{$hiddenReadingName}); my $lastState = $state; my $statValue = "00:00:00"; if ( $firstRun ) { # Show since-Value $hidden{"showDate:"} = 1; $saveLast = 0; $hidden{"(since:"} = strftime ("%Y-%m-%d_%H:%M:%S)",localtime() ); } else { # Do calculations if hidden reading exists %hidden = split / /, $hash->{READINGS}{$hiddenReadingName}{VAL}; # Internal values $lastState = $hidden{"lastState:"}; my $timeDiff = int(gettimeofday())-$hidden{"lastTime:"}; $hidden{$lastState.":"} += $timeDiff; $statValue = statistics_FormatDuration ($hidden{$lastState.":"}); } $hidden{"lastState:"} = $state; $hidden{"lastTime:"} = int(gettimeofday()); # Prepare new current reading, delete hidden reading if it is used again $result = ""; while (my ($key, $duration) = each(%hidden)){ if ($key !~ /lastState:|lastTime:|showDate:|since:/) { if ($result ne "") {$result .= " ";} $result .= "$key ".statistics_FormatDuration($duration); if ($saveLast) { delete $hidden{$key}; } } } if ($result eq "") {$result = "$state: 0";} if ($hidden{"showDate:"} == 1) { $result .= " (since: ".$hidden{"(since:"}; } # Store current reading as last reading, Reset current reading if ($saveLast) { readingsBulkUpdate($dev, $statReadingName . "Last", $result, 1); statistics_Log $hash, 5, "Set '".$statReadingName . "Last = $result'"; $result = "$state: 00:00:00"; $hidden{"showDate:"} = 0; } # Store current reading readingsBulkUpdate($dev, $statReadingName, $result, 0); statistics_Log $hash, 5, "Set '$statReadingName = $result'"; # Store single readings my $singularReadings = AttrVal($name, "singularReadings", ""); if ($singularReadings ne "") { # statistics_storeSingularReadings $hashName,$singularReadings,$dev,$statReadingName,$readingName,$statType,$period,$statValue,$value,$saveLast statistics_storeSingularReadings ($name,$singularReadings,$dev,$statReadingName,$readingName,ucfirst($lastState),$period,$statValue,0,$saveLast); } # Store hidden reading $result = ""; while (my ($key, $duration) = each(%hidden)){ if ($result ne "") {$result .= " ";} $result .= "$key $duration"; } readingsSingleUpdate($hash, $hiddenReadingName, $result, 0); statistics_Log $hash, 5, "Set '$hiddenReadingName = $result'"; return; } sub #################### statistics_storeSingularReadings ($$$$$$$$$$) { my ($hashName,$singularReadings,$dev,$statReadingName,$readingName,$statType,$period,$statValue,$lastValue,$saveLast) = @_; return if $singularReadings eq ""; if ($statType =~ /Delta|Tendency/) { $statReadingName .= $period;} else { $statReadingName .= $statType;} my $devName=$dev->{NAME}; if ("$devName:$readingName:$statType:$period" =~ /^($singularReadings)$/) { readingsBulkUpdate($dev, $statReadingName, $statValue, 1); statistics_Log $hashName, 5, "Set ".$statReadingName." = $statValue"; if ($saveLast) { readingsBulkUpdate($dev, $statReadingName."Last", $lastValue, 1); statistics_Log $hashName, 5, "Set ".$statReadingName."Last = $lastValue"; } } } sub #################### statistics_getStoredDevices ($) { my ($hash) = @_; my $result=""; foreach my $r (sort keys %{$hash->{READINGS}}) { if ($r =~ /^\.(.*):.*/) { my $device = $1; my $regExp = '^'.$1.'$|^'.$1.',|,'.$1.'$|,'.$1.','; if ($result !~ /$regExp/) { $result.="," . $device; } } } return $result; } sub ######################################## statistics_FormatDuration($) { my ($value) = @_; #Tage my $returnstr =""; if ($value > 86400) { $returnstr = sprintf "%dd ", int($value/86400); } # Stunden $value %= 86400; $returnstr .= sprintf "%02d:", int($value/3600); $value %= 3600; $returnstr .= sprintf "%02d:", int($value/60); $value %= 60; $returnstr .= sprintf "%02d", $value; return $returnstr; } sub ######################################## statistics_maxDecPlaces($$) { my ($value, $decMax) = @_; $decMax = 0 if ! defined $decMax; if ( $value =~ /.*\.(.*)/ ) { my $decPlaces = length($1); $decMax = $decPlaces >= $decMax ? $decPlaces : $decMax; } return $decMax; } sub ######################################## statistics_UpdateDevReading($$$$) { my ($dev, $rname, $val, $event) = @_; $dev->{READINGS}{$rname}{VAL} = $val; $dev->{READINGS}{$rname}{TIME} = TimeNow(); if ($event==1) { if (exists ($dev->{CHANGED})) { my $max = int(@{$dev->{CHANGED}}); $dev->{CHANGED}[$max] = "$rname: $val"; } } else { readingsBulkUpdate($dev, $rname, $val, 1); } } ########################## 1; =pod =begin html

statistics

    This modul calculates for certain readings of given devices statistical values and adds them to the devices.
    Until now statistics for the following readings are automatically built:

    • Min|Avg|Max Minimum, average and maximum of instantaneous values:
      over a period of day, month and year: brightness, current, energy_current, humidity, temperature, voltage
      over a period of hour, day, month and year: wind, wind_speed, windSpeed

    • Tendency over 1h, 2h, 3h und 6h: pressure

    • Delta between start and end values over a period of hour, day, month and year:
      count, energy, energy_total, power, total, rain, rain_rate, rain_total

    • Duration of the states over a period of day, month and year:
      lightsensor, lock, motion, Window, window, state (if no other reading is recognized)

    Further readings can be added via the correspondent attribute.
     
    Define

      define <name> statistics <deviceNameRegExp> [Prefix]
      Beispiel: define Statistik statistics Sensor_.*|Wettersensor
       
    • <DeviceNameRegExp>
      Regular expression of device names. !!! Not the device readings !!!

    • [Prefix]
      Optional. Prefix set is place before statistical data. Default is stat


    Set

    • resetStatistics <All|DeviceName>
      Resets the statistic values of the selected device.
    • doStatistics
      Calculates the current statistic values of all monitored devices.

    Get
      not implemented yet

    Attributes

    • dayChangeTime <time>
      Time of day change. Default is 00:00. For weather data the day change can be set e.g. to 06:50.

    • deltaReadings <readings>
      Comma separated list of reading names for which a delta statistic shall be calculated.

    • durationReadings <readings>
      Comma separated list of reading names for which a duration statistic shall be calculated.

    • excludedReadings <DeviceRegExp:ReadingNameRegExp>
      Regular expression of the readings that shall be excluded from the statistics.
      The reading have to be entered in the form deviceName:readingName. E.g. "FritzDect:current|Sensor_.*:humidity"

    • minAvgMaxReadings <readings>
      Comma separated list of reading names for which a min/average/max statistic shall be calculated.

    • periodChangePreset <seconds>
      Start of the calculation of periodical data before each full hour. Default is 5 Sekunden.
      Allows the correct timely assignment within plots, can be adapted to CPU load.

    • singularReadings <DeviceRegExp:ReadingRegExp>:statTypes:period
      • statTypes: Min|Avg|Max|Delta|Duration|Tendency
      • period: Hour|Day|Month|Year|1h|2h|3h|6h

      Regulare expression of statistic values, which shall not be shown in summary but also in singular readings. Eases the creation of plots.
      E.g. Wettersensor:rain:Delta:(Hour|Day)|(FritzDect:(current|power):(Avg|Max|Delta):(Hour|Day)

    • specialDeltaPeriodHours <hours>
      Adds, for readings of delta statistics, a singular reading for the given period of hours (e.g. for the rain of the last 72 hours)

    • tendencyReadings <readings>
      Comma separated list of reading names for which a tendendy statistic shall be calculated.

=end html =begin html_DE

statistics

    Dieses Modul wertet von den angegebenen Geräten (als regulärer Ausdruck) bestimmte Werte statistisch aus und fügt das Ergebnis den jeweiligen Geräten als neue Werte hinzu.
     
    Derzeit werden die folgenden Statistik-Typen für bestimmte Gerätewerte vom Modul automatisch berechnet:
    • Min|Avg|Max Minimum, Durchschnitt und Maximum von Momentanwerten:
      über den Zeitraum Tag, Monat und Jahr: brightness, current, energy_current, humidity, temperature, voltage
      über den Zeitraum Stunde, Tag, Monat und Jahr: wind, wind_speed, windSpeed
    • Tendency Tendenz über 1h, 2h, 3h und 6h: pressure
    • Delta Differenz zwischen Anfangs- und Endwerte innerhalb eines Zeitraums (Stunde, Tag, Monat, Jahr):
      count, energy, energy_total, power, total, rain, rain_rate, rain_total
    • Duration Dauer der Zustände (on, off, open, closed ...) innerhalb eines Zeitraums (Tag, Monat, Jahr):
      lightsensor, lock, motion, Window, window, state (wenn kein anderer Gerätewert gültig)
    Weitere Gerätewerte können über die entsprechenden Attribute hinzugefügt werden.
     
    Define

      define <Name> statistics <GeräteNameRegExp> [Prefix]
      Beispiel: define Statistik statistics Wettersensor|Badsensor
       
    • <GeräteNameRegExp>
      Regulärer Ausdruck für den Gerätenamen. !!! Nicht die Gerätewerte !!!

    • [Prefix]
      Optional. Der Prefix wird vor den Namen der statistischen Gerätewerte gesetzt. Standardmässig stat


    Set

    • resetStatistics <All|Gerätename>
      Setzt die Statistiken der ausgewählten Geräte zurück.

    • doStatistics
      Berechnet die aktuellen Statistiken aller beobachteten Geräte.


    Get
      nicht implementiert

    Attributes

    • dayChangeTime <Zeit>
      Uhrzeit des Tageswechsels. Standardmässig 00:00. Bei Wetterdaten kann der Tageswechsel z.B. auf 6:50 gesetzt werden.

    • deltaReadings <Gerätewerte>
      Durch Kommas getrennte Liste von weiteren Gerätewerten, für welche die Differenz zwischen den Werten am Anfang und Ende einer Periode (Stunde/Tag/Monat/Jahr) bestimmt wird.

    • durationReadings <Gerätewerte>
      Durch Kommas getrennte Liste von weiteren Gerätewerten, für welche die Dauer einzelner Gerätewerte innerhalb bestimmte Zeiträume (Stunde/Tag/Monat/Jahr) erfasst wird.

    • excludedReadings <GerätenameRegExp:GerätewertRegExp>
      Regulärer Ausdruck der Gerätewerte die nicht ausgewertet werden sollen. z.B. "FritzDect:current|Sensor_.*:humidity"

    • hideAllSummaryReadings <0 | 1>
      noch nicht implementiert - Es werden keine gesammelten Statistiken angezeigt, sondern nur die unter "singularReadings" definierten Einzelwerte

    • minAvgMaxReadings <Gerätewerte>
      Durch Kommas getrennte Liste von Gerätewerten, für die in bestimmten Zeiträumen (Tag, Monat, Jahr) Minimum, Mittelwert und Maximum erfasst werden.

    • periodChangePreset <Sekunden>
      Start der Berechnung der periodischen Daten, standardmässig 5 Sekunden vor der vollen Stunde,
      Erlaubt die korrekte zeitliche Zuordnung in Plots, kann je nach Systemauslastung verringert oder vergrößert werden.

    • singularReadings <GeräteNameRegExp:GeräteWertRegExp:Statistiktypen:Zeitraum>
      • Statistiktypen: Min|Avg|Max|Delta|Duration|Tendency
      • Zeitraum: Hour|Day|Month|Year|1h|2h|3h|6h
      Regulärer Ausdruck statistischer Werte, die nicht nur in zusammengefassten sondern auch als einzelne Werte gespeichert werden sollen. Erleichtert die Erzeugung von Plots und anderer Auswertungen (notify).
      z.B. Wettersensor:rain:Delta:(Hour|Day)|FritzDect:power:Delta:Day

    • specialDeltaPeriodHours <Stunden>
      Fügt den Delta-Statistiken einen singulären Gerätewert für die angegebenen Stunden hinzu (z.b. für den Regen in den letzten 72 Stunden)

    • tendencyReadings <Gerätewerte>
      Durch Kommas getrennte Liste von weiteren Gerätewerten, für die innerhalb bestimmter Zeiträume (1h, 2h, 3h, 6h) die Differenz zwischen Anfangs- und Endwert ermittelt wird.

    • readingFnAttributes

=end html_DE =cut