# $Id$ ######################################################################################################################## # # 73_GasCalculator.pm # Observes a reading of a device which represents the actual counter (e.g. OW_devive) # acting as gas counter, calculates the corresponding values and writes them back to # the counter device. # Written and best viewed with Notepad++ v.6.8.6; Language Markup: Perl # # # Author : Matthias Deeke # e-mail : matthias.deeke(AT)deeke(PUNKT)eu # Fhem Forum : https://forum.fhem.de/index.php/topic,47909.0.html # Fhem Wiki : Not yet implemented # # This file is part of fhem. # # Fhem 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. # # Fhem 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. # # You should have received a copy of the GNU General Public License # along with fhem. If not, see . # # fhem.cfg: define GasCalculator # # Example 1: # define myGasCalculator GasCalculator myGasCounter:CounterA.* # # # # ######################################################################################################################## ######################################################################################################################## # List of open Problems / Issues: # # # # # # # ######################################################################################################################## package main; use strict; use warnings; use Time::Local; use FHEM::Meta; use Data::Dumper; my %GasCalculator_gets; my %GasCalculator_sets; ###START###### Initialize module ##############################################################################START#### sub GasCalculator_Initialize($) { my ($hash) = @_; $hash->{STATE} = "Init"; $hash->{DefFn} = "GasCalculator_Define"; $hash->{UndefFn} = "GasCalculator_Undefine"; $hash->{GetFn} = "GasCalculator_Get"; $hash->{SetFn} = "GasCalculator_Set"; $hash->{AttrFn} = "GasCalculator_Attr"; $hash->{NotifyFn} = "GasCalculator_Notify"; $hash->{DbLog_splitFn} = "GasCalculator_DbLog_splitFn"; $hash->{NotifyOrderPrefix} = "10-"; # Want to be called before the rest $hash->{AttrList} = "disable:0,1 " . "header " . "GasCounterOffset " . "GasCubicPerCounts " . "GaszValue " . "GasNominalHeatingValue " . "BasicPricePerAnnum " . "GasPricePerKWh " . "MonthlyPayment " . "MonthOfAnnualReading " . "ReadingDestination:CalculatorDevice,CounterDevice " . "SiPrefixPower:W,kW,MW,GW " . "Volume:m³,ft³ " . "Currency:€,£,$ " . "DecimalPlace:3,4,5,6,7 " . $readingFnAttributes; return FHEM::Meta::InitMod( __FILE__, $hash ); } ####END####### Initialize module ###############################################################################END##### ###START###### Activate module after module has been used via fhem command "define" ##########################START#### sub GasCalculator_Define($$$) { my ($hash, $def) = @_; my ($name, $type, $RegEx, $RegExst) = split("[ \t]+", $def, 4); ### Check whether regular expression has correct syntax if(!$RegEx || $RegExst) { my $msg = "Wrong syntax: define GasCalculator device[:event]"; return $msg; } ### Check whether regular expression is misleading eval { "Hallo" =~ m/^$RegEx$/ }; return "Bad regexp: $@" if($@); $hash->{REGEXP} = $RegEx; ### Writing values to global hash notifyRegexpChanged($hash, $RegEx); $hash->{NAME} = $name; $hash->{STATE} = "active"; $hash->{REGEXP} = $RegEx; ### Convert SiPrefixPowerFactor if(defined($attr{$hash}{SiPrefixPower})) { if ($attr{$hash}{SiPrefixPower} eq "W" ) {$hash->{system}{SiPrefixPowerFactor} = 1 ;} elsif ($attr{$hash}{SiPrefixPower} eq "kW") {$hash->{system}{SiPrefixPowerFactor} = 1000 ;} elsif ($attr{$hash}{SiPrefixPower} eq "MW") {$hash->{system}{SiPrefixPowerFactor} = 1000000 ;} elsif ($attr{$hash}{SiPrefixPower} eq "GW") {$hash->{system}{SiPrefixPowerFactor} = 1000000000 ;} else {$hash->{system}{SiPrefixPowerFactor} = 1 ;} } else { $hash->{system}{SiPrefixPowerFactor} = 1; } ### Convert Decimal Places if(defined($attr{$hash}{DecimalPlace})) { $hash->{system}{DecimalPlace} = "%." . $attr{$hash}{DecimalPlace} . "f"; } else { $hash->{system}{DecimalPlace} = "%.3f"; } ### For debugging purpose only Log3 $name, 5, $name. " : GasCalculator - RegEx : " . $RegEx; ### Defining notify trigger notifyRegexpChanged($hash, $RegEx); ### Writing log entry Log3 $name, 5, $name. " : GasCalculator - Starting to define module"; ### Start timer for execution around midnight my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); my $EpochNextMidnight = timelocal(1, 0, 0, $mday, $mon, $year+1900) + 86400; InternalTimer($EpochNextMidnight, "GasCalculator_MidnightTimer", $hash, 0); ### For debugging purpose only Log3 $name, 5, $name. " : GasCalculator_MidnightTimer - time : " . time(); Log3 $name, 5, $name. " : GasCalculator_MidnightTimer - year : " . $year; Log3 $name, 5, $name. " : GasCalculator_MidnightTimer - mon : " . $mon; Log3 $name, 5, $name. " : GasCalculator_MidnightTimer - day : " . $mday; Log3 $name, 5, $name. " : GasCalculator_MidnightTimer - timelocal : " . timelocal(1, 0, 0, $mday, $mon, $year+1900); Log3 $name, 5, $name. " : GasCalculator_MidnightTimer - nextMidnight : " . $EpochNextMidnight; return undef; } ####END####### Activate module after module has been used via fhem command "define" ############################END##### ###START###### Deactivate module module after "undefine" command by fhem ######################################START#### sub GasCalculator_Undefine($$) { my ($hash, $def) = @_; my $name = $hash->{NAME}; ### Stop internal timer RemoveInternalTimer($hash); ### Write log information Log3 $name, 3, $name. " GasCalculator- The gas calculator has been undefined. Values corresponding to Gas Counter will no longer calculated"; return undef; } ####END####### Deactivate module module after "undefine" command by fhem #######################################END##### ###START###### Handle attributes after changes via fhem GUI ###################################################START#### sub GasCalculator_Attr(@) { my @a = @_; my $name = $a[1]; my $hash = $defs{$name}; ### Check whether "disable" attribute has been provided if ($a[2] eq "disable") { if ($a[3] eq 0) { $hash->{STATE} = "active"; } elsif ($a[3] eq 1) { $hash->{STATE} = "disabled"; } } ### Check whether "SiPrefixPower" attribute has been provided elsif ($a[2] eq "SiPrefixPower") { if ($a[3] eq "W" ) {$hash->{system}{SiPrefixPowerFactor} = 1 ;} elsif ($a[3] eq "kW") {$hash->{system}{SiPrefixPowerFactor} = 1000 ;} elsif ($a[3] eq "MW") {$hash->{system}{SiPrefixPowerFactor} = 1000000 ;} elsif ($a[3] eq "GW") {$hash->{system}{SiPrefixPowerFactor} = 1000000000 ;} else {$hash->{system}{SiPrefixPowerFactor} = 1 ;} } ### Convert Decimal Places elsif ($a[2] eq "DecimalPlace") { if (($a[3] >= 3) && ($a[3] <= 8)) { $hash->{system}{DecimalPlace} = "%." . $a[3] . "f"; } else { $hash->{system}{DecimalPlace} = "%.3f"; } } return undef; } ####END####### Handle attributes after changes via fhem GUI ####################################################END##### ###START###### Provide units for DbLog database via DbLog_splitFn #############################################START#### sub GasCalculator_DbLog_splitFn($$) { my ($event, $name) = @_; my ($reading, $value, $unit); my $hash = $defs{$name}; my @argument = split("[ \t][ \t]*", $event); ### Delete ":" and everything behind in readings name $argument[0] =~ s/:.*//; ### Log entries for debugging #Log3 $name, 5, $name. " : GasCalculator_DbLog_splitFn - Content of event : " . $event; #Log3 $name, 5, $name. " : GasCalculator_splitFn - Content of argument[0] : " . $argument[0]; #Log3 $name, 5, $name. " : GasCalculator_splitFn - Content of argument[1] : " . $argument[1]; ### If the reading contains "_EnergyCost" or "_FinanceReserve" if (($argument[0] =~ /_EnergyCost/) || ($argument[0] =~ /_FinanceReserve/)) { ### Log entries for debugging #Log3 $name, 5, $name. " : GasCalculator - DbLog_splitFn - EnergyCost-Reading detected : " . $argument[0]; ### Get values being changed from hash $reading = $argument[0]; $value = $argument[1]; $unit = $attr{$hash}{Currency}; } ### If the reading contains "_Power" elsif ($argument[0] =~ /_Power/) { ### Log entries for debugging #Log3 $name, 5, $name. " : GasCalculator - DbLog_splitFn - Power-Reading detected : " . $argument[0]; ### Get values being changed from hash $reading = $argument[0]; $value = $argument[1]; $unit = $attr{$hash}{SiPrefixPower}; } ### If the reading contains "_Counter" or "_Last" or ("_Energy" but not "_EnergyCost") or "_PrevRead" elsif (($argument[0] =~ /_Counter/) || ($argument[0] =~ /_Last/) || (($argument[0] =~ /_Energy/) && ($argument[0] !~ /_EnergyCost/)) || ($argument[0] =~ /_PrevRead/)) { ### Log entries for debugging #Log3 $name, 5, $name. " : GasCalculator - DbLog_splitFn - Counter/Energy-Reading detected : " . $argument[0]; ### Get values being changed from hash $reading = $argument[0]; $value = $argument[1]; $unit = $attr{$hash}{Volume}; } ### If the reading is unknown else { ### Log entries for debugging #Log3 $name, 5, $name. " : GasCalculator - DbLog_splitFn - unspecified-Reading detected : " . $argument[0]; ### Get values being changed from hash $reading = $argument[0]; $value = $argument[1]; $unit = ""; } return ($reading, $value, $unit); } ####END####### Provide units for DbLog database via DbLog_splitFn ##############################################END##### ###START###### Manipulate reading after "get" command by fhem #################################################START#### sub GasCalculator_Get($@) { my ( $hash, @a ) = @_; ### If not enough arguments have been provided if ( @a < 2 ) { return "\"set GasCalculator\" needs at least one argument"; } my $GasCalcName = shift @a; my $reading = shift @a; my $value = join(" ", @a); my $ReturnMessage; my @cList; ### Create Log entries for debugging #Log3 $GasCalcName, 5, $GasCalcName. "_Get - reading : " . $reading; #Log3 $GasCalcName, 5, $GasCalcName. "_Get - value : " . $value; if(defined($hash->{READINGS})) { push(@cList, " "); push(@cList, keys(%{$hash->{READINGS}})); } else { push(@cList, " "); } ### Create Log entries for debugging #Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - set list: " . join(" ", @cList); return "Unknown argument $reading, choose one of " . join(" ", @cList) if $reading eq '?'; if ( $reading ne "?") { ### Write current value $value = ReadingsVal($GasCalcName, $reading, undef); ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - get " . $reading . " with value: " . $value; ### Create ReturnMessage $ReturnMessage = $value; } return($ReturnMessage); } ####END####### Manipulate reading after "get" command by fhem ##################################################END##### ###START###### Manipulate reading after "set" command by fhem #################################################START#### sub GasCalculator_Set($@) { my ( $hash, @a ) = @_; ### If not enough arguments have been provided if ( @a < 2 ) { return "\"set GasCalculator\" needs at least one argument"; } my $GasCalcName = shift @a; my $reading = shift @a; my $value = join(" ", @a); my $ReturnMessage; my @cList; ### Create Log entries for debugging #Log3 $GasCalcName, 5, $GasCalcName. "_Set - reading : " . $reading; #Log3 $GasCalcName, 5, $GasCalcName. "_Set - value : " . $value; ### For Test purpose only #push(@cList, "Test"); ### Create set-List if(defined($hash->{READINGS})) { push(@cList, "SyncCounter"); push(@cList, keys(%{$hash->{READINGS}})); } else { push(@cList, "SyncCounter"); } ### Create Log entries for debugging #Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - set list: " . join(" ", @cList); return "Unknown argument $reading, choose one of " . join(" ", @cList) if $reading eq '?'; ### If the command supposed to synchronize the CounterValues between CounterModule and CalculatorModule if ($reading eq "SyncCounter") { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " - Syncing Counter with :" . $value; ### Search for the ReadingsName of the Current CounterValue my @SearchResult = grep(/_Meter/, @cList); ### Get current CalculatorValue my $CalculaterValueCurrent = ReadingsVal($GasCalcName, $SearchResult[0], 0); ### Get current Offset from Attribute my $CounterOffsetCurrent = AttrVal($GasCalcName, "GasCounterOffset", 0); ### Calculate CounterValue my $CounterValueCurrent = $CalculaterValueCurrent - $CounterOffsetCurrent; ### Calculate new Offset my $CounterOffsetNew = $value - $CounterValueCurrent; ### Calculate Ceck # my $CounterValueNew = $CounterValueCurrent + $CounterOffsetNew; ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " - Search Result : " . Dumper(@SearchResult); Log3 $GasCalcName, 5, $GasCalcName. " - CounterValueNew Given : " . $value; Log3 $GasCalcName, 5, $GasCalcName. " - CounterValueCurrent Result : " . $CalculaterValueCurrent; Log3 $GasCalcName, 5, $GasCalcName. " - CounterOffsetCurrent Result : " . $CounterOffsetCurrent; Log3 $GasCalcName, 5, $GasCalcName. " - CounterValueCurrent Result : " . $CounterValueCurrent; Log3 $GasCalcName, 5, $GasCalcName. " - CounterOffsetNew Result : " . $CounterOffsetNew; # Log3 $GasCalcName, 5, $GasCalcName. " - CounterValueNew Check : " . $CounterValueNew; ### Set new Offset in Attributes $attr{$GasCalcName}{GasCounterOffset} = $CounterOffsetNew; ### Create ReturnMessage $ReturnMessage = $GasCalcName . " - Successfully synchronized Counter and Calculator with : " . $value . " " . $attr{$hash}{SiPrefixPower}; } ### For Test purpose only # elsif ($reading eq "Test") # { # GasCalculator_MidnightTimer($hash); # } elsif ($reading ne "?") { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - set " . $reading . " with value: " . $value; ### Write current value readingsSingleUpdate($hash, $reading, $value, 1); ### Create ReturnMessage $ReturnMessage = $GasCalcName . " - Successfully set " . $reading . " with value: " . $value; } return($ReturnMessage); } ####END####### Manipulate reading after "set" command by fhem ##################################################END##### ###START###### Midnight Routine ###############################################################################START#### sub GasCalculator_MidnightTimer($) { ### Define variables my ($GasCalcDev) = @_; my $GasCalcName = $GasCalcDev->{NAME}; my $RegEx = $GasCalcDev->{REGEXP}; my ($GasCountName, $GasCountReadingRegEx) = split(":", $RegEx, 2); my $GasCountDev = $defs{$GasCountName}; $GasCountReadingRegEx =~ s/[\.\*]+$//; $GasCountReadingRegEx =~ s/[:]+$//; my $GasCountReadingRegExNeg = $GasCountReadingRegEx . "_"; my @GasCountReadingNameListComplete = keys(%{$GasCountDev->{READINGS}}); my @GasCountReadingNameListFiltered; ### Create Log entries for debugging purpose Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer GasCountName : " . $GasCountName; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer RegEx : " . $RegEx; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer ReadingRegEx : " . $GasCountReadingRegEx; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer ReadingRegExNeg : " . $GasCountReadingRegExNeg; ### If no RegEx is available, leave routine if (($GasCountReadingRegEx eq "") || ($GasCountReadingRegExNeg eq "")) { Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer : ERROR! No RegEx has been previously stored! Beaking midnight routine."; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer ReadingRegEx : " . $GasCountReadingRegEx; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer ReadingRegExNeg : " . $GasCountReadingRegExNeg; return; } ### Check whether system failure threat is given or log error message eval { ### For each valid RegEx entry given in the list of existing devices foreach my $GasCountReadingName (@GasCountReadingNameListComplete) { if (($GasCountReadingName =~ m[$GasCountReadingRegEx]) && ($GasCountReadingName !~ m[$GasCountReadingRegExNeg])) { push(@GasCountReadingNameListFiltered, $GasCountReadingName); } } 1; } or do { my $ErrorMessage = $@; Log3 $GasCalcName, 2, $GasCalcName. " : Something went wrong with the RegEx : " . $ErrorMessage; return; }; ### Create Log entries for debugging purpose Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer__________________________________________________________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer : MidnightTimer initiated"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - RegEx : " . $RegEx; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - ReadingRegEx : " . $GasCountReadingRegEx; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - GasCountName : " . $GasCountName; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - GasCountReadCompl : \n" . Dumper(@GasCountReadingNameListComplete); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - GasCountReadList : \n" . Dumper(@GasCountReadingNameListFiltered); ### Remove internal timer for GasCalculator_MidnightTimer RemoveInternalTimer($GasCalcDev, "GasCalculator_MidnightTimer"); ### Create Log entries for debugging purpose Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Looping through every Counter defined by RegEx"; foreach my $GasCountReadingName (@GasCountReadingNameListFiltered) { ### Create Readings my $GasCalcReadingDestinationDeviceName; my $GasCalcReadingPrefix; my $GasCalcReadingDestinationDevice; if ($attr{$GasCalcName}{ReadingDestination} eq "CalculatorDevice") { $GasCalcReadingDestinationDeviceName = $GasCalcName; $GasCalcReadingPrefix = ($GasCountName . "_" . $GasCountReadingName); $GasCalcReadingDestinationDevice = $GasCalcDev; } elsif ($attr{$GasCalcName}{ReadingDestination} eq "CounterDevice") { $GasCalcReadingPrefix = $GasCountReadingName; $GasCalcReadingDestinationDevice = $GasCountDev; $GasCalcReadingDestinationDeviceName = $GasCountName; } else { ### Create Log entries for debugging Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator_MidnightTimer - Attribut ReadingDestination has not been set up correctly. Skipping event."; ### Skipping event next; } my $GasCounterReadingValue = ReadingsVal($GasCountName, $GasCountReadingName , "error"); my $LastUpdateTimestampUnix = ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_LastUpdateTimestampUnix", 0 ); ### Calculate time difference since last update my $DeltaTimeSinceLastUpdate = time() - $LastUpdateTimestampUnix ; ### Create Log entries for debugging purpose Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer ___________Looping________________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - ReadingPrefix : " . $GasCalcReadingPrefix; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - DeviceName : " . $GasCalcReadingDestinationDeviceName; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Timestamp now : " . time(); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Timestamp update : " . $LastUpdateTimestampUnix; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Timestamp Delta : " . $DeltaTimeSinceLastUpdate; ### If the Readings for midnight settings have been provided if (($GasCalcReadingPrefix ne "error") && ($GasCalcReadingDestinationDeviceName ne "error") && ($LastUpdateTimestampUnix > 0)){ ### If there was no update in the last 24h if ( $DeltaTimeSinceLastUpdate >= 86400) { ### Create Log entries for debugging purpose Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Last Update : No Update in the last 24h!"; } else { ### Create Log entries for debugging purpose Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Last Update : There was an Update in the last 24h!"; } ### Create Log entries for debugging purpose #Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - GasCalcRDD : \n" . Dumper($GasCalcReadingDestinationDevice); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - GasCounter : " . $GasCounterReadingValue; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre WFRDaySum : " . ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_PowerDaySum", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre WFRDayCount : " . ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_PowerDayCount", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre WFRDayCurrent : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerCurrent", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre WFRDayAver : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerDayAver", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre WFRDayMax : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerDayMax", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre WFRDayMin : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerDayMin", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre ConsumDay : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_EnergyDay", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre ConsumDayLast : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_EnergyDayLast", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre ConsumCstDay : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_EnergyCostDay", "error"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Pre ConsumCstDayL : " . ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_EnergyCostDayLast", "error"); if ($GasCounterReadingValue ne "error") { ### Create Log entries for debugging purpose Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Writing Device : " . $GasCountDev->{NAME}; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Writing Reading : " . $GasCountReadingName; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Writing Value : " . $GasCounterReadingValue; ### Writing Counter Value readingsSingleUpdate($GasCountDev, $GasCountReadingName, $GasCounterReadingValue, 1); } else { Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - Writing Counter : Error!"; } } ### If the Readings for midnight settings have not been provided else { ### Warning Log entry Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - ERROR - There have no information stored about previous readings. Make sure the counter has been delivering at least 2 values to the Calculator device before next midnight!"; } } ### Start timer for execution around midnight my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); my $EpochNextMidnight = timelocal(1, 0, 0, $mday, $mon, $year+1900) + 86400; InternalTimer($EpochNextMidnight, "GasCalculator_MidnightTimer", $GasCalcDev, 0); ### For debugging purpose only Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer _______Looping finished___________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - time : " . time(); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - timelocal : " . timelocal(1, 0, 0, $mday, $mon, $year+1900); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator_MidnightTimer - nextMidnight : " . $EpochNextMidnight; } ####END####### Midnight Routine ################################################################################END##### ###START###### Calculate gas meter values on changed events ###################################################START#### sub GasCalculator_Notify($$) { ### Define variables my ($GasCalcDev, $GasCountDev) = @_; my $GasCalcName = $GasCalcDev->{NAME}; my $GasCountName = $GasCountDev->{NAME}; my $GasCountNameEvents = deviceEvents($GasCountDev, 1); my $NumberOfChangedEvents = int(@{$GasCountNameEvents}); my $RegEx = $GasCalcDev->{REGEXP}; ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator Begin_______________________________________________________________________________________________________________________________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Notify - Trigger Dev Name : " . $GasCountDev->{NAME}; ### Check whether the gas calculator has been disabled if(IsDisabled($GasCalcName)) { return ""; } ### Check whether all required attributes has been provided and if not, create them with standard values if(!defined($attr{$GasCalcName}{BasicPricePerAnnum})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{BasicPricePerAnnum} = 0; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute BasicPricePerAnnum was missing and has been set to 0"; } if(!defined($attr{$GasCalcName}{GasCounterOffset})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{GasCounterOffset} = 0; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute GasCounterOffset was missing and has been set to 0"; } if(!defined($attr{$GasCalcName}{GasCubicPerCounts})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{GasCubicPerCounts} = 0.01; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute GasCubicPerCounts was missing and has been set to 0.01 counts/voulume-unit"; } if(!defined($attr{$GasCalcName}{GasNominalHeatingValue})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{GasNominalHeatingValue} = 10; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute GasNominalHeatingValue was missing and has been set to 10 kWh/volume-unit"; } if(!defined($attr{$GasCalcName}{GasPricePerKWh})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{GasPricePerKWh} = 0.0654; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute GasPricePerKWh was missing and has been set to 0.0654 currency-unit/volume-unit"; } if(!defined($attr{$GasCalcName}{GaszValue})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{GaszValue} = 1; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute GaszValue was missing and has been set to 1"; } if(!defined($attr{$GasCalcName}{MonthlyPayment})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{MonthlyPayment} = 0; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute MonthlyPayment was missing and has been set to 0 currency-units"; } if(!defined($attr{$GasCalcName}{MonthOfAnnualReading})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{MonthOfAnnualReading} = 5; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute MonthOfAnnualReading was missing and has been set to 5 which is the month May"; } if(!defined($attr{$GasCalcName}{Currency})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{Currency} = "€"; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute Currency was missing and has been set to €"; } if(!defined($attr{$GasCalcName}{SiPrefixPower})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{SiPrefixPower} = "W"; $GasCalcDev->{system}{SiPrefixPowerFactor} = 1; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute SiPrefixPower was missing and has been set to W"; } if(!defined($attr{$GasCalcName}{Volume})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{Volume} = "m³"; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute Volume was missing and has been set to m³"; } if(!defined($attr{$GasCalcName}{ReadingDestination})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{ReadingDestination} = "CalculatorDevice"; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute ReadingDestination was missing and has been set to CalculatorDevice"; } if(!defined($attr{$GasCalcName}{room})) { if(defined($attr{$GasCountName}{room})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{room} = $attr{$GasCountName}{room}; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute room was missing and has been set to the same room of the Gas Counter: " . $attr{$GasCountName}{room}; } else { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{room} = "Central Heating"; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute room was missing and has been set to Central Heating"; } } if(!defined($attr{$GasCalcName}{DecimalPlace})) { ### Set attribute with standard value since it is not available $attr{$GasCalcName}{DecimalPlace} = 3; $GasCalcDev->{system}{DecimalPlace} = "%.3f"; ### Writing log entry Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - The attribute DecimalPlace was missing and has been set to 3"; } ### For each feedback on in the array of defined regexpression which has been changed for (my $i = 0; $i < $NumberOfChangedEvents; $i++) { ### Extract event my $s = $GasCountNameEvents->[$i]; ### Filtering all events which do not match the defined regex if(!defined($s)) { next; } my ($GasCountReadingName, $GasCountReadingValueCurrent) = split(": ", $s, 2); # resets $1 if("$GasCountName:$s" !~ m/^$RegEx$/) { next; } ### Extracting value if(defined($1)) { my $RegExArg = $1; if(defined($2)) { $GasCountReadingName = $1; $RegExArg = $2; } $GasCountReadingValueCurrent = $RegExArg if(defined($RegExArg) && $RegExArg =~ m/^(-?\d+\.?\d*)/); } if(!defined($GasCountReadingValueCurrent) || $GasCountReadingValueCurrent !~ m/^(-?\d+\.?\d*)/) { next; } ###Get current Counter and transform in Volume (cubic) as read on mechanic gas meter $GasCountReadingValueCurrent = $1 * $attr{$GasCalcName}{GasCubicPerCounts} + $attr{$GasCalcName}{GasCounterOffset}; my $GasCountReadingTimestampCurrent = ReadingsTimestamp($GasCountName,$GasCountReadingName,0); ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator Begin_______________________________________________________________________________________________________________________________"; ### Create name and destination device for general reading prefix my $GasCalcReadingPrefix; my $GasCalcReadingDestinationDevice; my $GasCalcReadingDestinationDeviceName; if ($attr{$GasCalcName}{ReadingDestination} eq "CalculatorDevice") { $GasCalcReadingPrefix = ($GasCountName . "_" . $GasCountReadingName); $GasCalcReadingDestinationDevice = $GasCalcDev; $GasCalcReadingDestinationDeviceName = $GasCalcName; ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Attribut ReadingDestination has been set to CalculatorDevice"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReadingPrefix : " . $GasCalcReadingPrefix; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReadingDestinationDevice : " . $GasCalcReadingDestinationDevice; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReadingDestinationDeviceName : " . $GasCalcReadingDestinationDeviceName; } elsif ($attr{$GasCalcName}{ReadingDestination} eq "CounterDevice") { $GasCalcReadingPrefix = $GasCountReadingName; $GasCalcReadingDestinationDevice = $GasCountDev; $GasCalcReadingDestinationDeviceName = $GasCountName; ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Attribut ReadingDestination has been set to CounterDevice"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReadingPrefix : " . $GasCalcReadingPrefix; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReadingDestinationDevice : " . $GasCalcReadingDestinationDevice; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReadingDestinationDeviceName : " . $GasCalcReadingDestinationDeviceName; } else { ### Create Log entries for debugging Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - Attribut ReadingDestination has not been set up correctly. Skipping event."; ### Skipping event next; } ### Save Destination of readings into hidden readings readingsSingleUpdate($GasCalcDev, ".ReadingDestinationDeviceName", $GasCalcReadingDestinationDeviceName, 0); ### Restore previous Counter and if not available define it with "undef" my $GasCountReadingTimestampPrevious = ReadingsTimestamp($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_PrevRead", undef); my $GasCountReadingValuePrevious = ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_PrevRead", undef); my $GasCountReadingLastChangeDelta = time() - ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_LastUpdateTimestampUnix", undef); ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - LastUpdateTimestampUnix : " . ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_LastUpdateTimestampUnix", "No Value provided"); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadingLastChangeDeltaSeconds : " . $GasCountReadingLastChangeDelta; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadingValuePrevious : " . $GasCountReadingValuePrevious; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReadingPrefix : " . $GasCalcReadingPrefix; ### Find out whether there has been a previous value being stored if(defined($GasCountReadingValuePrevious)) { ### Write current Volume as previous Voulume for future use in the GasCalc-Device readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix. "_PrevRead", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Previous value found. Continuing with calculations"; } ### If not: save value and quit loop else { ### Write current Volume as previous Voulume for future use in the GasCalc-Device readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix. "_PrevRead", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); ### Save current Gas Consumption as first reading of day = first after midnight and reset min, max value, value counter and value sum readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterDay1st", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterDayLast", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterMonth1st", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterMonthLast", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterMeter1st", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterMeterLast", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterYear1st", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_CounterYearLast", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent)),1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_WFRDaySum", 0, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_WFRDayCount", 0, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_WFRDayMin", 0, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_WFRDayMax", 0, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_LastUpdateTimestampUnix", time(), 0); ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Previous value NOT found. Skipping Loop"; ### Jump out of loop since there is nothing to do anymore than to wait for the next value next; } ###### Find out whether the device has been freshly defined and certain readings have never been set up yet or certain readings have been deleted ### Find out whether the reading for the daily start value has not been written yet if(!defined(ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stDay", undef))) { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - _CounterDay1st value NOT found!"; ### Save current Volume as first reading of day = first after midnight and reset min, max value, value counter and value sum readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stDay", $GasCountReadingValueCurrent, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastDay", $GasCountReadingValuePrevious, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_PowerDaySum", 0, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_PowerDayCount", 0, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerDayMin", 0, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerDayMax", 0, 1); ### Create Log entries for debugging Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - Reading for the first daily value was not available and therfore reading and statistics have been written"; } ### Find out whether the reading for the monthly start value has not been written yet if(!defined(ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stMonth", undef))) { ### Save current Volume as first reading of month readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stMonth", $GasCountReadingValueCurrent, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastMonth", $GasCountReadingValuePrevious, 1); ### Create Log entries for debugging Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - Reading for the first monthly value was not available and therfore reading has been written"; } ### Find out whether the reading for the meter reading year value has not been written yet if(!defined(ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stMeter", undef))) { ### Save current Volume as first reading of month where gas-meter is read readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stMeter", $GasCountReadingValueCurrent, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastMeter", $GasCountReadingValuePrevious, 1); ### Create Log entries for debugging Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - Reading for the first value of gas meter year was not available and therfore reading has been written"; } ### Find out whether the reading for the yearly value has not been written yet if(!defined(ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stYear", undef))) { ### Save current Volume as first reading of the calendar year readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stYear", $GasCountReadingValueCurrent, 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastYear", $GasCountReadingValuePrevious, 1); ### Create Log entries for debugging Log3 $GasCalcName, 3, $GasCalcName. " : GasCalculator - Reading for the first yearly value was not available and therfore reading has been written"; } ### Extracting year, month and day as numbers my $GasCountReadingTimestampPreviousRelative = time_str2num($GasCountReadingTimestampPrevious); my($GasCountReadingTimestampPreviousSec,$GasCountReadingTimestampPreviousMin,$GasCountReadingTimestampPreviousHour,$GasCountReadingTimestampPreviousMday,$GasCountReadingTimestampPreviousMon,$GasCountReadingTimestampPreviousYear,$GasCountReadingTimestampPreviousWday,$GasCountReadingTimestampPreviousYday,$GasCountReadingTimestampPreviousIsdst) = localtime($GasCountReadingTimestampPreviousRelative); my $GasCountReadingTimestampCurrentRelative = time_str2num($GasCountReadingTimestampCurrent); my($GasCountReadingTimestampCurrentSec,$GasCountReadingTimestampCurrentMin,$GasCountReadingTimestampCurrentHour,$GasCountReadingTimestampCurrentMday,$GasCountReadingTimestampCurrentMon,$GasCountReadingTimestampCurrentYear,$GasCountReadingTimestampCurrentWday,$GasCountReadingTimestampCurrentYday,$GasCountReadingTimestampCurrentIsdst) = localtime($GasCountReadingTimestampCurrentRelative); ### Correct current month by one month since Unix/Linux start January with 0 instead of 1 $GasCountReadingTimestampCurrentMon = $GasCountReadingTimestampCurrentMon + 1; ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Reading Name : " . $GasCountReadingName; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Previous Reading Value : " . $GasCountReadingTimestampPrevious; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Current Reading Value : " . $GasCountReadingTimestampCurrent; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Previous Reading Value : " . $GasCountReadingValuePrevious; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Current Reading Value : " . $GasCountReadingValueCurrent; ####### Check whether Initial readings needs to be written ### Check whether the current value is the first one after change of day = First one after midnight Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadTimeCurHour : " . $GasCountReadingTimestampCurrentHour; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadTimePrevHour : " . $GasCountReadingTimestampPreviousHour; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - LastUpdateTimestampUnix : " . ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_LastUpdateTimestampUnix", undef); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadTimeRelDelta : " . $GasCountReadingLastChangeDelta; if (($GasCountReadingTimestampCurrentHour < $GasCountReadingTimestampPreviousHour) || ($GasCountReadingLastChangeDelta > 86400)) { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - First reading of day detected OR last reading is older than 24h!"; ### Calculate gas energy of previous day € = (Vprevious[cubic] - V1stDay[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyDayLast = ($GasCountReadingValuePrevious - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stDay", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate pure gas cost of previous day GasCalcEnergyLastDay * Price per kWh my $GasCalcEnergyCostDayLast = $GasCalcEnergyDayLast * $attr{$GasCalcName}{GasPricePerKWh}; ### Reload last Power Value my $GasCalcPowerCurrent = ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerCurrent", "0"); ### Save gas pure cost of previous day, current gas Energy as first reading of day = first after midnight and reset min, max value, value counter and value sum readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostDayLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostDayLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyDayLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyDayLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stDay", $GasCountReadingValueCurrent , 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastDay", $GasCountReadingValuePrevious , 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_PowerDaySum", 0 , 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_PowerDayCount", 0 , 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerDayMin", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerCurrent ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerDayMax", 0 , 1); ### Check whether the current value is the first one after change of month if ($GasCountReadingTimestampCurrentMday < $GasCountReadingTimestampPreviousMday) { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - First reading of month detected"; ### Calculate gas energy of previous month € = (Vprevious[cubic] - V1stReadMonth[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyMonthLast = ($GasCountReadingValuePrevious - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stMonth", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate pure gas cost of previous month GasCalcEnergyLastMonth * Price per kWh my $GasCalcEnergyCostMonthLast = $GasCalcEnergyMonthLast * $attr{$GasCalcName}{GasPricePerKWh}; ### Save gas energy and pure cost of previous and current month readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostMonthLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostMonthLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyMonthLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyMonthLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stMonth", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastMonth", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValuePrevious ))), 1); ### Check whether the current value is the first one of the meter-reading month if ($GasCountReadingTimestampCurrentMon eq $attr{$GasCalcName}{MonthOfAnnualReading}) { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - First reading of month for meter reading detected"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Current month is : " . $GasCountReadingTimestampCurrentMon; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Attribute MonthOfAnnualReading is : " . $attr{$GasCalcName}{MonthOfAnnualReading}; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Vol1stMeter is : " . $GasCountReadingValueCurrent; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - VolLastMeter is : " . $GasCountReadingValuePrevious; ### Calculate gas energy of previous meter reading year € = (Vprevious[cubic] - V1stMeter[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyMeterLast = ($GasCountReadingValuePrevious - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stMeter", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate pure gas cost of previous meter reading year € = GasCalcEnergyLastMeter * Price per kWh my $GasCalcEnergyCostMeterLast = $GasCalcEnergyMeterLast * $attr{$GasCalcName}{GasPricePerKWh}; ### Save gas energy and pure cost of previous and current meter year readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostMeterLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostMeterLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyMeterLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyMeterLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stMeter", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastMeter", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValuePrevious ))), 1); } ### Check whether the current value is the first one of the calendar year if ($GasCountReadingTimestampCurrentYear > $GasCountReadingTimestampPreviousYear) { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - First reading of calendar year detected"; ### Calculate gas energy of previous calendar year € = (Vcurrent[cubic] - V1stYear[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyYearLast = ($GasCountReadingValuePrevious - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stYear", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate pure gas cost of previous calendar year € = GasCalcEnergyLastYear * Price per kWh my $GasCalcEnergyCostYearLast = $GasCalcEnergyYearLast * $attr{$GasCalcName}{GasPricePerKWh}; ### Save gas energy and pure cost of previous and current calendar year readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostYearLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostYearLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyYearLast", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyYearLast ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Vol1stYear", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent ))), 1); readingsSingleUpdate( $GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_VolLastYear", (sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValuePrevious ))), 1); } } } ###### Do calculations ### Calculate DtCurrent (time difference) of previous and current timestamp / [s] my $GasCountReadingTimestampDelta = $GasCountReadingTimestampCurrentRelative - $GasCountReadingTimestampPreviousRelative; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadingTimestampDelta : " . $GasCountReadingTimestampDelta . " s"; ### Continue with calculations only if time difference is not 0 to avoid "Illegal division by zero" if ($GasCountReadingTimestampDelta > 0) { ### Calculate DV (Volume difference) of previous and current value / [cubic] my $GasCountReadingValueDelta = sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent )) - sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValuePrevious)); Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadingValueDelta : " . $GasCountReadingValueDelta . " " . $attr{$GasCalcName}{Volume}; ### If the value has been changed since the last one if ($GasCountReadingValueDelta > 0) { ### Save current Timestamp as UNIX epoch into hash if the readingsSingleUpdate($GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_LastUpdateTimestampUnix", $GasCountReadingTimestampCurrentRelative, 0); } ### Calculate Current Power P = DV/Dt[cubic/s] * GaszValue * GasNominalHeatingValue[kWh/cubic] * 3600[s/h] / SiPrefixPowerFactor my $GasCalcPowerCurrent = ($GasCountReadingValueDelta / $GasCountReadingTimestampDelta) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue} * 3600 / $GasCalcDev->{system}{SiPrefixPowerFactor}; ### Calculate daily sum of power measurements "SP" and measurement counts "n" and then calculate average Power "Paverage = SP/n" my $GasCalcPowerDaySum = ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_PowerDaySum", "0") + $GasCalcPowerCurrent; my $GasCalcPowerDayCount = ReadingsVal($GasCalcReadingDestinationDeviceName, "." . $GasCalcReadingPrefix . "_PowerDayCount", "0") + 1; my $GasCalcPowerDayAverage = $GasCalcPowerDaySum / $GasCalcPowerDayCount; ### Calculate consumed Energy of current day W = (Vcurrent[cubic] - V1stReadDay[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyDay = ($GasCountReadingValueCurrent - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stDay", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate consumed Energy of current month W = (Vcurrent[cubic] - V1stReadMonth[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyMonth = ($GasCountReadingValueCurrent - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stMonth", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate consumed Energy of current year W = (Vcurrent[cubic] - V1stReadYear[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyYear = ($GasCountReadingValueCurrent - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stYear", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate consumed Energy of gas-meter year W = (Vcurrent[cubic] - V1stReadMeter[cubic]) * GaszValue * GasNominalHeatingValue[kWh/cubic] my $GasCalcEnergyMeter = ($GasCountReadingValueCurrent - ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_Vol1stMeter", "0")) * $attr{$GasCalcName}{GaszValue} * $attr{$GasCalcName}{GasNominalHeatingValue}; ### Calculate pure Electricity cost since midnight my $GasCalcEnergyCostDay = $GasCalcEnergyDay * $attr{$GasCalcName}{GasPricePerKWh}; ### Calculate pure gas cost since first day of month my $GasCalcEnergyCostMonth = $GasCalcEnergyMonth * $attr{$GasCalcName}{GasPricePerKWh}; ### Calculate pure gas cost since first day of calendar year my $GasCalcEnergyCostYear = $GasCalcEnergyYear * $attr{$GasCalcName}{GasPricePerKWh}; ### Calculate pure gas cost since first day of gas meter reading year my $GasCalcEnergyCostMeter = $GasCalcEnergyMeter * $attr{$GasCalcName}{GasPricePerKWh}; ### Calculate the payment month since the year of gas meter reading started my $GasCalcMeterYearMonth=0; if (($GasCountReadingTimestampCurrentMon - $attr{$GasCalcName}{MonthOfAnnualReading} + 1) < 1) { $GasCalcMeterYearMonth = 13 + $GasCountReadingTimestampCurrentMon - $attr{$GasCalcName}{MonthOfAnnualReading}; } else { $GasCalcMeterYearMonth = 1 + $GasCountReadingTimestampCurrentMon - $attr{$GasCalcName}{MonthOfAnnualReading}; } ### Calculate reserves at gas provider based on monthly advance payments within year of gas meter reading my $GasCalcReserves = ($GasCalcMeterYearMonth * $attr{$GasCalcName}{MonthlyPayment}) - ($attr{$GasCalcName}{BasicPricePerAnnum} / 12 * $GasCalcMeterYearMonth) - $GasCalcEnergyCostMeter; ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - _______Finance________________________________________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Monthly Payment : " . $attr{$GasCalcName}{MonthlyPayment} . " " . $attr{$GasCalcName}{Currency}; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Basic price per annum : " . $attr{$GasCalcName}{BasicPricePerAnnum} . " " . $attr{$GasCalcName}{Currency}; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcEnergyCostMeter : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostMeter)) . " " . $attr{$GasCalcName}{Currency}; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcReserves : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcReserves)) . " " . $attr{$GasCalcName}{Currency}; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - _______Times__________________________________________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcMeterYearMonth : " . $GasCalcMeterYearMonth; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - Current Month : " . $GasCountReadingTimestampCurrentMon; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - _______Energy_________________________________________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcEnergyDay : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyDay)) . " kWh"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcEnergyMonth : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyMonth)) . " kWh"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcEnergyYear : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyYear)) . " kWh"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcEnergyMeter : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyMeter)) . " kWh"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - _______Power___________________________________________"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcPowerCurrent : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerCurrent)) . " kW"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcPowerDayMin : " . ReadingsVal( $GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerDayMin", 0) . " kW"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcPowerDayAverage : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerDayAverage)) . " kW"; Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCalcPowerDayMax : " . ReadingsVal( $GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerDayMax", 0) . " kW"; ###### Write readings to GasCalc device ### Initialize Bulkupdate readingsBeginUpdate($GasCalcReadingDestinationDevice); ### Write consumed volume (DV) since last measurement readingsBulkUpdate($GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_LastDV", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueDelta))); ### Write timelap (Dt) since last measurement readingsBulkUpdate($GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_LastDt", sprintf('%.0f', ($GasCountReadingTimestampDelta))); ### Write current Power = average Power over last measurement period readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerCurrent", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerCurrent))); ### Write daily Power = average Power since midnight readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerDayAver", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerDayAverage))); ### Write Power measurement sum since midnight for average calculation readingsBulkUpdate($GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_PowerDaySum", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerDaySum))); ### Write Power measurement counts since midnight for average calculation readingsBulkUpdate($GasCalcReadingDestinationDevice, "." . $GasCalcReadingPrefix . "_PowerDayCount", sprintf('%.0f', ($GasCalcPowerDayCount))); ### Detect new daily minimum power value and write to reading if (ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerDayMin", 0) > $GasCalcPowerCurrent) { ### Write new minimum Power value readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerDayMin", sprintf('%.0f', ($GasCalcPowerCurrent))); ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - New daily minimum power value detected : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerCurrent)); } ### Detect new daily maximum power value and write to reading if (ReadingsVal($GasCalcReadingDestinationDeviceName, $GasCalcReadingPrefix . "_PowerDayMax", 0) < $GasCalcPowerCurrent) { ### Write new maximum Power value readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_PowerDayMax", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerCurrent))); ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - New daily maximum power value detected : " . sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcPowerCurrent)); } ### Write energy consumption since midnight readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyDay", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyDay))); ### Write energy consumption since beginning of month readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyMonth", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyMonth))); ### Write energy consumption since beginning of year readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyYear", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyYear))); ### Write energy consumption since last meter reading readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyMeter", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyMeter))); ### Write pure energy costs since midnight readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostDay", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostDay))); ### Write pure energy costs since beginning of month readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostMonth", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostMonth))); ### Write pure energy costs since beginning of calendar year readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostYear", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostYear))); ### Write pure energy costs since beginning of year of gas meter reading readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_EnergyCostMeter", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcEnergyCostMeter))); ### Write reserves at gas provider based on monthly advance payments within year of gas meter reading readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_FinanceReserve", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCalcReserves))); ### Write current mechanic meter reading readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_Meter", sprintf($GasCalcDev->{system}{DecimalPlace}, ($GasCountReadingValueCurrent))); ### Write months since last meter reading readingsBulkUpdate($GasCalcReadingDestinationDevice, $GasCalcReadingPrefix . "_MonthMeterReading", sprintf('%.0f', ($GasCalcMeterYearMonth))); ### Finish and execute Bulkupdate readingsEndUpdate($GasCalcReadingDestinationDevice, 1); } else { ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - GasCountReadingTimestampDelta = $GasCountReadingTimestampDelta. Calculations skipped!"; } ### Create Log entries for debugging Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator End_________________________________________________________________________________________________________________________________"; } ### If readings exist, update list of available readings if($GasCalcDev->{READINGS}) { ### Copy readings in list of available "gets" and "sets" %GasCalculator_gets = %{$GasCalcDev->{READINGS}}; %GasCalculator_sets = %{$GasCalcDev->{READINGS}}; ### Create Log entries for debugging #Log3 $GasCalcName, 5, $GasCalcName. " : GasCalculator - notify x_sets list: " . join(" ", (keys %GasCalculator_sets)); } return undef; } ####END####### Calculate gas meter values on changed events ####################################################END##### 1; ###START###### Description for fhem commandref ################################################################START#### =pod =item helper =item summary Calculates the gas energy consumption and costs =item summary_DE Berechnet den Gas-Energieverbrauch und verbundene Kosten =begin html

GasCalculator

    The GasCalculator Module calculates the gas consumption and costs of one ore more gas counters.
    It is not a counter module itself but requires a regular expression (regex or regexp) in order to know where to retrieve the continously increasing counter value of one or more mechanical gas counter.

    As soon the module has been defined within the fhem.cfg, the module reacts on every event of the specified counter like myOWDEVICE:counter.* etc.

    The GasCalculator module provides several current, historical, statistical predictable values around with respect to one or more gas-counter and creates respective readings.

    To avoid waiting for max. 12 months to have realistic values, the readings <DestinationDevice>_<SourceCounterReading>_Vol1stDay, <DestinationDevice>_<SourceCounterReading>_Vol1stMonth, <DestinationDevice>_<SourceCounterReading>_Vol1stYear and <DestinationDevice>_<SourceCounterReading>_Vol1stMeter must be corrected with real values by using the setreading - command. These real values may be found on the last gas bill. Otherwise it will take 24h for the daily, 30days for the monthly and up to 12 month for the yearly values to become realistic.

    Define
      define <name> GasCalculator <regex>
        <name> :
    		The name of the calculation device. Recommendation: "myGasCalculator".
        <regex> :
    		A valid regular expression (also known as regex or regexp) of the event where the counter can be found.
      Example: define myGasCalculator GasCalculator myGasCounter:countersA.*

    Set
      The set - function sets individual values for example to correct values after power loss etc.
      The set - function works for readings which have been stored in the CalculatorDevice and to update the Offset.
      The Readings being stored in the Counter - Device need to be changed individially with the set - command.
      The command "SyncCounter" will calculate and update the Offset. Just enter the value of your mechanical Reader.

    Get
      The get - function just returns the individual value of the reading.
      The get - function works only for readings which have been stored in the CalculatorDevice.
      The Readings being stored in the Counter - Device need to be read individially with get - command.

    Attributes
      If the below mentioned attributes have not been pre-defined completly beforehand, the program will create the GasCalculator specific attributes with default values.
      In addition the global attributes e.g. room can be used.
      • BasicPricePerAnnum : A valid float number for basic annual fee in the chosen currency for the gas supply to the home.
        The value is provided by your local gas provider is shown on your gas bill.
        For UK users it may known under "Standing Charge". Please make sure it is based on one year
        The default value is 0.00
      • Currency : One of the pre-defined list of currency symbols [€,£,$].
        The default value is €
      • disable : Disables the current module. The module will not react on any events described in the regular expression.
        The default value is 0 = enabled.
      • GasCounterOffset : A valid float number of the volume difference = offset (not the difference of the counter ticks!) between the value shown on the mechanic meter for the gas volume and the calculated volume of this device.
        The value for this offset will be calculated as follows VOffset = VMechanical - VModule
        The default value is 0.00
      • GasCubicPerCounts : A valid float number of the ammount of volume per ticks.
        The value is given by the mechanical trigger of the mechanical gas meter. E.g. GasCubicPerCounts = 0.01 means each count is a hundredth of the volume basis unit.
        The default value is 0.01
      • GasNominalHeatingValue : A valid float number for the gas heating value in [kWh/ chosen Volume].
        The value is provided by your local gas provider is shown on your gas bill.
        The default value is 10.00
      • GaszValue : A valid float number for the gas condition based on the local installation of the mechanical gas meter in relation of the gas providers main supply station.
        The value is provided by your local gas provider is shown on your gas bill.
        The default value is 1.00
      • GasPricePerKWh : A valid float number for gas price in the chosen currency per kWh for the gas.
        The value is provided by your local gas provider is shown on your gas bill.
        The default value is 0.0654
      • MonthlyPayment : A valid float number for monthly advance payments in the chosen currency towards the gas supplier.
        The default value is 0.00
      • MonthOfAnnualReading : A valid integer number for the month when the mechanical gas meter reading is performed every year.
        The default value is 5 (May)
      • ReadingDestination : One of the pre-defined list for the destination of the calculated readings: [CalculatorDevice,CounterDevice].
        The CalculatorDevice is the device which has been created with this module.
        The CounterDevice is the Device which is reading the mechanical gas-meter.
        The default value is CalculatorDevice - Therefore the readings will be written into this device.
      • Volume : One of the pre-defined list of volume symbols [m³,ft³].
        The default value is m³

    Readings
      As soon the device has been able to read at least 2 times the counter, it automatically will create a set readings:
      The placeholder <DestinationDevice> is the device which has been chosen in the attribute ReadingDestination above. This will not appear if CalculatorDevice has been chosen.
      The placeholder <SourceCounterReading> is the reading based on the defined regular expression.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostDayLast
    		: Energy costs of the last day.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMeter
    		: Energy costs in the chosen currency since the beginning of the month of where the last gas-meter reading has been performed by the gas supplier.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast
    		: Energy costs in the chosen currency of the last gas-meter period.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMonth
    		: Energy costs in the chosen currency since the beginning of the current month.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast
    		: Energy costs in the chosen currency of the last month.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostYear
    		: Energy costs in the chosen currency since the beginning of the current year.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast
    		: Energy costs of the last calendar year.
      • <DestinationDevice>_<SourceCounterReading>_EnergyDay
    		: Energy consumption in kWh since the beginning of the current day (midnight).
      • <DestinationDevice>_<SourceCounterReading>_EnergyDayLast
    		: Total Energy consumption in kWh of the last day.
      • <DestinationDevice>_<SourceCounterReading>_EnergyMeter
    		: Energy consumption in kWh since the beginning of the month of where the last gas-meter reading has been performed by the gas supplier.
      • <DestinationDevice>_<SourceCounterReading>_EnergyMeterLast
    		: Total Energy consumption in kWh of the last gas-meter reading period.
      • <DestinationDevice>_<SourceCounterReading>_EnergyMonth
    		: Energy consumption in kWh since the beginning of the current month (midnight of the first).
      • <DestinationDevice>_<SourceCounterReading>_EnergyMonthLast
    		: Total Energy consumption in kWh of the last month.
      • <DestinationDevice>_<SourceCounterReading>_EnergyYear
    		: Energy consumption in kWh since the beginning of the current year (midnight of the first).
      • <DestinationDevice>_<SourceCounterReading>_EnergyYearLast
    		: Total Energy consumption in kWh of the last calendar year.
      • <DestinationDevice>_<SourceCounterReading>_FinanceReserve
    		: Financial Reserver based on the advanced payments done on the first of every month towards the gas supplier. With negative values, an additional payment is to be excpected.
      • <DestinationDevice>_<SourceCounterReading>_MonthMeterReading
    		: Number of month since last meter reading. The month when the reading occured is the first month = 1.
      • <DestinationDevice>_<SourceCounterReading>_Meter
    		: Current indicated total volume consumption on mechanical gas meter. Correct Offset-attribute if not identical.
      • <DestinationDevice>_<SourceCounterReading>_PowerCurrent
    		: Current heating Power. (Average between current and previous measurement.)
      • <DestinationDevice>_<SourceCounterReading>_PowerDayAver
    		: Average heating Power since midnight.
      • <DestinationDevice>_<SourceCounterReading>_PowerDayMax
    		: Maximum power peak since midnight.
      • <DestinationDevice>_<SourceCounterReading>_PowerDayMin
    		: Minimum power peak since midnight.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stDay
    		: First volume reading of the current day.
      • <DestinationDevice>_<SourceCounterReading>_VolLastDay
    		: Volume reading of the previous day.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stMonth
    		: First volume reading of the current month.
      • <DestinationDevice>_<SourceCounterReading>_VolLastMonth
    		: Volume reading of the previous month.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stYear
    		: First volume reading of the current year.
      • <DestinationDevice>_<SourceCounterReading>_VolLastYear
    		: Volume reading of the previous year.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stMeter
    		: First volume reading of the first day of the month of the current meter reading period.
      • <DestinationDevice>_<SourceCounterReading>_VolLastMeter
    		: Volume reading of the first day of the month of the last meter reading period.
=end html =begin html_DE

GasCalculator

    Das GasCalculator Modul berechnet den Gas - Verbrauch und den verbundenen Kosten von einem oder mehreren Gas-Zählern.
    Es ist kein eigenes Zählermodul sondern benötigt eine Regular Expression (regex or regexp) um das Reading mit dem kontinuierlich wachsenden Zählerstand von einem oder mehreren Gaszählern zu finden.

    Sobald das Modul in der fhem.cfg definiert wurde, reagiert das Modul auf jedes durch das regex definierte event wie beispielsweise ein myOWDEVICE:counter.* etc.

    Das GasCalculator Modul berechnet augenblickliche, historische statistische und vorhersehbare Werte von einem oder mehreren Gas-Zählern und erstellt die entsprechenden Readings.

    Um zu verhindern, dass man bis zu 12 Monate warten muss, bis alle Werte der Realität entsprechen, müssen die Readings <DestinationDevice>_<SourceCounterReading>_Vol1stDay, <DestinationDevice>_<SourceCounterReading>_Vol1stMonth, <DestinationDevice>_<SourceCounterReading>_Vol1stYear und <DestinationDevice>_<SourceCounterReading>_Vol1stMeter entsprechend mit dem setreading - Befehl korrigiert werden. Diese Werte findet man unter Umständen auf der letzten Gas-Rechnung. Andernfalls dauert es bis zu 24h für die täglichen, 30 Tage für die monatlichen und bis zu 12 Monate für die jährlichen Werte bis diese der Realität entsprechen.

    Define
      define <name> GasCalculator <regex>
        <name> :
    		Der Name dieses Berechnungs-Device. Empfehlung: "myGasCalculator".
        <regex> :
    		Eine gültige Regular Expression (regex or regexp) von dem Event wo der Zählerstand gefunden werden kann
      Beispiel: define myGasCalculator GasCalculator myGasCounter:countersA.*

    Set
      Die set - Funktion erlaubt individuelle Readings zu verändern um beispielsweise nach einem Stromausfall Werte zu korrigieren.
      Die set - Funktion funktioniert für Readings welche im CalculatorDevice gespeichert wurden und zum update des Offsets zwischen den Zählern.
      Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit set - Befehl gesetzt werden.
      Der Befehl "SyncCounter" errechnet und update den Offset. Hierbei einfach den Wert des mechanischen Zählers eingeben.

    Get
      Die get - Funktion liefert nur den Wert des jeweiligen Readings zurück.
      Die get - Funktion funktioniert nur für Readings welche im CalculatorDevice gespeichert wurden.
      Die Readings welche im Counter - Device gespeichert wurden, müssen individuell mit get - Befehl ausgelesen werden.

    Attributes
      Sollten die unten ausfeg&auuml;hrten Attribute bei der Definition eines entsprechenden Gerätes nicht gesetzt sein, so werden sie vom Modul mit Standard Werten automatisch gesetzt
      Zusätzlich können die globalen Attribute wie room verwendet werden.
      • BasicPricePerAnnum : Eine gültige float Zahl für die jährliche Grundgebühr in der gewählten Währung für die Gas-Versorgung zum End-Verbraucher.
        Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.
        der Standard Wert ist 0.00
      • Currency : Eines der vordefinerten Währungssymbole: [€,£,$].
        Der Standard Wert ist €

      • disable : Deaktiviert das devive. Das Modul wird nicht mehr auf die Events reagieren die durch die Regular Expression definiert wurde.
        Der Standard Wert ist 0 = ativiert.

      • GasCounterOffset : Eine gültige float-Zahl für den Volumen Unterschied = Offset (Nicht der Unterschied zwischen Zählimpulsen) zwischen dem am mechanischen Gaszähler und dem angezeigten Wert im Reading dieses Device.
        Der Offset-Wert wird wie folgt ermittelt: VOffset = VMechanisch - VModule
        Der Standard-Wert ist 0.00
      • GasCubicPerCounts : Eine gültige float-Zahl für die Menge an Zählimpulsen pro gewählter Volumen-Grundeinheit.
        Der Wert ist durch das mechanische Zählwerk des Gaszählers vorgegeben. GasCubicPerCounts = 0.01 bedeutet, dass jeder Zählimpuls ein hunderstel der gewählten Volumengrundeinheit.
        Der Standard-Wert ist 0.01
      • GasNominalHeatingValue : Eine gültige float-Zahl für den Heizwert des gelieferten Gases in [kWh/ gewählter Volumeneinheit].
        Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.
        Der Standard-Wert ist 10.00

      • GaszValue : Eine gültige float-Zahl für die Zustandszahl des Gases basierend auf der Installation des Gas-Zälers in Relation b zum Höhenunterschieds der Hauptversorgungsstation des Gas Zulieferers.
        Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.
        Der Standard-Wert ist 1.00

      • GasPricePerKWh : Eine gültige float-Zahl für den Gas Preis in der gewählten Währung pro kWh.
        Dieser Wert stammt vom Gas-Zulieferer und steht auf der Gas-Rechnung.
        Der Standard-Wert ist 0.0654

      • MonthlyPayment : Eine gültige float-Zahl für die monatlichen Abschlagszahlungen in der gewählten Währung an den Gas-Lieferanten.
        Der Standard-Wert ist 0.00

      • MonthOfAnnualReading : Eine gültige Ganz-Zahl für den Monat wenn der mechanische Gas-Zähler jedes Jahr durch den Gas-Lieferanten abgelesen wird.
        Der Standard-Wert ist 5 (Mai)

      • ReadingDestination : Eines der vordefinerten Device als Ziel der errechneten Readings: [CalculatorDevice,CounterDevice].
        Das CalculatorDevice ist das mit diesem Modul erstellte Device.
        Das CounterDevice ist das Device von welchem der mechanische Zähler ausgelesen wird.
        Der Standard-Wert ist CalculatorDevice.

      • Volume : Eine der vordefinierten Volumensymbole für die Volumeneinheit [m³,ft³].
        der Standard-Wert ist m³


    Readings
      Sobald das Device in der Lage war mindestens 2 Werte des Zählers einzulesen, werden automatisch die entsprechenden Readings erzeugt:
      Der Platzhalter <DestinationDevice> steht für das Device, welches man in dem Attribut ReadingDestination oben festgelegt hat. Dieser Platzhalter bleibt leer, sobald man dort CalculatorDevice ausgewählt hat.
      Der Platzhalter <SourceCounterReading> steht für das Reading welches mit der Regular Expression definiert wurde.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostLastDay
    		: Energiekosten in der gewählten Währung des letzten Tages.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMeter
    		: Energiekosten in der gewählten Währung seit Anfang des Monats wo der Gas-Versorger den Zähler abliest.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast
    		: Energiekosten in der gewählten Währung der letzten Zählperiode des Gas-Versorgers.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMonth
    		: Energiekosten in der gewählten Währung seit Anfang des Monats.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast
    		: Energiekosten in der gewählten Währung des letzten Monats.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostYear
    		: Energiekosten in der gewählten Währung seit Anfang des Jahres.
      • <DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast
    		: Energiekosten in der gewählten Währung des letzten Jahres.
      • <DestinationDevice>_<SourceCounterReading>_EnergyDay
    		: Energieverbrauch in kWh seit Mitternacht.
      • <DestinationDevice>_<SourceCounterReading>_EnergyDayLast
    		: Gesamter Energieverbrauch des letzten Tages (Gestern).
      • <DestinationDevice>_<SourceCounterReading>_EnergyMeter
    		: Energieverbrauch in kWh seit Anfang seit Anfang des Monats wo der Gas-Versorger den Zähler abliest.
      • <DestinationDevice>_<SourceCounterReading>_EnergyMeterLast
    		: Gesamter Energieverbrauch der letzten Zählerperiode des Gas-Versorgers.
      • <DestinationDevice>_<SourceCounterReading>_EnergyMonth
    		: Energieverbrauch in kWh seit Anfang seit Anfang des Monats (Mitternacht des 01.).
      • <DestinationDevice>_<SourceCounterReading>_EnergyMonthLast
    		: Gesamter Energieverbrauch im letzten Monat.
      • <DestinationDevice>_<SourceCounterReading>_EnergyYear
    		: Energieverbrauch in kWh seit Anfang seit Anfang des Jahres (Mitternacht des 01. Januar).
      • <DestinationDevice>_<SourceCounterReading>_EnergyYearLast
    		: Gesamter Energieverbrauch in kWh des letzten Kalender-Jahres.
      • <DestinationDevice>_<SourceCounterReading>_FinanceReserve
    		: Finanzielle Reserve basierend auf den Abschlagszahlungen die jeden Monat an den Gas-Versorger gezahlt werden. Bei negativen Werten ist von einer Nachzahlung auszugehen.
      • <DestinationDevice>_<SourceCounterReading>_MonthMeterReading
    		: Anzahl der Monate seit der letzten Zählerablesung. Der Monat der Zählerablesung ist der erste Monat = 1.
      • <DestinationDevice>_<SourceCounterReading>_Meter
    		: Zählerstand am Gaszähler. Bei Differenzen muss das Offset-Attribut korrigiert werden.
      • <DestinationDevice>_<SourceCounterReading>_PowerCurrent
    		: Aktuelle Heizleistung. (Mittelwert zwischen aktueller und letzter Messung)
      • <DestinationDevice>_<SourceCounterReading>_PowerDayAver
    		: Mittlere Heitzleistung seit Mitternacht.
      • <DestinationDevice>_<SourceCounterReading>_PowerDayMax
    		: Maximale Leistungsaufnahme seit Mitternacht.
      • <DestinationDevice>_<SourceCounterReading>_PowerDayMin
    		: Minimale Leistungsaufnahme seit Mitternacht.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stDay
    		: Erster Volumenmesswert des Tages (Mitternacht).
      • <DestinationDevice>_<SourceCounterReading>_VolLastDay
    		: Verbrauchtes Volumen des vorherigen Tages.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stMonth
    		: Erster Volumenmesswert des Monats (Mitternacht des 01.).
      • <DestinationDevice>_<SourceCounterReading>_VolLastMonth
    		: Verbrauchtes Volumen des vorherigen Monats.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stYear
    		: Erster Volumenmesswert des Jahres (Mitternacht des 01. Januar).
      • <DestinationDevice>_<SourceCounterReading>_VolLastYear
    		: Verbrauchtes Volumen des vorherigen Jahres.
      • <DestinationDevice>_<SourceCounterReading>_Vol1stMeter
    		: Erster Volumenmesswert des Zeitraums seit Anfang des Monats wo der Gas-Versorger den Zähler abliest.
      • <DestinationDevice>_<SourceCounterReading>_VolLastMeter
    		: Verbrauchtes Volumen des vorherigen Abrechnungszeitraums.
=end html_DE =for :application/json;q=META.json 73_GasCalculator.pm { "abstract": "Calculates the gas energy consumption and costs.", "description": "The GasCalculator Module calculates the gas consumption and costs of one ore more gas counters.
It is not a counter module itself but requires a regular expression (regex or regexp) in order to know where to retrieve the continously increasing counter value of one or more mechanical gas counter.
As soon the module has been defined within the fhem.cfg, the module reacts on every event of the specified counter like myOWDEVICE:counter.* etc.
The GasCalculator module provides several current, historical, statistical predictable values around with respect to one or more gas-counter and creates respective readings.
", "x_lang": { "de": { "abstract": "Berechnet den Gas-Energieverbrauch und verbundene Kosten", "description": "Das GasCalculator Modul berechnet den Gas - Verbrauch und den verbundenen Kosten von einem oder mehreren Gas-Zählern.
Es ist kein eigenes Zählermodul sondern benötigt eine Regular Expression (regex or regexp) um das Reading mit dem kontinuierlich wachsenden Zählerstand von einem oder mehreren Gaszählern zu finden.
Sobald das Modul in der fhem.cfg definiert wurde, reagiert das Modul auf jedes durch das regex definierte event wie beispielsweise ein myOWDEVICE:counter.* etc.
Das GasCalculator Modul berechnet augenblickliche, historische statistische und vorhersehbare Werte von einem oder mehreren Gas-Zählern und erstellt die entsprechenden Readings.
" } }, "author": [ "I am the maintainer matthias.deeke@deeke.eu" ], "x_fhem_maintainer": [ "Sailor" ], "keywords": [ "gas", "energy", "calculation", "consumption", "cost", "counter" ], "prereqs": { "runtime": { "requires": { "FHEM": 5.00918623, "FHEM::Meta": 0.001006, "HttpUtils": 0, "JSON": 0, "perl": 5.014 }, "recommends": { }, "suggests": { } } }, "resources": { "x_support_community": { "rss": "https://forum.fhem.de/index.php/topic,47909.msg", "web": "https://forum.fhem.de/index.php/topic,47909.msg", "subCommunity" : { "rss" : "https://forum.fhem.de/index.php/topic,47909.msg", "title" : "This sub-board will be first contact point", "web" : "https://forum.fhem.de/index.php/topic,47909.msg" } } }, "x_support_status": "supported" } =end :application/json;q=META.json =cut