Die '''Konfiguration''' eines Fhem [[Systemübersicht|Systems]] wird im Normalfall definiert durch Eintragungen in der Konfigurationsdatei <code>fhem.cfg</code>, die standardmäßig im Fhem-Installationsverzeichnis abgelegt ist.

Sofern nicht anderweitig erwähnt, beziehen sich alle weiteren Aussagen und Bildschirmfotos auf das [[PGM2|Standard Webinterface]] im Stil "dark".

== Grundstruktur ==
In einer Standardinstallation sind alle Definitionen in der Datei <code>fhem.cfg</code> abgelegt; diese Datei befindet sich im Installationsverzeichnis (z. B. <code>/opt/fhem</code>). Soll alternativ eine andere (Start-)Konfigurationsdatei verwendet werden, so ist deren Name beim Start von Fhem mitzugeben.

== Autocreate ==
Sofern die "Autocreate" Funktion aktiv ist (<code>define autocreate autocreate</code>), werden unter bestimmten Umständen Objekte automatisch angelegt. Diese Definitionen werden immer in der Start-Konfigurationsdatei abgelegt und abgespeichert. Nach der Erstinstallation von Fhem ist die "Autocreate" Funktion standardmäßig aktiv.

== Bearbeitung der Konfiguration ==
[[Bild:saveConfig.png|mini|120px|links|"Knopf" zum Speichern der Konfigurationsänderungen]]
[[Bild:saveConfigChangeList.png|mini|220px|rechts|Beispiel einer Liste der ungesicherten Anderungen der Konfiguration]]
Die Fhem-Konfiguration kann auf verschiedene Arten bearbeitet werden. Nicht nur für Einsteiger empfiehlt sich grundsätzlich die Verwendung des "Befehl-Eingabefeld" und der "Objektdetails" mit eingeschalteter Syntaxhervorhebung. Die Methoden "Integrierter Editor" und insbesondere "Externer Editor" sollten als "Expertenmodus" angesehen und nur in begründeten (Ausnahme-)Fällen angewendet werden; viele Automatiken und Fehlerkontrollen/-hinweise von Fhem stehen bei diesen Methoden nicht zur Verfügung. Insbesondere beim Mischen der Arten können unerwünschte und/oder unerwartete Effekte auftreten, so beispielsweise, wenn ein benötigtes "Save config" nicht erfolgt ist, bevor ein "rereadcfg" oder Neustart von Fhem durchgeführt wird.

Seit Mitte Januar 2015 ist es, wie im Bild rechts gezeigt, möglich, sich eine Teilliste der ungesicherten Konfigurationsänderungen durch Anklicken des roten {{Taste|?}} anzeigen zu lassen.

=== Befehl-Eingabefeld ===
[[Bild:ConfCommandField.png|thumb|300px|Right|Befehl-Eingabefeld]]
Eingaben in das Befehl-Eingabefeld (teilweise auch bezeichnet als "Kommando-Eingabefeld" oder kurz "Eingabefeld"), das sich oben auf jeder Seite des Standardinterfaces befindet, stellen einen schnellen und einfachen Weg dar, um z. B. neue Objekte zu definieren (im dargestellten Beispiel die Zuweisung eines (ggf. neuen) Raumes zu einem Objekt). Nach Bestätigung mit der <Enter>-Taste werden die Änderungen unmittelbar wirksam.

Die Änderung müssen manuell in der Konfigurationsdatei abspeichert werden, ansonsten gehen die Änderungen beim Neustart verloren: "Save config" (aus dem Menü in der linken Spalte) anklicken oder den Befehl "save" im Befehl-Eingabefeld eingeben.

=== Objektdetails ===
Durch Anklicken des Namensfeldes eines Objekts werden die Objektdetails aufgerufen. Je nach Objekttyp stehen auf dieser Seite verschiedene Optionen zur Manipulation von Objekteigenschaften zur Verfügung:
* [[Bild:ConfModifyDEF.png|300px|right]] <code>DEF</code> zur Anpassung der Definition
* [[Bild:ConfAttrDropdown.png|300px|right]] Attribute / Attributwerte aus Auswahllisten (nach Auswahl der Werte ist der <code>attr</code> Knopf anzuklicken)
* je nach Objekttyp stehen weitere / andere Aktionen zur
Nach einem Klick auf "Modify" werden die Änderungen an der Defintion unmittelbar wirksam.

Die Änderung müssen manuell in der Konfigurationsdatei abspeichert werden, ansonsten gehen die Änderungen beim Neustart verloren: "Save config" (aus dem Menü in der linken Spalte) anklicken oder den Befehl "save" im Befehl-Eingabefeld eingeben.

=== Integrierter Editor ===
[[Bild:ConfEditFiles.png|thumb|300px|links|Aufruf des integrierten Editors]]
[[Bild:ConfEditSyntaxHighlight.png|mini|300px|rechts|Editfenster (Ausschnitt) mit Syntaxhervorhebung]]
Sollte ein direktes Editieren der Konfigurationsdatei als nötig erachtet werden, wird der Editor über den entsprechenden Menüeintrag in der linken Spalte erreicht. Auf die Einhaltung der Syntax von Befehlen und Definitionen ist zu achten, teilweise sind besondere Maßnahmen zu ergreifen ("Escapen" von Sonderzeichen, verdoppeln von Semikolon). Mit dem Abspeichern der editierten Datei werden die Änderungen unmittelbar aktiv, korrekte Syntax und Semantik vorausgesetzt.

Seit Februar 2015 ist die Bearbeitung der Konfiguration über den Integrierten Editor als nicht empfohlene Variante standardmäßig gesperrt. Rudolf König dazu: ''"Durch das direkte Editieren der Datei kann FHEM die Fehler der Benutzer nicht so gut abfangen (kein dropdown, wizard, etc), bzw. die Fehlermeldungen sind etwas aufwendiger zu interpretieren, d.h. man muss sie lesen und verstehen. Dass sowas nicht selbstverstaendlich ist, beweist gerade diese Diskussion, und solche Probleme muessen wir (die Supporter) hier im Forum ausbaden. Deswegen sollten die Anfaenger nicht dazu ermuntert werden, die Konfiguration in FHEMWEB direkt zu editieren. Verboten ist es keinesfalls, es wird seit gestern nur eine kleine Huerde (Hinweis + Eintrittspruefung) hingelegt."'' [http://forum.fhem.de/index.php/topic,33839.msg262029.html#msg262029]

==== Syntaxhervorhebung ====
[[Bild:ConfEditDEFAutocomplete.png|mini|300px|rechts|Automatische Vervollständigung / Befehlsauswahlfenster ("se" getippt, dann Strg+Leertaste gedrückt)]]
Fhem besitzt Syntaxhervorhebungs-, Befehlsauswahl- und Befehlsvervollständigungsfunktionen.

Um die Funktionalität zu aktivieren muss folgendes Attribut gesetzt werden:
:<code>attr WEB JavaScripts codemirror/fhem_codemirror.js</code>

Im erweiterten Editor ist Suchen und Ersetzen mit folgenden Tastenkombinationen möglich:
''
* Ctrl-F: Start searching
* Ctrl-G: Find next
* Shift-Ctrl-G: Find previous
* Shift-Ctrl-F: Replace
* Shift-Ctrl-R: Replace all''

Folgende hilfreiche Tastenkombinationen werden desweiteren automatisch erstellt:
* 'TAB' => Einrücken von Text, auch mehrerer markierter Zeilen auf einmal, oder mindestens einer komplett markierten Zeile.
* 'SHIFT + TAB' => Verringern der Einrückung, auch mehrerer markierter Zeilen auf einmal, oder mindestens einer komplett markierten Zeile.
* 'STRG + Q' => Auskommentieren oder Kommentar der Zeile entfernen in welcher sich der Cursor gerade befindet, oder mehrerer markierten Zeilen auf einmal.
* 'STRG + UP' oder 'STRG + DOWN' => Hoch/Runterscrollen des Textes ohne den Cursor umzusetzen.

Der Editor kann mit folgendem Attribut und den Parametern welche unter https://codemirror.net/doc/manual.html#config zu finden sind noch weiter angepasst werden. z.B.:
:<code>attr WEB codemirrorParam { "indentUnit":2 }</code>
In diesem Beispiel würden statt den default 4 Leerzeichen, nurnoch 2 Leerzeichen bei verwenden der 'TAB'-Taste geschrieben.

Die Syntaxhervorhebung / Befehlsvervollständigung, sofern aktiviert, ist wirksam für
* Bearbeitung der [[Konfiguration#Objektdetails|Objektdetails]]
* [[Konfiguration#Integrierter Editor|Integrierter Editor]]

Darüber hinaus wird (wie im Bildauschnitt dargestellt) über Strg+Leertaste eine Befehlsauswahl bzw. automatische Befehlsvervollständigung angeboten.

Der Forums-Thread unter der Überschrift [http://forum.fhem.de/index.php/topic,20444.0.html Javascript Editor einbinden] enthält die Diskussion zum Entwicklungsprozess.

=== Externer Editor ===
Das Editieren der Konfiguration kann auch mit einem externen Editor wie z. B.
* Notepad++ (mit der nppFTP-Erweiterung)
* nano in einer Telnet Sitzung
* in wfftp integrierter / integrierbarer Editor
* ...
erfolgen (duplizieren von Definitionen (auch möglich mit [http://www.fhem.de/commandref#copy copy]), globale Änderungen (auch möglich mit [http://www.fhem.de/commandref#rename rename], [http://www.fhem.de/commandref#attr attr], ..), umsortieren von Definitionen, etc.). In diesem Fall sollte der Benutzer sich mit der Bedienung des Editors in der gewählten Umgebung hinreichend gut auskennen.

Auf die Einhaltung der Syntax von Befehlen und Definitionen ist zu achten, teilweise sind besondere Maßnahmen zu ergreifen ("Escapen" von Sonderzeichen, verdoppeln von Semikolon). Nach dem Abspeichern der editierten Datei werden die Änderungen erst nach erneutem Einlesen der Konfiguration aktiv, korrekte Syntax und Semantik vorausgesetzt.

Notwendige Aktionen nach Durchführung der Änderung: "rereadcfg" oder Neustart von Fhem.

==== Syntaxhervorhebung ====
'''Syntax-Highlighting''' kann bei verschiedenen externen Editoren verwendet werden, näheres s. [[Syntax Highlighting bei externen Editoren]].

== Aufteilung der fhem.cfg in mehrere Konfigurationsdateien ==
Die fhem.cfg kann bei Bedarf mit Hilfe des Befehls [[include]] in mehrere Konfigurationsdateien aufgeteilt werden. Dies ist als '''"Expertenmodus"''' zu betrachten und sollte (wenn überhaupt) nur von erfahreneren Usern angewendet werden.

== Konfiguration in einer SQL Datenbank ==
Seit April 2014 (Fhem-Version 5079) können Definitionen alternativ zur Speicherung in einer einfachen Text-Konfigurationsdatei(en) in einer SQL Datenbank abgelegt werden. Hierzu dienen configDB (Hilfsmodul) und configdb (command), die in der [http://fhem.de/commandref.html#configDB commandref] dokumentiert sind.

Weitere Details zu dieser "Alternative":
* Fhem Forum - [http://forum.fhem.de/index.php/topic,20194.0.html Tester gesucht]
* Fhem Forum - [http://forum.fhem.de/index.php/topic,20117.0.html Vorüberlegungen]

[[Kategorie:FHEM]]

Konfiguration

2015-10-25T17:20:46Z

Rapster:

HttpUtils

2015-08-22T12:51:31Z

Rapster:

= Allgemein =

Das Modul HttpUtils.pm ist sowohl für Modulentwickler, als auch Endanwender gedacht um Daten via HTTP auszutauschen. Es stellt dabei eine Reihe von Funktionen bereit, auf die in diesem Artikel näher eingegangen werden soll.

Erstellt wurde HttpUtils.pm von Rudolf König.

== Die Funktionen im Einzelnen ==

Es ist zu beachten, dass bei den Funktionen

* GetHttpFile
* GetFileFromURL
* GetFileFromURLQuiet
* HttpUtils_BlockingGet

ein sogenannter "blockierender" Aufruf durchgeführt wird. Das bedeutet, dass FHEM bei einem Aufruf einer dieser Funktionen solange wartet und dabei absolut nichts macht, bis die Antwort vom HTTP-Server eintrifft und die Funktion damit beendet ist. Das kann bei Verbindungsproblemen evtl. dazu führen, dass FHEM für die gesamte Wartezeit (Timeout) steht und nichts verarbeitet. Problematisch ist so etwas gerade bei Anwendungen oder Hardware, die eine zeitnahe Reaktion von FHEM erwarten (z.B. HomeMatic-Geräte).

Es wird daher empfohlen die Funktionen so sparsam wie möglich zu verwenden und die Timeouts so niedrig wie möglich zu halten um ein längeres Einfrieren von FHEM möglichst zu verhindern.

Alternativ kann man die Funktion

* HttpUtils_NonblockingGet

verwenden, welche ein Blockieren von FHEM verhindert. Wie das genau funktioniert, wird in dem entsprechenden Kapitel beschrieben.

Folgende Funktionen sind für Modulentwickler/Endanwender zur direkten Nutzung gedacht:

=== GetHttpFile ===

Die Funktion GetHttpFile ist die denkbar einfachste Variante um eine URL aufzurufen.

'''Aufruf: <code>GetHttpFile($server, $file)</code>'''

{| class="wikitable"
|-
! Parameter!! Bedeutung
|-
| style="vertical-align:top" | '''<code>$server</code>'''

''mandatory''
|| Der DNS-Name oder die IP-Adresse des HTTP-Servers 
Beispiel:

* ''<nowiki>www.myhost.com</nowiki>''
* ''<nowiki>192.168.0.10</nowiki>''
|-
| style="vertical-align:top" | '''<code>$file</code>'''

''mandatory''
|| Die Datei, welche auf dem HTTP-Server aufgerufen werden soll. 
Beispiel:
* ''/''
* ''/index.html''
* ''/directory/image.jpg''
|}

Funktionsergebnis ist der Inhalt der aufgerufenen Seite in Form eines Strings.

=== GetFileFromURL ===

Die Funktion GetFileFromURL ruft die HTTP-URL auf und gibt als Funktionsergebnis den Seiteninhalt zurück. Im Gegensatz zu GetHttpFile beinhaltet GetFileFromURL einige Zusatzoptionen in Form von Funktionsparametern.

'''Aufruf: <code>GetFileFromURL($url, ''[$timeout], [$data], [$noshutdown], [$loglevel]'')</code>'''

{| class="wikitable"
|-
! Parameter!! Bedeutung
|-
| style="vertical-align:top" | '''<code>$url</code>'''

''mandatory''
|| Die HTTP-URL, welche aufgerufen werden soll. Diese kann optional Usernamen, Passwort und einen Port enthalten. Sowohl HTTP als auch HTTPS wird hierbei unterstützt. 
Beispiel:

* ''<nowiki>http://www.myhost.com/directory/</nowiki>''
* ''<nowiki>https://www.myhost.com/</nowiki>''
* ''<nowiki>http://www.myhost.com:8080/</nowiki>''
* ''<nowiki>http://foo:bar@www.myhost.com/</nowiki>''
|-
| style="vertical-align:top" | '''<code>$timeout</code>'''

''optional''
|| Die maximale Dauer in Sekunden für die HTTP-Anfrage

Beispiel: 5 ''(Sekunden)''

Standardwert: 4 Sekunden
|-
| style="vertical-align:top" | '''<code>$data</code>'''

''optional''
|| Wenn man Daten via HTTP-POST übertragen möchte, so kann man die Nutzdaten über $data übergeben. Die Daten werden dabei als Formulardaten übertragen. Wenn man den Content-Type beeinflussen oder mehrere Formular-Felder senden möchte, sollte man zur Funktion HttpUtils_BlockingGet oder HttpUtils_NonblockingGet greifen.

Standardwert: ''[leer]''

|-
| style="vertical-align:top" | '''<code>$noshutdown</code>'''

''optional''
|| Wenn $noshutdown auf 1 gesetzt ist, wird dem HTTP-Server nicht implizit mitgeteilt, dass die Verbindung nach dem Request geschlossen werden soll. Viele Webserver schließen in solch einem Fall die Verbindung bevor sie die Antwort senden. Bei 0 wird dem Webserver mitgeteilt, dass der Sendevorgang beendet ist und nun die Antwort abgewartet wird.

Standardwert: 1
|-
| style="vertical-align:top" | '''<code>$loglevel</code>'''

''optional''
|| Das Logleve, in dem sämtliche Logmeldungen zu dieser HTTP-Abfrage erzeugt werden sollen.

Standardwert: 4
|}

Funktionsergebnis ist der Inhalt der aufgerufenen Seite in Form eines Strings.

=== GetFileFromURLQuiet ===

Diese Funktion funktioniert ähnlich wie GetFileFromURL. Allerdings wird die tatsächliche URL in allen erzeugten Log-Meldungen unkenntlich gemacht um z.B. Zugangsdaten nicht preiszugeben. Die aufgerufene Seite wird ebenfalls als Funktionsergebnis zurückgegeben.

'''Aufruf: <code>GetFileFromURLQuiet($url, ''[$timeout], [$data], [$noshutdown], [$loglevel]'')</code>'''

{| class="wikitable"
|-
! Parameter!! Bedeutung
|-
| style="vertical-align:top" | '''<code>$url</code>'''

''mandatory''
|| Die HTTP-URL, welche aufgerufen werden soll. Diese kann optional Usernamen, Passwort und einen Port enthalten. Sowohl HTTP als auch HTTPS wird hierbei unterstützt. 
Beispiel:

* ''<nowiki>http://www.myhost.com/directory/</nowiki>''
* ''<nowiki>https://www.myhost.com/</nowiki>''
* ''<nowiki>http://www.myhost.com:8080/</nowiki>''
* ''<nowiki>http://foo:bar@www.myhost.com/</nowiki>''
|-
| style="vertical-align:top" | '''<code>$timeout</code>'''

''optional''
|| Die maximale Dauer in Sekunden für die HTTP-Anfrage

Beispiel: 5 ''(Sekunden)''

Standardwert: 4 Sekunden
|-
| style="vertical-align:top" | '''<code>$data</code>'''

''optional''
|| Wenn man Daten via HTTP-POST übertragen möchte, so kann man die Nutzdaten über <code>$data</code> übergeben. Die Daten werden dabei als Formulardaten übertragen. Wenn man den Content-Type beeinflussen möchte, oder mehrere Formular-Felder senden möchte, sollte man zur Funktion HttpUtils_BlockingGet oder HttpUtils_NonblockingGet greifen.

Standardwert: ''[leer]''

|-
| style="vertical-align:top" | '''<code>$noshutdown</code>'''

''optional''
|| Wenn $noshutdown auf 1 gesetzt ist, wird dem HTTP-Server nicht implizit mitgeteilt, dass die Verbindung nach dem Request geschlossen werden soll. Viele Webserver schließen in solch einem Fall die Verbindung bevor sie die Antwort senden. Bei 0 wird dem Webserver mitgeteilt, dass der Sendevorgang beendet ist und nun die Antwort abgewartet wird.

Standardwert: 1
|-
| style="vertical-align:top" | '''<code>$loglevel</code>'''

''optional''
|| Das Loglevel, in dem sämtliche Logmeldungen zu dieser HTTP-Abfrage erzeugt werden sollen.

Standardwert: 4
|}

Funktionsergebnis ist der Inhalt der aufgerufenen Seite in Form eines Strings.

=== HttpUtils_BlockingGet ===

Wenn die bisher genannten Funktionen nicht ausreichen um die gewünschte Abfrage durchzuführen, so kann man diese Funktion verwenden. Aufgrund zahlreicher Parameter ermöglicht sie viele Anpassungsmöglichkeiten. Diese Funktion hat dabei nicht wie üblich eine Liste an Funktionsparametern, sondern lediglich einen Parameter, welcher ein Hash mit allen Funktionsparametern darstellt. Dieser Hash enthält sämtliche Parameter inkl. Werten.

'''Aufruf: <code>HttpUtils_BlockingGet($param)</code>'''

Der Parameter $param ist eine Referenz auf eine Hash-Struktur, welche die einzelnen Parameter enthält. Der Hash $param kann folgende Optionen beinhalten:

{| class="wikitable"
|-
! style="width:175px" | Parameter !! style="width:auto" | Bedeutung
|-
| style="vertical-align:top" | '''<code>$param->{url}</code>'''

''mandatory''
|| Die HTTP-URL, welche aufgerufen werden soll. Diese kann optional Usernamen, Passwort und einen Port enthalten. Sowohl HTTP als auch HTTPS wird hierbei unterstützt. 
Beispiel:

* ''<nowiki>http://www.myhost.com/directory/</nowiki>''
* ''<nowiki>https://www.myhost.com/</nowiki>''
* ''<nowiki>http://www.myhost.com:8080/</nowiki>''
* ''<nowiki>http://foo:bar@www.myhost.com/</nowiki>''

|-
| style="vertical-align:top" |'''<code>$param->{timeout}</code>'''

''optional''
|| Die maximale Dauer in Sekunden für die HTTP-Anfrage

Beispiel: 5 ''(Sekunden)''

Standardwert: 4 Sekunden
|-
| style="vertical-align:top" |'''<code>$param->{data}</code>'''

''optional''
|| Wenn man Daten via HTTP-POST übertragen möchte, so kann man die Nutzdaten über <code>$param->{data}</code> übergeben. Die Daten werden dabei als Formulardaten übertragen. Die Daten können dabei auf zwei Arten übergeben werden:

1. Daten als String:
:* Die Daten werden komplett als gesamter String in <code>$param->{data}</code> abgelegt (z.B.: $param->{data} = "Jede Menge tolle Daten").
2. Daten als Hash:
:* Die Daten werden als Hash mit Key-Value-Pairs übergeben (z.B.: $param->{data}{field1} = "value1", $param{data}{field2} = "value2", ... ). Die Daten werden dann als Formulardaten mit mehrfachen Datenfeldern übertragen.

Standardwert: ''[leer]''

|-
| style="vertical-align:top" | '''<code>$param->{noshutdown}</code>'''

''optional''
||Wenn <code>$param->{noshutdown}</code> auf 1 gesetzt ist, wird dem HTTP-Server nicht implizit mitgeteilt, dass die Verbindung nach dem Request geschlossen werden soll. Viele Webserver schließen in solch einem Fall die Verbindung bevor sie die Antwort senden. Bei 0 wird dem Webserver mitgeteilt, dass der Sendevorgang beendet ist und nun die Antwort abgewartet wird.

Standardwert: 1
|-
| style="vertical-align:top" | '''<code>$param->{loglevel}</code>'''

''optional''
|| Das Loglevel, in dem sämtliche Logmeldungen zu dieser HTTP-Abfrage erzeugt werden sollen.

Standardwert: 4
|-
| style="vertical-align:top" | '''<code>$param->{hideurl}</code>'''

''optional''
|| Wenn dieser Parameter den Wert 1 trägt, wird die URL in sämtlichen Log-Ausgaben unkenntlich gemacht. Dies ist nützlich um z.B. Zugangsdaten geheim zu halten.

Standardwert: 0
|-
| style="vertical-align:top" | '''<code>$param->{ignoreredirects}</code>'''

''optional''
|| Wenn dieser Parameter den Wert 1 trägt, werden Umleitungen durch den Server ignoriert und der Request beendet. Dies kann erforderlich sein um evtl. Cookies aus der Antwort, welche eine Umleitung enthält aus dem HTTP Header zu extrahieren um diese im nächsten Request weiterzuverwenden.

Standardwert: 0
|-
| style="vertical-align:top" | '''<code>$param->{method}</code>'''

''optional''
||Die HTTP-Methode, welche zur Abfrage verwendet werden soll. Sofern keine Daten übertragen werden ist dies standardmäßig "GET", ansonsten "POST". Es können aber auch andere Methoden verwendet werden.

Standardwert: "GET"
|-
| style="vertical-align:top" | '''<code>$param->{header}</code>'''

''optional''
|| Eigene HTTP-Header-Zeilen können über diesen Parameter eingebracht werden. Er kann dazu genutzt werden um z.B. den Content-Type festzulegen, oder einfach nur zusätzliche Header-Felder zu setzen. Mehrere Header-Zeilen müssen dabei mit "\r\n" getrennt werden.

Beispiel:
* <code>User-Agent: Mozilla/1.22'''\r\n'''Content-Type: application/xml</code>
* <code>Content-Type: application/xml</code>

Standardwert: ''[leer]''
|-
| style="vertical-align:top" | '''<code>$param->{sslargs}</code>'''

''optional''
|| Eigene SSL-Optionen können über diesen Parameter eingebracht werden. Er kann dazu genutzt werden um z.B. die SSL-Zertifikats Verifikation abzuschalten. Die SSL-Optionen müssen als eigene Hash-Referenz übergeben werden.

Beispiel:
* <code>$param->{sslargs} = { SSL_verify_mode => 'SSL_VERIFY_NONE', sslOpt2 => 'sslVal2' }</code>

Standardwert: ''{ }''
|-
| style="vertical-align:top" | '''<code>$param->{httpversion}</code>'''

''optional''
|| Die HTTP-Version, welche zur Abfrage verwendet werden soll. Standardmäßig werden alle Abfragen mit HTTP/1.0 durchgeführt. Falls es jedoch notwendig ist HTTP/1.1 zu verwenden, so sollte <code>$param->{httpversion}</code> auf "1.1" gesetzt werden. Bei Version 1.1 wird automatisch der Header "<code>Connection: close</code>" implizit mitgesendet.

Standardwert: "1.0"
|}

Als Rückgabewert von HttpUtils_BlockingGet wird ein Array mit 2 Rückgabewerten zurückgegeben:

($err, $data) = HttpUtils_BlockingGet( … )

Diese 2 Rückgabewerten haben folgende Bedeutung:

{| class="wikitable"
|-
! Rückgabewert !! Bedeutung
|-
| style="vertical-align:top" | '''<code>$err</code>'''|| Falls beim Aufruf der URL ein Fehler aufgetreten ist (z.B. Server nicht erreichbar oder Verbindungstimeout), dann ist dieser Wert mit einer Fehlermeldung gefüllt.

Wenn kein Fehler aufgetreten ist, ist dieser Wert mit einem Leerstring gefüllt (<code>$err = ""</code>)
|-
| style="vertical-align:top" | '''<code>$data</code>'''|| Die Ergebnisdaten, welche der HTTP-Server zurückgeliefert hat. Die Daten werden als Klartext in Form eines gesamten Strings zurückgegeben.

Falls ein Fehler aufgetreten ist, ist dieser Wert mit einem Leersting gefüllt (<code>$data = ""</code>)
|}

=== HttpUtils_NonblockingGet ===
{{Randnotiz|RNText=Die Funktion HttpUtils_NonblockingGet ist nicht komplett durchgehend "non-blocking". DNS-Abfragen sind nachwievor blockierend. Insbesondere wenn der DNS-Name nicht aufgelöst werden kann.}}
Diese Funktion arbeitet ähnlich wie HttpUtils_BlockingGet. Allerdings wird das Ergebnis nicht als Funktionsergebnis zurückgegeben. Die Funktion HttpUtils_NonblockingGet initiiert den Verbindungsaufbau und übergibt alles weitere an FHEM interne Routinen. Sobald eine Antwort vom HTTP-Server eintrifft, wird eine Callback-Funktion mit verschiedenen Parametern (unter anderem auch das Ergebnis) aufgerufen, um die Antwort entgegenzunehmen und weiter zu verarbeiten.

Der Aufruf ist daher ähnlich zu HttpUtils_BlockingGet mit nur einem Parameter-Hash:

'''Aufruf: <code>HttpUtils_NonblockingGet($param)</code>'''

{| class="wikitable"
|-
! style="width:175px" | Parameter !! style="width:auto" | Bedeutung
|-
| colspan="2" style="text-align:center" | ''''' Alle Hash-Parameter, welche für HttpUtils_BlockingGet gelten, sind auch für HttpUtils_NonblockingGet gültig''''' 
|-
| style="vertical-align:top" | '''<code>$param->{callback}</code>'''

''mandatory''
|| Eine Funktion (oder eine Referenz auf eine Funktion), welche die Ergebnisdaten entgegennimmt und die Antwort entsprechend weiterverarbeitet. Die Callback-Funktion muss dabei 3 Parameter erwarten. Die Funktionsparameter der Callback-Funktion werden im nachfolgenden Abschnitt näher erläutert.

Beispiel:
* <code>$param->{callback} = \&MyCallbackFn</code> — ''(Referenzzeiger auf Funktionsname)''
* <code>$param->{callback} = sub($$$){ … }</code> — ''(direkte Funktionsdefinition)''
|-
| style="vertical-align:top" | ''Benutzerdefinierte Parameter''
|| Es können im Hash weitere benutzerdefinierte Parameter gesetzt werden, welche evtl. in der Callback-Funktion benötigt werden, um die Antwort korrekt zu verarbeiten.

Zum Beispiel bei der Modul-Programmierung währe das $hash des aktuellen Devices. Alle gesetzten Parameter sind in der Callback-Funktion direkt abrufbar und können ausgewertet werden.

Beispiel:
* <code>$param->{hash} = $hash</code>
* <code>$param->{command} = "on"</code>

|}

Ein Funktionsrückgabewert von HttpUtils_NonblockingGet existiert nicht, da die eigentliche Rückgabe der Daten über die Callback-Funktion erfolgt. Die Callback-Funktion wird aufgerufen, sobdald der HTTP-Request abgeschlossen ist, oder ein Fehler aufgetreten ist. Der Funktionsaufruf erfolgt mit den folgenden Parametern:

<code> ''MyCallbackFn'' ( $param, $err, $data )</code>

Diese 3 Parameter haben dabei folgende Bedeutung:

{| class="wikitable"
|-
! Parameter !! Bedeutung
|-
| style="vertical-align:top" | '''<code>$param</code>''' || Der Parameter-Hash, mit allen Argumenten die beim Aufruf der Funktion übergeben worden sind.

Es ist möglich, dass der Parameter-Hash nach erfolgter Abfrage zusätzliche oder veränderte Elemente enthält:
* '''<code>$param->{redirects}</code>''' - Die Anzahl an Umleitungen die erfolgte, bis die Anfrage beantwortet wurde.
* '''<code>$param->{url}</code>''' - Die URL, die nach erfolgter Umleitung die Anfrage beantwortet hat.
* '''<code>$param->{protocol}</code>''' - Das verwendete Protokoll, welches zur Abfrage verwendet wurde ("http" oder "https").
* '''<code>$param->{path}</code>''' - Der Pfad, welcher auf dem HTTP-Server angefragt wurde.
* '''<code>$param->{host}</code>''' - Der Name oder die IP-Adresse des HTTP-Servers.
* '''<code>$param->{httpheader}</code>''' - Der gesamte HTTP Header, welcher der Server bei der letzten Antwort zurücklieferte.
* '''<code>$param->{code}</code>''' - Der HTTP-Statuscode, mit dem die Anfrage vom Server beantwortet wurde.
* '''<code>$param->{addr}</code>''' - Die HTTP-URL ohne Pfad und evtl. Authentifizerungsinformationen des HTTP-Servers (z.B. "<nowiki>http://myserver.com:8080</nowiki>").
* '''<code>$param->{auth}</code>''' - Der Authentifizierungs-String, welcher verwendet wurde um sich gegenüber dem HTTP-Server zu authentifizieren (nur wenn Authentifizierung benutzt wurde).
|-
| style="vertical-align:top" | '''<code>$err</code>'''|| Falls beim Aufruf der URL ein Fehler aufgetreten ist (z.B. Server nicht erreichbar oder Verbindungstimeout), dann ist dieser Wert mit einer Fehlermeldung gefüllt.

Wenn kein Fehler aufgetreten ist, ist dieser Wert mit einem Leerstring gefüllt (<code>$err = ""</code>)
|-
| style="vertical-align:top" | '''<code>$data</code>'''|| Die Ergebnisdaten, welche der HTTP-Server zurückgeliefert hat. Die Daten werden als Klartext in Form eines gesamten Strings zurückgegeben. Es handelt sich hierbei ausschließlich um den HTTP-Body.

Falls ein Fehler aufgetreten ist, ist dieser Wert mit einem Leersting gefüllt (<code>$data = ""</code>)
|}

Die Callback-Funktion kann nun die Daten aus der HTTP-Antwort verarbeiten oder bei Fehler entsprechende Log-Meldungen ausgeben.

==== Beispiel für HttpUtils_NonblockingGet() für Modulprogrammierer ====

Das folgende Beispiel soll eine Hilfestellung für eigene Anwendungen geben

<pre>use HttpUtils;
sub X_GetHttpResponse($)
{
my ($hash, $def) = @_;
my $name = $hash->{NAME};
my $param = {
url => "http://www.foo.de",
timeout => 5,
hash => $hash, # Muss gesetzt werden, damit die Callback funktion wieder $hash hat
method => "GET", # Lesen von Inhalten
header => "agent: TeleHeater/2.2.3\r\nUser-Agent: TeleHeater/2.2.3\r\nAccept: application/json", # Den Header gemäss abzufragender Daten ändern
callback => \&X_ParseHttpResponse # Diese Funktion soll das Ergebnis dieser HTTP Anfrage bearbeiten
};

HttpUtils_NonblockingGet($param); # Starten der HTTP Abfrage. Es gibt keinen Return-Code.

}

sub X_ParseHttpResponse($)
{

my ($param, $err, $data) = @_;
my $hash = $param->{hash};
my $name = $hash->{NAME};

if($err ne "") # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist
{
Log3 $name, 3, "error while requesting ".$param->{url}." - $err"; # Eintrag fürs Log
readingsSingleUpdate($hash, "fullResponse", "ERROR"); # Readings erzeugen
}

elsif($data ne "") # wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes)
{
Log3 $name, 3, "url ".$param->{url}." returned: $data"; # Eintrag fürs Log

# An dieser Stelle die Antwort parsen / verarbeiten mit $data

readingsSingleUpdate($hash, "fullResponse", $data); # Readings erzeugen
}

# Damit ist die Abfrage zuende.
# Evtl. einen InternalTimer neu schedulen
}</pre>

[[Kategorie:Development]]