mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-01 01:09:47 +00:00
98_statistics: update commandref to id format
git-svn-id: https://svn.fhem.de/fhem/trunk@26211 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
Beta-User
parent
337631ebe5
commit
fe3612042c
@ -1167,13 +1167,15 @@ sub statistics_UpdateDevReading($$$$)
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=pod
|
||||
=item summary Calculates statistical values and adds them to the devices.
|
||||
=item summary_DE Berechnet statistische Werte und fügt sie dem Gerät hinzu.
|
||||
=item helper
|
||||
=begin html
|
||||
|
||||
<a name="statistics"></a>
|
||||
<a id="statistics"></a>
|
||||
<h3>statistics</h3>
|
||||
<div>
|
||||
<ul>
|
||||
@ -1207,12 +1209,10 @@ sub statistics_UpdateDevReading($$$$)
|
||||
</ul>
|
||||
Further readings can be added via the <a href="#statisticsattr">attributes</a> <code>deltaReadings, durationReadings, minAvgMaxReadings, tendencyReadings</code>.
|
||||
This allows also to assign a reading to another statistic type.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<b>Define</b>
|
||||
<a id="statistics-define"></a>
|
||||
<h4>Define</h4>
|
||||
<ul>
|
||||
<br>
|
||||
<code>define <name> statistics <deviceNameRegExp> [Prefix]</code>
|
||||
<br>
|
||||
Example: <code>define Statistik statistics Sensor_.*|Wettersensor</code>
|
||||
@ -1224,77 +1224,73 @@ sub statistics_UpdateDevReading($$$$)
|
||||
<li><code>[Prefix]</code>
|
||||
<br>
|
||||
Optional. Prefix set is place before statistical data. Default is <i>stat</i>
|
||||
</li><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
<b>Set</b>
|
||||
<a id="statistics-set"></a>
|
||||
<h4>Set</h4>
|
||||
<ul>
|
||||
<br>
|
||||
<li><code>resetStatistics <All|DeviceName></code>
|
||||
<a id="statistics-set-resetStatistics"></a><li><code>resetStatistics <All|DeviceName></code>
|
||||
<br>
|
||||
Resets the statistic values of the selected device.
|
||||
</li><br>
|
||||
<li><code>doStatistics</code>
|
||||
<a id="statistics-set-doStatistics"></a><li><code>doStatistics</code>
|
||||
<br>
|
||||
Calculates the current statistic values of all monitored devices.
|
||||
</li><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
<b>Get</b>
|
||||
<a id="statistics-get"></a>
|
||||
<h4>Get</h4>
|
||||
<ul>not implemented yet
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
<a name="statisticsattr"></a>
|
||||
<b>Attributes</b>
|
||||
<a id="statistics-attr"></a>
|
||||
<h4>Attributes</h4>
|
||||
<ul>
|
||||
<br>
|
||||
<li><code>dayChangeTime <time></code>
|
||||
<a id="statistics-attr-dayChangeTime"></a><li><code>dayChangeTime <time></code>
|
||||
<br>
|
||||
Time of day change. Default is 00:00. For weather data the day change can be set e.g. to 06:50.
|
||||
</li><br>
|
||||
<li><code>deltaReadings <readings></code>
|
||||
<a id="statistics-attr-deltaReadings"></a><li><code>deltaReadings <readings></code>
|
||||
<br>
|
||||
Comma separated list of reading names for which a delta statistic shall be calculated.
|
||||
</li><br>
|
||||
<li><code>durationPeriodHour < 1 | 0 ></code>
|
||||
<a id="statistics-attr-durationPeriodHour"></a><li><code>durationPeriodHour < 1 | 0 ></code>
|
||||
<br>
|
||||
If set to 1, then duration readings will get hourly statistics too.
|
||||
</li><br>
|
||||
<li><code>durationReadings <readings></code>
|
||||
<a id="statistics-attr-durationReadings"></a><li><code>durationReadings <readings></code>
|
||||
<br>
|
||||
Comma separated list of reading names for which a duration statistic shall be calculated.
|
||||
</li><br>
|
||||
<li><code>excludedReadings <DeviceRegExp:ReadingNameRegExp></code>
|
||||
<a id="statistics-attr-excludedReadings"></a><li><code>excludedReadings <DeviceRegExp:ReadingNameRegExp></code>
|
||||
<br>
|
||||
Regular expression of the readings that shall be excluded from the statistics.<br>
|
||||
The reading have to be entered in the form <i>deviceName:readingName</i>.
|
||||
<br>
|
||||
E.g. <code>FritzDect:current|Sensor_.*:humidity</code>
|
||||
<br>
|
||||
</li><br>
|
||||
</li>
|
||||
|
||||
<li><code>ignoreDefaultAssignments <code>< 0 | 1 ></code></code>
|
||||
<a id="statistics-attr-ignoreDefaultAssignments"></a><li><code>ignoreDefaultAssignments <code>< 0 | 1 ></code></code>
|
||||
<br>
|
||||
Ignores the default assignments of readings to a statistic type (see above).<br>
|
||||
So, only the readings that are listed in the specific attributes are evaluated.
|
||||
<br>
|
||||
</li><br>
|
||||
|
||||
<li><code>minAvgMaxReadings <readings></code>
|
||||
<a id="statistics-attr-minAvgMaxReadings"></a><li><code>minAvgMaxReadings <readings></code>
|
||||
<br>
|
||||
Comma separated list of reading names for which a min/average/max statistic shall be calculated.
|
||||
</li><br>
|
||||
<li><code>periodChangePreset <seconds></code>
|
||||
<a id="statistics-attr-periodChangePreset"></a><li><code>periodChangePreset <seconds></code>
|
||||
<br>
|
||||
Preponed start of the calculation of periodical data. Default is 5 second before each full hour.
|
||||
<br>
|
||||
Allows thus the correct timely assignment within plots. Should be adapted to the CPU speed or load of the server.
|
||||
<br>
|
||||
</li><br>
|
||||
<li><code>singularReadings <DeviceRegExp:ReadingRegExp>:statTypes:period</code>
|
||||
<a id="statistics-attr-singularReadings"></a><li><code>singularReadings <DeviceRegExp:ReadingRegExp>:statTypes:period</code>
|
||||
<ul>
|
||||
<li>statTypes: Min|Avg|Max|Delta|<i>DurationState</i>|<span style="color:blue;">Tendency</span></li>
|
||||
<li>period: Hour|Day|Month|Year|<span style="color:blue;">1h|2h|3h|6h</span></li>
|
||||
@ -1308,7 +1304,7 @@ sub statistics_UpdateDevReading($$$$)
|
||||
<code>Badfenster:Window:(Open|Open_Count):Month</code>
|
||||
</dd>
|
||||
</li><br>
|
||||
<li><code>specialDeltaPeriods <Device:Reading:Period:count1:count2:...></code>
|
||||
<a id="statistics-attr-specialDeltaPeriods"></a><li><code>specialDeltaPeriods <Device:Reading:Period:count1:count2:...></code>
|
||||
<br>
|
||||
Creates for the given delta reading additional singular readings of the given numbers of a period (Hour, Day, Month)
|
||||
<br>
|
||||
@ -1324,12 +1320,12 @@ sub statistics_UpdateDevReading($$$$)
|
||||
<br>
|
||||
This will create 4 additional readings for the rain of the last 48 hours and the last 30 Days and the energy consumtion of the last 6 and 12 months.
|
||||
</dd>
|
||||
</li><br>
|
||||
<li><code>specialDeltaPeriodHours</code>
|
||||
</li><br>
|
||||
<a id="statistics-attr-specialDeltaPeriodHours"></a><li><code>specialDeltaPeriodHours</code>
|
||||
<br>
|
||||
depreciated
|
||||
</li><br>
|
||||
<li><code>tendencyReadings <readings></code>
|
||||
</li><br>
|
||||
<a id="statistics-attr-tendencyReadings"></a><li><code>tendencyReadings <readings></code>
|
||||
<br>
|
||||
Comma separated list of reading names for which a tendendy statistic shall be calculated.
|
||||
</li><br>
|
||||
@ -1340,7 +1336,7 @@ sub statistics_UpdateDevReading($$$$)
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="statistics"></a>
|
||||
<a id="statistics"></a>
|
||||
<h3>statistics</h3>
|
||||
<div>
|
||||
<ul>
|
||||
@ -1373,12 +1369,10 @@ sub statistics_UpdateDevReading($$$$)
|
||||
</li><br>
|
||||
</ul>
|
||||
Über die <a href="#statisticsattr">Attribute</a> <code>deltaReadings, durationReadings, minAvgMaxReadings, tendencyReadings</code> können weitere Gerätewerte hinzugefügt oder einem anderen Statistik-Typ zugeordnet werden.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<b>Define</b>
|
||||
<a id="statistics-define"></a>
|
||||
<h4>Define</h4>
|
||||
<ul>
|
||||
<br>
|
||||
<code>define <Name> statistics <GeräteNameRegExp> [Prefix]</code>
|
||||
<br>
|
||||
Beispiel: <code>define Statistik statistics Wettersensor|Badsensor</code>
|
||||
@ -1390,57 +1384,54 @@ sub statistics_UpdateDevReading($$$$)
|
||||
<li><code>[Prefix]</code>
|
||||
<br>
|
||||
Optional. Der Prefix wird vor den Namen der statistischen Gerätewerte gesetzt. Standardmäßig <i>stat</i>
|
||||
</li><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<br>
|
||||
<b>Set</b>
|
||||
<a id="statistics-set"></a>
|
||||
<h4>Set</h4>
|
||||
<ul>
|
||||
<br>
|
||||
<li><code>resetStatistics <All|Gerätename></code>
|
||||
<a id="statistics-set-resetStatistics"></a><li><code>resetStatistics <All|Gerätename></code>
|
||||
<br>
|
||||
Setzt die Statistiken der ausgewählten Geräte zurück.
|
||||
</li><br>
|
||||
<li><code>doStatistics</code>
|
||||
<br>
|
||||
Berechnet die aktuellen Statistiken aller beobachteten Geräte.
|
||||
</li><br>
|
||||
</li>
|
||||
</ul>
|
||||
<br>
|
||||
|
||||
<b>Get</b>
|
||||
<ul>nicht implementiert
|
||||
</ul>
|
||||
<br>
|
||||
<a id="statistics-get"></a>
|
||||
<h4>Get</h4>
|
||||
<ul>nicht implementiert
|
||||
</ul>
|
||||
|
||||
<a name="statisticsattr"></a>
|
||||
<b>Attributes</b>
|
||||
<a id="statistics-attr"></a>
|
||||
<h4>Attribute</h4>
|
||||
<ul>
|
||||
<br>
|
||||
<li><code>dayChangeTime <Zeit></code>
|
||||
<a id="statistics-attr-dayChangeTime"></a><li><code>dayChangeTime <Zeit></code>
|
||||
<br>
|
||||
Uhrzeit des Tageswechsels. Standardmäßig 00:00. Bei Wetterdaten kann der Tageswechsel z.B. auf 6:50 gesetzt werden.
|
||||
</li><br>
|
||||
<li><code>deltaReadings <Gerätewerte></code>
|
||||
<a id="statistics-attr-deltaReadings"></a><li><code>deltaReadings <Gerätewerte></code>
|
||||
<br>
|
||||
Durch Kommas getrennte Liste von weiteren Gerätewerten, für welche die Differenz zwischen den Werten am Anfang und Ende einer Periode (Stunde/Tag/Monat/Jahr) bestimmt wird.
|
||||
</li><br>
|
||||
<li><code>durationPeriodHour < 1 | 0 ></code>
|
||||
<a id="statistics-attr-durationPeriodHour"></a><li><code>durationPeriodHour < 1 | 0 ></code>
|
||||
<br>
|
||||
Wenn auf 1 gesetzt, dann werden für "durationReadings" auch stündliche Statistiken gebildet.
|
||||
</li><br>
|
||||
<li><code>durationReadings <Gerätewerte></code>
|
||||
<a id="statistics-attr-durationReadings"></a><li><code>durationReadings <Gerätewerte></code>
|
||||
<br>
|
||||
Durch Kommas getrennte Liste von weiteren Gerätewerten, für welche die Dauer einzelner Gerätewerte innerhalb bestimmte Zeiträume (Stunde/Tag/Monat/Jahr) erfasst wird.
|
||||
</li><br>
|
||||
<li><code>excludedReadings <GerätenameRegExp:GerätewertRegExp></code>
|
||||
<a id="statistics-attr-excludedReadings"></a><li><code>excludedReadings <GerätenameRegExp:GerätewertRegExp></code>
|
||||
<br>
|
||||
Regulärer Ausdruck der Gerätewerte die nicht ausgewertet werden sollen.
|
||||
z.B. <code>FritzDect:current|Sensor_.*:humidity</code>
|
||||
<br>
|
||||
</li><br>
|
||||
|
||||
<li><code>ignoreDefaultAssignments <code><0 | 1></code></code>
|
||||
<a id="statistics-attr-ignoreDefaultAssignments"></a><li><code>ignoreDefaultAssignments <code><0 | 1></code></code>
|
||||
<br>
|
||||
Ignoriert die Standardzuordnung von Gerätewerten zu Statistik-Typen..<br>
|
||||
D.h., nur die Gerätewerte, die über Attribute den Statistik-Typen zugeordnet sind, werden ausgewertet.
|
||||
@ -1451,18 +1442,18 @@ sub statistics_UpdateDevReading($$$$)
|
||||
<br>
|
||||
noch nicht implementiert - Es werden keine gesammelten Statistiken angezeigt, sondern nur die unter "singularReadings" definierten Einzelwerte
|
||||
</li><br>
|
||||
<li><code>minAvgMaxReadings <Gerätewerte></code>
|
||||
<a id="statistics-attr-minAvgMaxReadings"></a><li><code>minAvgMaxReadings <Gerätewerte></code>
|
||||
<br>
|
||||
Durch Kommas getrennte Liste von Gerätewerten, für die in bestimmten Zeiträumen (Tag, Monat, Jahr) Minimum, Mittelwert und Maximum erfasst werden.
|
||||
</li><br>
|
||||
<li><code>periodChangePreset <Sekunden></code>
|
||||
<a id="statistics-attr-periodChangePreset"></a><li><code>periodChangePreset <Sekunden></code>
|
||||
<br>
|
||||
Start der Berechnung der periodischen Daten, standardmäßig 5 Sekunden vor der vollen Stunde,
|
||||
<br>
|
||||
Erlaubt die korrekte zeitliche Zuordnung in Plots, kann je nach Systemauslastung verringert oder vergrößert werden.
|
||||
<br>
|
||||
</li><br>
|
||||
<li><code>singularReadings <GerätRegExp:GeräteWertRegExp:Statistiktyp:Zeitraum></code>
|
||||
<a id="statistics-attr-singularReadings"></a><li><code>singularReadings <GerätRegExp:GeräteWertRegExp:Statistiktyp:Zeitraum></code>
|
||||
<ul>
|
||||
<li>Statistik-Typ: Min|Avg|Max|Delta|<i>DurationState</i>|<span style="color:blue;">Tendency</span></li>
|
||||
<li>Zeitraum: Hour|Day|Month|Year|<span style="color:blue;">1h|2h|3h|6h</span></li>
|
||||
@ -1478,7 +1469,7 @@ sub statistics_UpdateDevReading($$$$)
|
||||
<code>Wettersensor:rain:Delta:(Hour|Day)|FritzDect:power:Delta:Day</code>
|
||||
</dd>
|
||||
</li><br>
|
||||
<li><code>specialDeltaPeriods <Gerät:Gerätewert:Zeitraum:Anzahl1:Anzahl2:...></code>
|
||||
<a id="statistics-attr-specialDeltaPeriods"></a><li><code>specialDeltaPeriods <Gerät:Gerätewert:Zeitraum:Anzahl1:Anzahl2:...></code>
|
||||
<br>
|
||||
Erzeugt für die angegebenen "delta"-Gerätewerte zusätzliche Einzelwerte über die angegebene Anzahl eines Zeitraums (Hour, Day, Month).
|
||||
<br>
|
||||
@ -1495,11 +1486,11 @@ sub statistics_UpdateDevReading($$$$)
|
||||
Dies erzeugt 4 zusätzliche Werte für die Regenmenge in den letzten 48 Stunden und den letzten 30 Tagen und den Energieverbrauch der letzten 6 und 12 Monate.
|
||||
</dd>
|
||||
</li><br>
|
||||
<li><code>specialDeltaPeriodHours</code>
|
||||
<a id="statistics-attr-specialDeltaPeriodHours"></a><li><code>specialDeltaPeriodHours</code>
|
||||
<br>
|
||||
veraltet
|
||||
</li><br>
|
||||
<li><code>tendencyReadings <Gerätewerte></code>
|
||||
<a id="statistics-attr-tendencyReadings"></a><li><code>tendencyReadings <Gerätewerte></code>
|
||||
<br>
|
||||
Durch Kommas getrennte Liste von weiteren Gerätewerten, für die innerhalb bestimmter Zeiträume (1h, 2h, 3h, 6h) die Differenz zwischen Anfangs- und Endwert ermittelt wird.
|
||||
</li><br>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user