Regulärer Ausdruck
Ein Regulärer Ausdruck (englisch regular expression, daher auch häufig als RegExp oder Regex abgekürzt; siehe auch Wikipedia) wird im Kontext von FHEM häufig benutzt, um aus Zeichenketten oder aus dem Strom der Ereignisse anhand von Mustern und Regeln einzelne Teile bzw. Ereignisse zu extrahieren.
Anwendung in FHEM
Die Notwendigkeit der Verwendung regulärer Ausdrücke ergibt sich beispielsweise bei der Definition eines FileLog (Filtern der Ereignisse) oder um aus einem mit HTTPMOD "gewonnenen" Datenstrom die relevanten Daten zu Weiterverarbeitung zu isolieren.
Einige Stellen, an denen reguläre Ausdrücke in FHEM vorkommen (wie z.B. FileLog und SVG), bieten eine Basisunterstützung bei der Definition und Verwaltung der zugehörigen Ausdrücke.
Werkzeuge zur Erstellung Regulärer Ausdrücke
Insbesondere bei nur gelegentlicher Erstellung von Regulären Ausdrücken können diverse im Internet verfügbare "Tester" oder "Analyzer" wertvolle Hilfe leisten.
Regular Expression Tester
Exemplarisch wird hier auf regex101.com und regexr.com verwiesen, von denen insbesondere der erste auch eine "Explain" Funktion bietet, mit deren Einsatz die einzelnen Bestandteile des zu testenden regulären Ausdrucks erläutert werden. Wer einen deutschen Tester mit angegebenem Urheber sucht, findet zum Beispiel regexe von Andreas Göbel. Es gibt viele andere Internetseiten, die sich mit der gleichen Thematik befassen.
"Execute"
Anhand des nebenstehenden Bildschirmfotos soll an einem einfachen Beispiel die generelle Funktionsweise derartiger Hilfsmittel erläutert werden:
- Input
- Datenstrom, der mit dem regulären Ausdruck verarbeitet werden soll; hier ein Teil (der Quelldaten) einer HTML-Seite.
- Expression
- Regulärer Ausdruck, mit dessen Hilfe aus dem Datenstrom der Wert des Feldes CM Status, also in diesem Fall Operational extrahiert werden soll.
- Output
- Die einzelnen Teile des Testergebnisses. Der Ausdruck in Klammern ([A-Za-z]+) stellt den Teil dar, der zur Weiterverarbeitung benutzt werden soll; der Rest dient zu Identifizierung der richtigen Stelle (hier Match at character 802) innerhalb des Datenstroms.
"Explain"
Der oben beschriebene Regular Expression Tester bietet über die Schaltfläche Explain auch eine Erläuterungsfunktion. Ebenfalls am obigen Beispiel wird im Bildschirmfoto wieder dargestellt, wie die einzelnen Bestandteile des regulären Ausdrucks sich auswirken.
Regex101.com
Auf der Seite regexp101.com werden die Bestandteile des regulären Ausdrucks zusätzlich zur Erläuterung auch noch farblich voneinander abgehoben. Das nebenstehende Beispiel zeigt einen kurzen Auszug aus dem Spritpreismonitor.
(Weitere) Beispiele
Es finden sich hier und im FHEM Forum viele, teilweise recht komplexe Beispiele für die Verwendung von regulären Ausdrücken, unter anderem
- auf der Seite Spritpreismonitor
- in der Beschreibung des Moduls HTTPMOD
- auf der Seite Wetter und Wettervorhersagen
- ...