FHEMWiki - Benutzerbeiträge [de]

DOIF/Tools und Fehlersuche

2016-10-12T09:05:24Z

OliWee: Vorlage "Link2Forum verwendet

[[Kategorie:Hilfsmodul]]
'''Anmerkung:''' Dieser Artikel wurde {{Link2Forum|Topic=58237|Message=496560|LinkText=aus dem Forum}} übernommen.

Dies ist der Versuch einige Hilfen aufzuzeigen, damit ein fehlerhaftes DOIF selbst korrigiert werden kann und wenn dies nicht zum Ziel führt, notwendige Angaben für eine Anfrage im Forum zusammenzustellen.

== Eine verlässliche Basis zur Fehlereingrenzung schaffen. ==
=== Standardisierte Geräteerstellung und Bearbeitung ===
Im Folgenden wird davon ausgegangen, dass zum Erstellen des DOIF und zur Befehlseingabe die Eingabezeile des Web-Frontends benutzt wird und mit dem DEF-Editor (auf DEF klicken) in der sich öffnenden Geräteübersicht (DeviceOverview) bearbeitet wird, ohne eine cfg-Datei zu editieren.

Nutzung des integrierten DEF-Editors mit Codemirror-Erweiterung, [[Konfiguration#Syntaxhervorhebung | Codemirror einrichten und bedienen]], siehe ergänzend DOIF: Tips leichtere Bedienung Syntaxhervorhebung Klammerprüfung Suchen&Ersetzen

=== Strukturierung der Definition ===
Eine einzeilige Definition, die über mehrere Seiten verschoben werden muss oder über mehrere Zeilen umgebrochen wird ist unübersichtlich. Der DEF-Editor bietet die Möglichkeit zur Strukturierung der Definition. Man könnte wie folgt strukturieren:
<pre>
## 1
(<Bedingung>)
(<Befehle>)
## 2
DOELSEIF (<Bedingung>)
(<Befehle>)
## 3
DOELSEIF (<Bedingung>)
(<Befehle>)
...
</pre>

=== FHEM aktuell halten ===
Die [http://fhem.de/commandref_DE.html#DOIF Befehlsreferenz] im Netz beschreibt die Eigenschaften des aktuellen Moduls. Möchte man die neusten Eigenschaften nutzen, ist eine Aktualisierung durchzuführen. Wird nur das Modul aktualisiert, kann das zu unerwartetem Verhalten des DOIF führen.

Prüfen ob ein Update für DOIF vorliegt mit
<pre>
update check
</pre>

FHEM aktualisieren mit
<pre>
update
</pre>

Nach einem "update" immer ein
<pre>
shutdown restart
</pre>
durchführen.

"shutdown restart" kann man per notify automatisieren mit
<pre>
define shutdown_restart notify global:UPDATE shutdown restart
</pre>

Der Befehl
<pre>
version
</pre>
liefert die "Latest Revision:" und die aktuell geladenen Modulversionen.

== Fehlersuche ==
=== Fehler in der Syntax der Definition ===
Diese Fehler werden durch die Benutzung des DEF-Editors mit Codemirror-Erweiterung reduziert.

Der Editor unterstützt:
* farbliche Hervorhebung bekannter Befehle
* Vervollständigung bekannter Begriffe
* eine Prüfung auf unvollständige Klammerpaare
* ggf. Fehlermeldung beim Erstellen einer Definition
* Suchen&Ersetzen
*uvm.

Einige Syntaxfehler werden im Frontend bei der Erstellung des Gerätes oder im globalen Logfile angezeigt. Das globale Logfile ist über den Menüpunkt "Logfile" im Hauptmenü des Frontends zu erreichen.
Fehler oder Warnungen, die erst zur Laufzeit offensichtlich werden, stehen in der Geräteübersicht oder im globalen Logfile.

=== Logische Fehler ===
Diese Fehler werden erst zur Laufzeit sichtbar und das DOIF verhält sich nicht wie erwartet.

Die Fehler entstehen z.B. durch:

* Angabe einer falsche Rangfolge von Operatoren in der Bedingung:
<pre>
[A] and [B] or [C]
</pre>
geschrieben, aber
<pre>
[A] and ([B] or [C])
</pre>
gemeint.
* Nichtbeachtung des unterschiedlichen Verhalten von auslösenden und nicht auslösenden Readings.
* Ein unerwartetes Auslösen von DOELSE.
* Unerwartete Ereignisse eines Gerätes, die in einer Bedingung nicht abgefangen werden.
* Falsche Angabe der Events eines beteiligten Gerätes.

=== Fehler eingrenzen ===
Wenn der Hinweis in der Fehlermeldung nicht ausreicht, um den Fehler zu beseitigen, empfiehlt es sich die Definition des DOIF Schritt für Schritt neu aufzubauen und die Fehlermeldung zu beobachten, um den Fehlerort einzugrenzen. Der letzte Schritt, der zur Fehlermeldung geführt hat, muss dann genauer untersucht werden.

=== DOIF zum Testen ===
Eine weitere Möglichkeit wäre ein DOIF zum Testen anzulegen. Darin können Befehle, Bedingungen oder Bedingungsteile, verschiedene Schreibweisen oder alternative Operanden verwendet und ausprobiert werden, bis der eine Lösung gefunden wurde.

== Hilfsmittel zu Fehleranalyse ==
=== Befehlsreferenz ===
Die [http://fhem.de/commandref_DE.html#DOIF Befehlsreferenz zum DOIF] immer wieder problembezogen lesen.

=== Stacktrace ===
Zur Ursachenermittlung von Perl-Warnungen kann das globale Attribut stacktrace auf 1 gesetzt werden.
<pre>
attr global stacktrace 1
</pre>

=== Verboselevel ===
In manchen Fällen bekommt man hilfreiche Informationen, wenn der Verboselevel von betroffenen Geräten erhöht wird.
<pre>
attr <gerätename> verbose 5
</pre>

=== Eventmonitor ===
Der Eventmonitor ist über den Menüpunkt "Event monitor" im Hauptmenü des Frontends zu erreichen. Er enthält einen Filter, um die Anzeige der Events zu beschränken, um z.B. nur die Events eines Gerätes anzuzeigen, etwa des DOIF.

=== Detailansicht des DOIF ===
Das Schaltverhalten des DOIF kann in der Detailansicht (DeviceOverview) des DOIF und/oder im Eventmonitor beobachtet werden.

Bei der Detailansicht ist zu beachten, dass nicht alle sich ändernden Readings aktualisiert werden. Um diese geänderten Readings anzuzeigen, muss die Ansicht im Browser aktualisiert werden.

=== Gerätedefinition ausgeben ===
Eine Gerätedefinition einschliesslich der Attribute kann man sich mit dem Befehl "exportdevice" anzeigen lassen und zum Posten verwenden.
<pre>
exportdevice <DOIFname>
</pre>

=== Listing des DOIF ===
Eine Momentaufnahme vom Status des DOIF im Fehlerfall kann man sich mit dem Befehl "list" anzeigen lassen.
<pre>
list <DOIFname>
</pre>

=== Verhaltensanalyse des DOIF ===
Das komplette Verhalten des DOIF kann über ein extra Logfile protokolliert werden. Dazu können alle Geräte einbezogen werden, die im DOIF enthalten sind; z.B. als tägliches Logfile.
<pre>
define DOIF_Log FileLog ./log/DOIF_Log-%j.log <DOIFname>:.*|<Gerät 1>:.*|<Gerät 2>:.* ...
</pre>

Mit dem Attribut mseclog lässt sich ein genauerer Zeitstempel einstellen, damit können zusammengehörende Events erkannt werden.
<pre>
attr DOIF_Log mseclog 1
</pre>

In dem Logfile kann das Verhalten des DOIF und der dazugehörenden Operanden genau nachvollzogen werden. Wenn Abweichungen zum erwarteten Verhalten erkannt werden, hat man einen Anhaltspunkt für weitere Untersuchungen oder sogar den Auslöser gefunden.

Die Protokollierung mit FileLog hat den Vorteil, dass die Definition recht einfach in der Geräteübersicht zusammengestellt werden kann. Die Definition muss nach Gebrauch nicht gelöscht werden, sondern kann mit dem Attribut "disable" abgeschaltet werden. Später kann das Gerät wieder aktiviert werden, etwa um ein anderes DOIF zu loggen.

== Qualifizierte Angaben zur Anfrage im Forum ==
Dem Helfenden sollten alle zum Problem gehörenden Informationen gegeben werden, die dem Fragenden auch zur Verfügung stehen.

Nicht immer sind alle Angaben notwendig, bei komplexen Problemen schon eher.
* Hinweis, wenn FHEM und DOIF nicht aktuell sind.
* Hinweis, wenn die cfg-Dateien direkt bearbeitet werden.
* genaue Beschreibung des erwarteten Verhalten
* genaue Beschreibung des beobachteten Verhalten
* Alle relevanten Fehlermeldungen
* Darstellen, was man selbst schon versucht hat und mit welchem Ergebnis, dann wird es nicht noch einmal vorgeschlagen.
* Angabe der vollständigen Definition des DOIF (Name, Definition, Attribute) in Code-Tags (das Raute-Zeichen # im Forum-Editor)
* Das Listing des DOIF als Alternative
* Die relevanten Stellen aus dem aufgezeichnete Filelog mit Kommentar und Markierung der Probleme in Quote-Tags (das Zeichen rechts neben der Raute). In Quote-Tags kann die Zeichenformatierung zum Markieren genutzt werden, in Code-Tags nicht.
* Auszug aus dem Eventmonitor mit Kommentar und Markierung der Probleme

DOIF

2016-10-12T09:03:12Z

OliWee: Link zur Unterseite hinzugefügt

{{Infobox Modul
|ModPurpose=Do ... if ...
|ModType=h
|ModForumArea=Automatisierung
|ModTechName=98_DOIF.pm
|ModOwner=Damian}}

[[DOIF]] ist ein universelles Modul, welches sowohl ereignis- als auch zeitgesteuert arbeitet. Es vereinigt die Funktionalität eines [[notify]]-, [[at]]-, [[watchdog]]-Befehls in Kombination mit logischen Abfragen unter einem Dach. Damit können insb. komplexere Problemstellungen innerhalb eines DOIF-Moduls gelöst werden, die sonst nur mit Hilfe einzelner Module an mehreren Stellen in FHEM vorgenommen werden müssten. Es ermöglicht, Aktionen ("do") unter bestimmten Bedingungen ("if") auszuführen. Bedingungen umfasst auch Konstrukte wie "wenn Zustand x für y Minuten... (Zeitsteuerung)".

== Voraussetzungen ==
keine

== Anwendung ==
=== Define ===
Siehe Commandref.

=== Attribute ===
Siehe Commandref.

== Anwendungsbeispiele ==
Der Modulautor hat im deutschen Teil der [http://fhem.de/commandref_DE.html#DOIF Commandref] eine Vielzahl von einfachen und auch komplexeren Beispielen zur Nutzung von DOIF aufgenommen. Darum wird hier auf weitere Beispiele zu DOIF verzichtet. Ausführliche Code-Beispiele zu DOIF bitte gegebenenfalls als eigene Wiki-Seite unter [[:Kategorie:Code Snippets|Code Snippets]] aufnehmen.

== Links ==
* {{Link2Forum|Topic=45373|LinkText=Hinweise zur leichteren Erstellung/Bearbeitung (nicht nur) von DOIF}}
* {{Link2Forum|Topic=23833|LinkText=Forenthread}} zur Entstehung dieses Moduls
* [[DOIF/Tools und Fehlersuche]]
* [[DOIF/Tipps zur leichteren Bedienung]]

DOIF/Tipps zur leichteren Bedienung

2016-10-12T08:59:39Z

OliWee: Die Seite wurde neu angelegt: „Kategorie:Hilfsmodul '''Anmerkung:''' Dieser Artikel wurde {{Link2Forum|Topic=45373|Message=371668|LinkText=aus dem Forum}} übernommen. Ich habe ein paar…“

[[Kategorie:Hilfsmodul]]
'''Anmerkung:''' Dieser Artikel wurde {{Link2Forum|Topic=45373|Message=371668|LinkText=aus dem Forum}} übernommen.

Ich habe ein paar Hinweise gesammelt, die den Umgang mit dem DOIF erleichtern können. Nichts Neues, aber vielleicht hilft es dem Einen oder Anderen.
Es gibt bestimmt noch Ergänzungen, die pflege ich hier im 1. Beitrag ein.

== Verwenden des DEF-Editors zum Erstellen und Bearbeiten des DOIF ==
Zuerst eine minimale Definition in der Eingabezeile der WEB-Oberfläche erstellen
<pre>
define <DOIF Name> DOIF ([<Name eines triggernden Gerätes>])
</pre>
danach die Eingabetaste drücken, dann öffnet sich die Geräteübersicht (DeviceOverview), dort den DEF-Editor öffnen (auf DEF klicken) und die Definition weiter bearbeiten und strukturieren.

== Einschalten von Syntaxhervorhebung, Zeilenumbruch, Suchen und Ersetzen, Klammerprüfung uvm. ==
<pre>
attr WEB JavaScripts codemirror/fhem_codemirror.js
attr WEB codemirrorParam { "lineWrapping":true }
</pre>

== Länge der Eingabezeile (Befehlszeile) ändern ==
Per Attribut die Länge der Eingabezeile ändern.
<pre>
attr WEB mainInputLength 80
</pre>

== Eingabefeld für bestimmte Attribute vergrößern, z.B. für das Attribut "state", um bequem Berechnungen zu erstellen. ==
<pre>
attr <DOIF Name> widgetOverride state:textField-long
</pre>

== Größe des Editorfensters ändern ==
Wem das Editorfenster zu zu groß oder zu klein ist, kann die Höhe optimieren mit
<pre>
attr WEB codemirrorParam { ..., "height":"auto" }
</pre>

Weitere einstellbare Parameter für codemirror siehe auch:
[[Konfiguration#Syntaxhervorhebung|Codemirror Bedienung und Einstellungen]]

== Umschaltung auf deutsche Befehlsreferenz ==
Direkter Aufruf der deutschsprachigen Hilfe in der "Device specific help" und direkter Zugriff auf die deutschsprachige Befehlsreferenz im Hauptmenü.
<pre>
attr global language DE
</pre>

== Weiterführende Links ==
[[DOIF/Tools und Fehlersuche|Tools und Fehlersuche]]

DOIF

2016-10-12T07:38:40Z

OliWee: /* Links */ Link zu Unterseite hinzugefügt

DOIF/Tools und Fehlersuche

2016-10-12T07:37:19Z

OliWee: Die Seite wurde neu angelegt: „Kategorie:Hilfsmodul '''Anmerkung:''' Dieser Artikel wurde [https://forum.fhem.de/index.php/topic,58237.msg496560.html#msg496560 aus dem Forum] übernommen…“

[[Kategorie:Hilfsmodul]]
'''Anmerkung:''' Dieser Artikel wurde [https://forum.fhem.de/index.php/topic,58237.msg496560.html#msg496560 aus dem Forum] übernommen.

Dies ist der Versuch einige Hilfen aufzuzeigen, damit ein fehlerhaftes DOIF selbst korrigiert werden kann und wenn dies nicht zum Ziel führt, notwendige Angaben für eine Anfrage im Forum zusammenzustellen.

== Eine verlässliche Basis zur Fehlereingrenzung schaffen. ==
=== Standardisierte Geräteerstellung und Bearbeitung ===
Im Folgenden wird davon ausgegangen, dass zum Erstellen des DOIF und zur Befehlseingabe die Eingabezeile des Web-Frontends benutzt wird und mit dem DEF-Editor (auf DEF klicken) in der sich öffnenden Geräteübersicht (DeviceOverview) bearbeitet wird, ohne eine cfg-Datei zu editieren.

Nutzung des integrierten DEF-Editors mit Codemirror-Erweiterung, [[Konfiguration#Syntaxhervorhebung | Codemirror einrichten und bedienen]], siehe ergänzend DOIF: Tips leichtere Bedienung Syntaxhervorhebung Klammerprüfung Suchen&Ersetzen

=== Strukturierung der Definition ===
Eine einzeilige Definition, die über mehrere Seiten verschoben werden muss oder über mehrere Zeilen umgebrochen wird ist unübersichtlich. Der DEF-Editor bietet die Möglichkeit zur Strukturierung der Definition. Man könnte wie folgt strukturieren:
<pre>
## 1
(<Bedingung>)
(<Befehle>)
## 2
DOELSEIF (<Bedingung>)
(<Befehle>)
## 3
DOELSEIF (<Bedingung>)
(<Befehle>)
...
</pre>

=== FHEM aktuell halten ===
Die [http://fhem.de/commandref_DE.html#DOIF Befehlsreferenz] im Netz beschreibt die Eigenschaften des aktuellen Moduls. Möchte man die neusten Eigenschaften nutzen, ist eine Aktualisierung durchzuführen. Wird nur das Modul aktualisiert, kann das zu unerwartetem Verhalten des DOIF führen.

Prüfen ob ein Update für DOIF vorliegt mit
<pre>
update check
</pre>

FHEM aktualisieren mit
<pre>
update
</pre>

Nach einem "update" immer ein
<pre>
shutdown restart
</pre>
durchführen.

"shutdown restart" kann man per notify automatisieren mit
<pre>
define shutdown_restart notify global:UPDATE shutdown restart
</pre>

Der Befehl
<pre>
version
</pre>
liefert die "Latest Revision:" und die aktuell geladenen Modulversionen.

== Fehlersuche ==
=== Fehler in der Syntax der Definition ===
Diese Fehler werden durch die Benutzung des DEF-Editors mit Codemirror-Erweiterung reduziert.

Der Editor unterstützt:
* farbliche Hervorhebung bekannter Befehle
* Vervollständigung bekannter Begriffe
* eine Prüfung auf unvollständige Klammerpaare
* ggf. Fehlermeldung beim Erstellen einer Definition
* Suchen&Ersetzen
*uvm.

Einige Syntaxfehler werden im Frontend bei der Erstellung des Gerätes oder im globalen Logfile angezeigt. Das globale Logfile ist über den Menüpunkt "Logfile" im Hauptmenü des Frontends zu erreichen.
Fehler oder Warnungen, die erst zur Laufzeit offensichtlich werden, stehen in der Geräteübersicht oder im globalen Logfile.

=== Logische Fehler ===
Diese Fehler werden erst zur Laufzeit sichtbar und das DOIF verhält sich nicht wie erwartet.

Die Fehler entstehen z.B. durch:

* Angabe einer falsche Rangfolge von Operatoren in der Bedingung:
<pre>
[A] and [B] or [C]
</pre>
geschrieben, aber
<pre>
[A] and ([B] or [C])
</pre>
gemeint.
* Nichtbeachtung des unterschiedlichen Verhalten von auslösenden und nicht auslösenden Readings.
* Ein unerwartetes Auslösen von DOELSE.
* Unerwartete Ereignisse eines Gerätes, die in einer Bedingung nicht abgefangen werden.
* Falsche Angabe der Events eines beteiligten Gerätes.

=== Fehler eingrenzen ===
Wenn der Hinweis in der Fehlermeldung nicht ausreicht, um den Fehler zu beseitigen, empfiehlt es sich die Definition des DOIF Schritt für Schritt neu aufzubauen und die Fehlermeldung zu beobachten, um den Fehlerort einzugrenzen. Der letzte Schritt, der zur Fehlermeldung geführt hat, muss dann genauer untersucht werden.

=== DOIF zum Testen ===
Eine weitere Möglichkeit wäre ein DOIF zum Testen anzulegen. Darin können Befehle, Bedingungen oder Bedingungsteile, verschiedene Schreibweisen oder alternative Operanden verwendet und ausprobiert werden, bis der eine Lösung gefunden wurde.

== Hilfsmittel zu Fehleranalyse ==
=== Befehlsreferenz ===
Die [http://fhem.de/commandref_DE.html#DOIF Befehlsreferenz zum DOIF] immer wieder problembezogen lesen.

=== Stacktrace ===
Zur Ursachenermittlung von Perl-Warnungen kann das globale Attribut stacktrace auf 1 gesetzt werden.
<pre>
attr global stacktrace 1
</pre>

=== Verboselevel ===
In manchen Fällen bekommt man hilfreiche Informationen, wenn der Verboselevel von betroffenen Geräten erhöht wird.
<pre>
attr <gerätename> verbose 5
</pre>

=== Eventmonitor ===
Der Eventmonitor ist über den Menüpunkt "Event monitor" im Hauptmenü des Frontends zu erreichen. Er enthält einen Filter, um die Anzeige der Events zu beschränken, um z.B. nur die Events eines Gerätes anzuzeigen, etwa des DOIF.

=== Detailansicht des DOIF ===
Das Schaltverhalten des DOIF kann in der Detailansicht (DeviceOverview) des DOIF und/oder im Eventmonitor beobachtet werden.

Bei der Detailansicht ist zu beachten, dass nicht alle sich ändernden Readings aktualisiert werden. Um diese geänderten Readings anzuzeigen, muss die Ansicht im Browser aktualisiert werden.

=== Gerätedefinition ausgeben ===
Eine Gerätedefinition einschliesslich der Attribute kann man sich mit dem Befehl "exportdevice" anzeigen lassen und zum Posten verwenden.
<pre>
exportdevice <DOIFname>
</pre>

=== Listing des DOIF ===
Eine Momentaufnahme vom Status des DOIF im Fehlerfall kann man sich mit dem Befehl "list" anzeigen lassen.
<pre>
list <DOIFname>
</pre>

=== Verhaltensanalyse des DOIF ===
Das komplette Verhalten des DOIF kann über ein extra Logfile protokolliert werden. Dazu können alle Geräte einbezogen werden, die im DOIF enthalten sind; z.B. als tägliches Logfile.
<pre>
define DOIF_Log FileLog ./log/DOIF_Log-%j.log <DOIFname>:.*|<Gerät 1>:.*|<Gerät 2>:.* ...
</pre>

Mit dem Attribut mseclog lässt sich ein genauerer Zeitstempel einstellen, damit können zusammengehörende Events erkannt werden.
<pre>
attr DOIF_Log mseclog 1
</pre>

In dem Logfile kann das Verhalten des DOIF und der dazugehörenden Operanden genau nachvollzogen werden. Wenn Abweichungen zum erwarteten Verhalten erkannt werden, hat man einen Anhaltspunkt für weitere Untersuchungen oder sogar den Auslöser gefunden.

Die Protokollierung mit FileLog hat den Vorteil, dass die Definition recht einfach in der Geräteübersicht zusammengestellt werden kann. Die Definition muss nach Gebrauch nicht gelöscht werden, sondern kann mit dem Attribut "disable" abgeschaltet werden. Später kann das Gerät wieder aktiviert werden, etwa um ein anderes DOIF zu loggen.

== Qualifizierte Angaben zur Anfrage im Forum ==
Dem Helfenden sollten alle zum Problem gehörenden Informationen gegeben werden, die dem Fragenden auch zur Verfügung stehen.

Nicht immer sind alle Angaben notwendig, bei komplexen Problemen schon eher.
* Hinweis, wenn FHEM und DOIF nicht aktuell sind.
* Hinweis, wenn die cfg-Dateien direkt bearbeitet werden.
* genaue Beschreibung des erwarteten Verhalten
* genaue Beschreibung des beobachteten Verhalten
* Alle relevanten Fehlermeldungen
* Darstellen, was man selbst schon versucht hat und mit welchem Ergebnis, dann wird es nicht noch einmal vorgeschlagen.
* Angabe der vollständigen Definition des DOIF (Name, Definition, Attribute) in Code-Tags (das Raute-Zeichen # im Forum-Editor)
* Das Listing des DOIF als Alternative
* Die relevanten Stellen aus dem aufgezeichnete Filelog mit Kommentar und Markierung der Probleme in Quote-Tags (das Zeichen rechts neben der Raute). In Quote-Tags kann die Zeichenformatierung zum Markieren genutzt werden, in Code-Tags nicht.
* Auszug aus dem Eventmonitor mit Kommentar und Markierung der Probleme