diff --git a/fhem/CHANGED b/fhem/CHANGED
index a3e2eb3c4..4e6fda064 100644
--- a/fhem/CHANGED
+++ b/fhem/CHANGED
@@ -1,5 +1,6 @@
# Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
# Do not insert empty lines here, update check depends on it.
+ - update: DOIFtools:documentation
- new: 98_DOIFtools: tools for DOIF
- bugfix: 93_DbLog: its now version 2.9.2 (thanks to DS_Starter)
new bugfix for SQLite issue SVGs, DbLog_Log changed to
diff --git a/fhem/FHEM/98_DOIFtools.pm b/fhem/FHEM/98_DOIFtools.pm
index 690261c42..013228341 100644
--- a/fhem/FHEM/98_DOIFtools.pm
+++ b/fhem/FHEM/98_DOIFtools.pm
@@ -869,11 +869,13 @@ DOIFtools contains tools to support DOIF.
access to DOIFtools from any DOIF device via probably associated with
access from DOIFtools to existing DOIFtoolsLog logfiles
show event monitor in device overview and optionally DOIF
+ check definitions and offer recommendations
create shortcuts
optionally create a menu entry
+ show a list of running wait timer
-Just one definition per FHEM-installation is necessary.
+Just one definition per FHEM-installation is allowed.
=end html
@@ -899,90 +901,133 @@ DOIFtools stellt Funktionen zur Unterstützung von DOIF-Geräten bereit.
Zugriff aus DOIFtools auf vorhandene DOIFtoolsLog-Logdateien.
zeigt den Event Monitor in der Detailansicht von DOIFtools.
ermöglicht den Zugriff auf den Event Monitor in der Detailansicht von DOIF.
+ prüfen der DOIF Definitionen mit Empfehlungen.
erstellen von Shortcuts
- optionalen Memüeintrag erstellen
+ optionalen Menüeintrag erstellen
+ Liste der laufenden Wait-Timer anzeigen
+
+Bedienungsanleitung
+
+
+
+
-Definition
-
- define <name> DOIFtools
- - Es ist nur eine Definition pro FHEM Installation notwendig. Die Definition wird mit den vorhanden DOIF-Namen ergänzt, daher erscheinen alle DOIF-Geräte in der Liste probably associated with. Zusätzlich wird in jedem DOIF-Gerät in dieser Liste auf das DOIFtool verwiesen.
+Definition
+
+
+ define <name> DOIFtools
+ Es ist nur eine Definition pro FHEM Installation notwendig. Die Definition wird mit den vorhanden DOIF-Namen ergänzt, daher erscheinen alle DOIF-Geräte in der Liste probably associated with. Zusätzlich wird in jedem DOIF-Gerät in dieser Liste auf das DOIFtool verwiesen.
+
+ Definitionsvorschlag zum Import mit Raw definition:
+
+ defmod DOIFtools DOIFtools
+ attr DOIFtools DOIFtoolsEventMonitorInDOIF 1
+ attr DOIFtools DOIFtoolsExecuteDefinition 1
+ attr DOIFtools DOIFtoolsExecuteSave 1
+ attr DOIFtools DOIFtoolsMenuEntry 1
+ attr DOIFtools DOIFtoolsMyShortcuts ##<br>My Shortcuts:,,list DOIFtools,fhem?cmd=list DOIFtools
+
+
-Set
-
- set <name> deleteReadingInTargetDOIF <readings to delete name>|targetDOIF <target name>|sourceAttribute <readingList> |statisticsTYPEs <List of TYPE used for statistics generation>|doStatistics <enabled|disabled|deleted>
- - deleteReadingInTargetDOIF löscht die benutzerdefinierten Readings im Ziel-DOIF
-
- targetDOIF vor dem Löschen der Readings muss das Ziel-DOIF gesetzt werden.
-
- sourceAttribute vor dem Erstellen einer ReadingsGroup muss das Attribut gesetzt werden aus dem die Readings gelesen werden, um die ReadingsGroup zu erstellen und zu beschriften. Default, readingsList
-
- statisticsTYPEs setzt eine Liste von TYPE für die Statistikdaten erfasst werden, bestehende Statistikdaten werden gelöscht. Default, "".
-
- specialLog 1 DOIF-Listing bei Status und Wait-Timer Aktualisierung im Debug-Logfile. Default, 0.
-
- doStatistics deleted setzt die Statistik zurück und löscht alle stat_ Readings.
- disabled pausiert die Statistikdatenerfassung.
- enabled startet die Statistikdatenerfassung.
-
- recording_target_duration gibt an wie lange Daten erfasst werden sollen. Default, 0 die Dauer ist nicht begrenzt.
-
-
+Set
+
+
+ set <name> deleteReadingInTargetDOIF <readings to delete name>
+ deleteReadingInTargetDOIF löscht die benutzerdefinierten Readings im Ziel-DOIF
+
+ set <name> targetDOIF <target name>
+ targetDOIF vor dem Löschen der Readings muss das Ziel-DOIF gesetzt werden.
+
+ set <name> sourceAttribute <readingList>
+ sourceAttribute vor dem Erstellen einer ReadingsGroup muss das Attribut gesetzt werden aus dem die Readings gelesen werden, um die ReadingsGroup zu erstellen und zu beschriften. Default, readingsList
+
+ set <name> statisticsTYPEs <List of TYPE used for statistics generation>
+ statisticsTYPEs setzt eine Liste von TYPE für die Statistikdaten erfasst werden, bestehende Statistikdaten werden gelöscht. Default, "".
+
+ set <name> specialLog <0|1>
+ specialLog 1 DOIF-Listing bei Status und Wait-Timer Aktualisierung im Debug-Logfile. Default, 0.
+
+ set <name> doStatistics <enabled|disabled|deleted>
+ doStatistics deleted setzt die Statistik zurück und löscht alle stat_ Readings.
+ disabled pausiert die Statistikdatenerfassung.
+ enabled startet die Statistikdatenerfassung.
+
+ set <name> recording_target_duration <hours>
+ recording_target_duration gibt an wie lange Daten erfasst werden sollen. Default, 0 die Dauer ist nicht begrenzt.
+
+
-Get
-
- get <name> DOIF_to_Log <DOIF names for logging> |readingsGroup_for <DOIF names to create readings groups> |userReading_nextTimer_for <DOIF names where to create real date timer readings> |statisticsReport
- -
- DOIF_to_Log erstellt eine FileLog-Definition, die für alle angegebenen DOIF-Definitionen loggt. Der Reguläre Ausdruck wird aus den, direkt in den DOIF-Greräte angegebenen und den wahrscheinlich verbundenen Geräten, ermittelt.
-
- checkDOIF führt eine einfache Syntaxprüfung durch und empfiehlt Änderungen.
-
- readingsGroup_for erstellt readingsGroup-Definitionen für die angegebenen DOIF-namen. sourceAttribute verweist auf das Attribut, dessen Readingsliste als Basis verwendet wird. Die Eingabeelemente im Frontend werden mit den Readingsnamen beschriftet.
-
- userReading_nextTimer_for erstellt userReadings-Attribute für Timer-Readings mit realem Datum für Timer, die mit Wochentagangaben angegeben sind, davon ausgenommen sind indirekte Wochentagsangaben.
-
- statisticsReport erstellt einen Bericht aus der laufenden Datenerfassung.
Die Statistik kann genutzt werden, um Geräte mit hohen Ereignisaufkommen zu erkennen. Bei einer hohen Rate, sollte im Interesse der Systemperformance geprüft werden, ob die Events eingeschränkt werden können. Werden keine Events eines Gerätes weiterverarbeitet, kann das Attribut event-on-change-reading auf none oder eine andere Zeichenfolge, die im Gerät nicht als Readingname vorkommt, gesetzt werden.
-
- runningTimerInDOIF zeigt eine Liste der laufenden Timer. Damit kann entschieden werden, ob bei einem Neustart wichtige Timer gelöscht werden und der Neustart ggf. verschoben werden sollte.
-
-
+Get
+
+
+ get <name> DOIF_to_Log <DOIF names for logging>
+ DOIF_to_Log erstellt eine FileLog-Definition, die für alle angegebenen DOIF-Definitionen loggt. Der Reguläre Ausdruck wird aus den, direkt in den DOIF-Greräte angegebenen und den wahrscheinlich verbundenen Geräten, ermittelt.
+
+ get <name> checkDOIF
+ checkDOIF führt eine einfache Syntaxprüfung durch und empfiehlt Änderungen.
+
+ get <name> readingsGroup_for <DOIF names to create readings groups>
+ readingsGroup_for erstellt readingsGroup-Definitionen für die angegebenen DOIF-namen. sourceAttribute verweist auf das Attribut, dessen Readingsliste als Basis verwendet wird. Die Eingabeelemente im Frontend werden mit den Readingsnamen beschriftet.
+
+ get <name> userReading_nextTimer_for <DOIF names where to create real date timer readings>
+ userReading_nextTimer_for erstellt userReadings-Attribute für Timer-Readings mit realem Datum für Timer, die mit Wochentagangaben angegeben sind, davon ausgenommen sind indirekte Wochentagsangaben.
+
+ get <name> statisticsReport
+ statisticsReport erstellt einen Bericht aus der laufenden Datenerfassung.
Die Statistik kann genutzt werden, um Geräte mit hohen Ereignisaufkommen zu erkennen. Bei einer hohen Rate, sollte im Interesse der Systemperformance geprüft werden, ob die Events eingeschränkt werden können. Werden keine Events eines Gerätes weiterverarbeitet, kann das Attribut event-on-change-reading auf none oder eine andere Zeichenfolge, die im Gerät nicht als Readingname vorkommt, gesetzt werden.
+
+ get <name> runningTimerInDOIF
+ runningTimerInDOIF zeigt eine Liste der laufenden Timer. Damit kann entschieden werden, ob bei einem Neustart wichtige Timer gelöscht werden und der Neustart ggf. verschoben werden sollte.
+
+
Attribute
-
- attr <name> DOIFtoolsExecuteDefinition <0|1> |DOIFtoolsExecuteSave <0|1> |DOIFtoolsTargetRoom <room names for target> |DOIFtoolsTargetGroup <group names for target> |DOIFtoolsEventMonitorInDOIF <1|0> |DOIFtoolsReadingsPrefix <user defined prefix> |DOIFtoolsHideModulShortcuts <0|1> |DOIFtoolsMyShortcuts <shortcut name>,<command>, ... |DOIFtoolsMenuEntry <0|1>
- - DOIFtoolsExecuteDefinition 1 führt die erzeugten Definitionen aus. Default 0, zeigt die erzeugten Definitionen an, sie können mit Raw definition importiert werden.
-
- DOIFtoolsExecuteSave 1, die Definitionen werden automatisch gespeichert. Default 0, der Benutzer kann die Definitionen speichern.
-
- DOIFtoolsTargetGroup gibt die Gruppen für die zu erstellenden Definitionen an. Default, die Gruppe der Ursprungs Definition.
-
- DOIFtoolsTargetRoom gibt die Räume für die zu erstellenden Definitionen an. Default, der Raum der Ursprungs Definition.
-
- DOIFtoolsReadingsPrefix legt den Präfix der benutzerdefinierten Readingsnamen für die Zieldefinition fest. Default, DOIFtools bestimmt den Präfix.
-
- DOIFtoolsEventMonitorInDOIF 1, die Anzeige des Event-Monitors wird in DOIF ermöglicht. Default 0, kein Zugriff auf den Event-Monitor im DOIF.
-
- DOIFtoolsHideModulShortcuts 1, verstecken der DOIFtools Shortcuts. Default 0.
-
- DOIFtoolsMyShortcuts <Bezeichnung>,<Befehl>,... anzeigen eigener Shortcuts, siehe globales Attribut menuEntries.
- Zusätzlich gilt, wenn ein Eintrag mit ## beginnt und mit ,, endet, wird er als HTML interpretiert.
- Beispiel: attr DOIFtools DOIFtoolsMyShortcuts ##
My Shortcuts:,,list DOIFtools,fhem?cmd=list DOIFtools
-
- DOIFtoolsMenuEntry 1, erzeugt einen Menüeintrag im FHEM-Menü. Default 0.
-
- disabledForIntervals pausiert die Statistikdatenerfassung.
-
-
+
+ attr <name> DOIFtoolsExecuteDefinition <0|1>
+ DOIFtoolsExecuteDefinition 1 führt die erzeugten Definitionen aus. Default 0, zeigt die erzeugten Definitionen an, sie können mit Raw definition importiert werden.
+
+ attr <name> DOIFtoolsExecuteSave <0|1>
+ DOIFtoolsExecuteSave 1, die Definitionen werden automatisch gespeichert. Default 0, der Benutzer kann die Definitionen speichern.
+
+ attr <name> DOIFtoolsTargetGroup <group names for target>
+ DOIFtoolsTargetGroup gibt die Gruppen für die zu erstellenden Definitionen an. Default, die Gruppe der Ursprungs Definition.
+
+ attr <name> DOIFtoolsTargetRoom <room names for target>
+ DOIFtoolsTargetRoom gibt die Räume für die zu erstellenden Definitionen an. Default, der Raum der Ursprungs Definition.
+
+ attr <name> DOIFtoolsReadingsPrefix <user defined prefix>
+ DOIFtoolsReadingsPrefix legt den Präfix der benutzerdefinierten Readingsnamen für die Zieldefinition fest. Default, DOIFtools bestimmt den Präfix.
+
+ attr <name> DOIFtoolsEventMonitorInDOIF <1|0>
+ DOIFtoolsEventMonitorInDOIF 1, die Anzeige des Event-Monitors wird in DOIF ermöglicht. Default 0, kein Zugriff auf den Event-Monitor im DOIF.
+
+ attr <name> DOIFtoolsHideModulShortcuts <0|1>
+ DOIFtoolsHideModulShortcuts 1, verstecken der DOIFtools Shortcuts. Default 0.
+
+ attr <name> DOIFtoolsMyShortcuts <shortcut name>,<command>, ...
+ DOIFtoolsMyShortcuts <Bezeichnung>,<Befehl>,... anzeigen eigener Shortcuts, siehe globales Attribut menuEntries.
+ Zusätzlich gilt, wenn ein Eintrag mit ## beginnt und mit ,, endet, wird er als HTML interpretiert.
+ Beispiel:
+ attr DOIFtools DOIFtoolsMyShortcuts ##<br>My Shortcuts:,,list DOIFtools,fhem?cmd=list DOIFtools
+
+ attr <name> DOIFtoolsMenuEntry <0|1>
+ DOIFtoolsMenuEntry 1, erzeugt einen Menüeintrag im FHEM-Menü. Default 0.
+
+ disabledForIntervals pausiert die Statistikdatenerfassung.
+
+
-Readings
+Readings
DOIFtools erzeugt bei der Aktualisierung von Readings keine Events, daher muss die Seite im Browser aktualisiert werden, um aktuelle Werte zu sehen.
@@ -999,13 +1044,12 @@ DOIFtools stellt Funktionen zur Unterstützung von DOIF-Geräten bereit.
-Links
+Links
-
=end html_DE
=cut