The ElectricityCalculator Module calculates the electrical energy consumption and costs of one ore more electricity meters. It is not a counter module itself but it requires a regular expression (regex or regexp) in order to know where to retrieve the counting ticks of one or more mechanical or electronic electricity meter. 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 ElectricityCalculator module provides several current, historical, statistical values around with respect to one or more electricity meter and creates respective readings. To avoid waiting for max. 12 months to have realistic values, the readings <DestinationDevice>_<SourceCounterReading>_CounterDay1st ,<DestinationDevice>_<SourceCounterReading>_CounterMonth1st ,<DestinationDevice>_<SourceCounterReading>_CounterYear1st and<DestinationDevice>_<SourceCounterReading>_CounterMeter1st must be corrected with real values by using the setreading - command.These real values may be found on the last electricity 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. Intervalls smaller than 10s will be discarded to avoid peaks due to fhem blockages (e.g. DbLog - reducelog). |
Define |
define <name> ElectricityCalculator <regex> |
<name> : | The name of the calculation device. (E.g.: "myElectricityCalculator") |
<regex> : | A valid regular expression (also known as regex or regexp) of the event where the counter can be found |
define myElectricityCalculator ElectricityCalculator myElectricityCounter:countersA.* |
Attributes |
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 electricity supply to the home. The value is provided by your local electricity supplier and is shown on your electricity bill. For UK and US 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. |
ElectricityCounterOffset : | A valid float number of the electric Energy difference = offset (not the difference of the counter ticks!) between the value shown on the mechanic meter for the electric energy and the calculated electric energy of the counting device. The value for this offset will be calculated as follows WOffset = WMechanical - WModule The default value is 0.00 |
ElectricityKwhPerCounts : | A valid float number of electric energy in kWh per counting ticks. The value is given by the mechanical trigger of the mechanical electricity meter. E.g. ElectricityKwhPerCounts = 0.001 means each count is a thousandth of one kWh (=Wh). Some electronic counter (E.g. HomeMatic HM-ES-TX-WM) providing the counted electric energy as Wh. Therfore this attribute must be 0.001 in order to transform it correctly to kWh. The default value is 1 (= the counter is already providing kWh) |
ElectricityPricePerKWh : | A valid float number for electric energy price in the chosen currency per kWh. The value is provided by your local electricity supplier and is shown on your electricity bill. The default value is 0.2567 |
MonthlyPayment : | A valid float number for monthly advance payments in the chosen currency towards the electricity supplier. The default value is 0.00 |
MonthOfAnnualReading : | A valid integer number for the month when the mechanical electricity 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 Electricity-meter. The default value is CalculatorDevice - Therefore the readings will be written into this device. |
SiPrefixPower : | One value of the pre-defined list: W (Watt), kW (Kilowatt), MW (Megawatt) or GW (Gigawatt). It defines which SI-prefix for the power value shall be used. The power value will be divided accordingly by multiples of 1000. The default value is W (Watt). |
<DestinationDevice>_<SourceCounterReading>_CounterCurrent : | Current indicated total electric energy consumption as shown on mechanical electricity meter. Correct Offset-attribute if not identical. |
<DestinationDevice>_<SourceCounterReading>_CounterDay1st : | The first meter reading after midnight. |
<DestinationDevice>_<SourceCounterReading>_CounterDayLast : | The last meter reading of the previous day. |
<DestinationDevice>_<SourceCounterReading>_CounterMonth1st : | The first meter reading after midnight of the first day of the month. |
<DestinationDevice>_<SourceCounterReading>_CounterMonthLast : | The last meter reading of the previous month. |
<DestinationDevice>_<SourceCounterReading>_CounterMeter1st : | The first meter reading after midnight of the first day of the month where the mechanical meter is read by the electricity supplier. |
<DestinationDevice>_<SourceCounterReading>_CounterMeterLast : | The last meter reading of the previous meter reading year. |
<DestinationDevice>_<SourceCounterReading>_CounterYear1st : | The first meter reading after midnight of the first day of the year. |
<DestinationDevice>_<SourceCounterReading>_CounterYearLast : | The last meter reading of the previous year. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostDayLast : | Energy costs of the last day. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast : | Energy costs in the chosen currency of the last electricity meter period. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast : | Energy costs in the chosen currency of the last month. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast : | Energy costs of the last calendar year. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostDay : | Energy consumption in kWh since the beginning of the current day (midnight). |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMeter : | Energy costs in the chosen currency since the beginning of the month of where the last electricity meter reading has been performed by the electricity supplier. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMonth : | Energy costs in the chosen currency since the beginning of the current month. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostYear : | Energy costs in the chosen currency since the beginning of the current 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 electricity-meter reading has been performed by the Electricity supplier. |
<DestinationDevice>_<SourceCounterReading>_EnergyMeterLast : | Total Energy consumption in kWh of the last electricity-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 Reserve based on the advanced payments done on the first of every month towards the Electricity supplier. With negative values, an additional payment is to be expected. |
<DestinationDevice>_<SourceCounterReading>_MonthMeterReading : | Number of month since last meter reading. The month when the reading occured is the first month = 1. |
<DestinationDevice>_<SourceCounterReading>_PowerCurrent : | Current electric Power. (Average Power between current and previous measurement.) |
<DestinationDevice>_<SourceCounterReading>_PowerDayAver : | Average electric Power since midnight. |
<DestinationDevice>_<SourceCounterReading>_PowerDayMax : | Maximum Power peak since midnight. |
<DestinationDevice>_<SourceCounterReading>_PowerDayMin : | Minimum Power peak since midnight. |
Das ElectricityCalculator Modul berechnet den Verbrauch an elektrischer Energie (Stromverbrauch) und den verbundenen Kosten von einem oder mehreren Elektrizitätszählern. Es ist kein eigenes Zählermodul sondern benötigt eine Regular Expression (regex or regexp) um das Reading mit den Zählimpulse von einem oder mehreren Electrizitätszä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 ElectricityCalculator Modul berechnet augenblickliche, historische statistische und vorhersehbare Werte von einem oder mehreren Elektrizitätszä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>_CounterDay1st ,<DestinationDevice>_<SourceCounterReading>_CounterMonth1st ,<DestinationDevice>_<SourceCounterReading>_CounterYear1st und<DestinationDevice>_<SourceCounterReading>_CounterMeter1st entsprechend mit dem setreading - Befehl korrigiert werden.Diese Werte findet man unter Umständen auf der letzten Abrechnung des Elektrizitätsversorgers. 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. Intervalle kleienr als 10s werden ignoriert um Spitzen zu verhindern die von Blockaden des fhem Systems hervorgerufen werden (z.B. DbLog - reducelog). |
Define |
define <name> ElectricityCalculator <regex> |
<name> : | Der Name dieses Berechnungs-Device. Empfehlung: "myElectricityCalculator". |
<regex> : | Eine gültige Regular Expression (regex or regexp) von dem Event wo der Zählerstand gefunden werden kann |
define myElectricityCalculator ElectricityCalculator myElectricityCounter:countersA.* |
Attributes |
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 Elektrizitäts-Versorgung zum Endverbraucher. Dieser Wert stammt vom Elektrizitätsversorger und steht auf der Abrechnung. Der Standard Wert ist 0.00 |
Currency : | Eines der vordefinerten Währungssymbole: [€,£,$]. Der Standard Wert ist € |
disable : | Deaktiviert das device. Das Modul wird nicht mehr auf die Events reagieren die durch die Regular Expression definiert wurde. Der Standard Wert ist 0 = aktiviert. |
ElectricityCounterOffset : | Eine gültige float-Zahl für den Unterschied = Offset (Nicht der Unterschied zwischen Zählimpulsen) zwischen dem am mechanischen Elektrizitätszählern und dem angezeigten Wert im Reading dieses Device. Der Offset-Wert wird wie folgt ermittelt: WOffset = WMechanisch - WModule Der Standard-Wert ist 0.00 |
ElectricityKwhPerCounts : | Eine gültige float-Zahl für die Menge kWh pro Zählimpulsen. Der Wert ist durch das mechanische Zählwerk des Elektrizitätszählern vorgegeben. ElectricityKwhPerCounts = 0.001 bedeutet, dass jeder Zählimpuls ein Tausendstel einer kWh ist (=Wh). Einige elektronische Zähler (Bsp.: HomeMatic HM-ES-TX-WM) stellen die gezählte Menge an elektrischer Energie als Wh bereit. Aus diesem Grund muss dieses Attribut auf 0.001 gesetzt werden um eine korrekte Transformation in kWh zu ermöglichen. Der Standard-Wert ist 1 |
ElectricityPricePerKWh : | Eine gültige float-Zahl für den Preis pro kWh. Dieser Wert stammt vom Elektrizitätsversorger und steht auf der Abrechnung. Der Standard-Wert ist 0.2567 |
MonthlyPayment : | Eine gültige float-Zahl für die monatlichen Abschlagszahlungen in der gewählten Währung an den Elektrizitätsversorger. Der Standard-Wert ist 0.00 |
MonthOfAnnualReading : | Eine gültige Ganz-Zahl für den Monat wenn der mechanische Elektrizitätszähler jedes Jahr durch den Elektrizitätsversorger 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. |
SiPrefixPower : | Ein Wert der vorgegebenen Auswahlliste: W (Watt), kW (Kilowatt), MW (Megawatt) or GW (Gigawatt). Es definiert welcher SI-Prefix verwendet werden soll und teilt die Leistung entsprechend durch ein Vielfaches von 1000. Der Standard-Wert ist W (Watt). |
<DestinationDevice>_<SourceCounterReading>_CounterCurrent : | Aktueller Zählerstand am mechanischen Zähler. Bei Unterschied muss das Offset-Attribut entspechend korrigiert werden. |
<DestinationDevice>_<SourceCounterReading>_CounterDay1st : | Der erste Zählerstand des laufenden Tages seit Mitternacht. |
<DestinationDevice>_<SourceCounterReading>_CounterDayLast : | Der letzte Zählerstand des vorherigen Tages. |
<DestinationDevice>_<SourceCounterReading>_CounterMeter1st : | Der erste Zählerstand seit Mitternacht des ersten Tages der laufenden Ableseperiode. |
<DestinationDevice>_<SourceCounterReading>_CounterMeterLast : | Der letzte Zählerstand seit Mitternacht des ersten Tages der vorherigen Ableseperiode. |
<DestinationDevice>_<SourceCounterReading>_CounterMonth1st : | Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Monats. |
<DestinationDevice>_<SourceCounterReading>_CounterMonthLast : | Der letzte Zählerstand des vorherigen Monats. |
<DestinationDevice>_<SourceCounterReading>_CounterYear1st : | Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Jahres. |
<DestinationDevice>_<SourceCounterReading>_CounterYearLast : | Der letzte Zählerstand des letzten Jahres. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostDayLast : | Elektrische Energiekosten des letzten Tages. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast : | Elektrische Energiekosten der letzten Ableseperiode. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast : | Elektrische Energiekosten des letzten Monats. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast : | Elektrische Energiekosten des letzten Kalenderjahres. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostDay : | Energiekosten in gewählter Währung seit Mitternacht des laufenden Tages. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMeter : | Energiekosten in gewählter Währung seit Beginn der laufenden Ableseperiode. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostMonth : | Energiekosten in gewählter Währung seit Beginn des laufenden Monats. |
<DestinationDevice>_<SourceCounterReading>_EnergyCostYear : | Energiekosten in gewählter Währung seit Beginn des laufenden Kalenderjahres. |
<DestinationDevice>_<SourceCounterReading>_EnergyDay : | Energieverbrauch seit Beginn der aktuellen Tages (Mitternacht). |
<DestinationDevice>_<SourceCounterReading>_EnergyDayLast : | Energieverbrauch in kWh des vorherigen Tages. |
<DestinationDevice>_<SourceCounterReading>_EnergyMeter : | Energieverbrauch seit Beginn der aktuellen Ableseperiode. |
<DestinationDevice>_<SourceCounterReading>_EnergyMeterLast : | Energieverbrauch in kWh der vorherigen Ableseperiode. |
<DestinationDevice>_<SourceCounterReading>_EnergyMonth : | Energieverbrauch seit Beginn des aktuellen Monats. |
<DestinationDevice>_<SourceCounterReading>_EnergyMonthLast : | Energieverbrauch in kWh des vorherigen Monats. |
<DestinationDevice>_<SourceCounterReading>_EnergyYear : | Energieverbrauch seit Beginn des aktuellen Kalenderjahres. |
<DestinationDevice>_<SourceCounterReading>_EnergyYearLast : | Energieverbrauch in kWh des vorherigen Kalenderjahres. |
<DestinationDevice>_<SourceCounterReading>_FinanceReserve : | Finanzielle Reserve basierend auf den Abschlagszahlungen die jeden Monat an den Elektrizitätsversorger 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>_PowerCurrent : | Aktuelle elektrische Leistung. (Mittelwert zwischen aktueller und letzter Messung) |
<DestinationDevice>_<SourceCounterReading>_PowerDayAver : | Mittlere elektrische Leistung seit Mitternacht. |
<DestinationDevice>_<SourceCounterReading>_PowerDayMax : | Maximale elektrische Leistungsaufnahme seit Mitternacht. |
<DestinationDevice>_<SourceCounterReading>_PowerDayMin : | Minimale elektrische Leistungsaufnahme seit Mitternacht. |