Difference between revisions of "Add-On Services/de"

From meteobridge
Jump to: navigation, search
(Updating to match new version of source page)
 
(20 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
<languages /><br />Der in Meteobridge enthaltene Web-Server kann neben der Realisierung des Administrationsinterfaces auch Anfragen zu den aktuell vorliegenden Wetterdaten beantworten. Es sind drei HTTP-Dienste definiert, unter denen man diese Daten abrufen kann, entweder in standardisierter Form als Textdatei oder als XML-Datenstrom oder in einem bentzerdefinierten Format. Auch wenn es aus Sicherheitsgründen nicht empfehlenswert ist, diesen Zugang für einen Zugriff von außerhalb des LANs zu öffnen, könnte man beim Aufschalten der Firewall des LANs diese Art der Abfragemöglichkeit für Anfragen von Außen zugänglich machen. Für die Anlieferung von Daten ins Internet empfehlen sich die die unter [[Push_Services/de|Sendedienste]] aufgeführten Methoden.
 
<languages /><br />Der in Meteobridge enthaltene Web-Server kann neben der Realisierung des Administrationsinterfaces auch Anfragen zu den aktuell vorliegenden Wetterdaten beantworten. Es sind drei HTTP-Dienste definiert, unter denen man diese Daten abrufen kann, entweder in standardisierter Form als Textdatei oder als XML-Datenstrom oder in einem bentzerdefinierten Format. Auch wenn es aus Sicherheitsgründen nicht empfehlenswert ist, diesen Zugang für einen Zugriff von außerhalb des LANs zu öffnen, könnte man beim Aufschalten der Firewall des LANs diese Art der Abfragemöglichkeit für Anfragen von Außen zugänglich machen. Für die Anlieferung von Daten ins Internet empfehlen sich die die unter [[Push_Services/de|Sendedienste]] aufgeführten Methoden.
 
Hinweis: Um die HTTP-Dienste aufrufenzu können ist eine HTTP-Authentifizierung mit Benutzernamen und Passwort notwendig. Diese erfolgt als Präfix zur URL in der Form "<Benutzername>:<Passwort>@".
 
Hinweis: Um die HTTP-Dienste aufrufenzu können ist eine HTTP-Authentifizierung mit Benutzernamen und Passwort notwendig. Diese erfolgt als Präfix zur URL in der Form "<Benutzername>:<Passwort>@".
 
===Live-Daten als XML===
 
Mit dem Meteobridge HTTP-Request wie "http://ip-of-meteobridge/cgi-bin/livedataxml.cgi", wobei "ip-of-meteobridge" durch die korrekte IP der Meteobridge ersetzt werden muss, liefert Meteobridge Wetterdaten in XML-Notation aus. Die von Meteobridge erzeugte Ausgabe beginnt mit "<logger>" und endet mit "</logger>". Die Werte der Sensoren werden mit den sensorspezifischen Tags "THB", "TH", "WIND", "RAIN", "UV", "SOLAR" berichtet. Das anhängende Beispiel illustriert das XML-Format:
 
  
===Live Data as XML===
+
===Live-Daten als XML===
By sending the meteobridge a HTTP request like "http://ip-of-meteobridge/cgi-bin/livedataxml.cgi" (where "ip-of-meteobridge" must be replaced by the IP itself) meteobridge returns current weather data in XML notation. Each reply starts witch tag <logger> and ends with </logger> with the sensor data as records with sensor specific tags "THB", "TH", "WIND", "RAIN", "UV", "SOLAR". Example below illustrates the XML format:
+
Mit dem Meteobridge HTTP-Request wie "http://ip-of-meteobridge/cgi-bin/livedataxml.cgi", wobei "ip-of-meteobridge" durch die korrekte IP der Meteobridge ersetzt werden muss, liefert Meteobridge Wetterdaten in XML-Notation aus. Die von Meteobridge erzeugte Ausgabe beginnt mit "<logger>" und endet mit "</logger>". Die Werte der Sensoren werden mit den sensorspezifischen Tags "THB", "TH", "SOIL", "LEAF", "WIND", "RAIN", "UV", "SOLAR" berichtet. Das anhängende Beispiel illustriert das XML-Format:
  
 
<pre><logger>
 
<pre><logger>
Line 21: Line 18:
 
* '''id''': ID des Sensors, die aus einem Sensorkurzbezeichnung gefolgt von einer Zahl ("0") besteht.  
 
* '''id''': ID des Sensors, die aus einem Sensorkurzbezeichnung gefolgt von einer Zahl ("0") besteht.  
 
* '''temp''': Temperatur in Grad Celsius (mit einer Nachkommastelle)
 
* '''temp''': Temperatur in Grad Celsius (mit einer Nachkommastelle)
* '''hum''': Relative Luftfeuchte in Prozent (keine Nachkommastellen)
+
* '''hum''': Relative Luftfeuchte in Prozent (keine Nachkommastellen) oder Angabe als wettness oder centibar bei LEAF oder SOIL Sensoren
 
* '''dew''': Taupunkttemperatur in Grad Celsius (mit einer Nachkommastelle)
 
* '''dew''': Taupunkttemperatur in Grad Celsius (mit einer Nachkommastelle)
 
* '''press''': Luftdruck auf Stationshöhe ohne Höhenkorrektur in hPa (mit einer Nachkommastelle)
 
* '''press''': Luftdruck auf Stationshöhe ohne Höhenkorrektur in hPa (mit einer Nachkommastelle)
Line 43: Line 40:
 
20130104142652 wind0 160 2.2 1.8 8.0</pre>
 
20130104142652 wind0 160 2.2 1.8 8.0</pre>
  
===Live Data via Socket Connection=== <!--T:6-->
+
===Live-Daten über eine Socket-Verbindung===
Methods introduced above do need HTTP authentification like all elements of Meteobridge web interface. A look at the script "livedataxml.cgi" shows that this just reads data from socket 5557, gives it a suitable HTTP header and returns that to the requesting browser:
+
Bei den oben angegebenen Verfahren wird eine HTTP-Authentifizierung wie für das gesamte Meteobridge Web-Interface benötigt. Wenn man sich das Skript "livedataxml.cgi" ansieht, kann man erkennen, dass dieses ledglich Daten vom Port 5557 liest, mit einem HTTP-Header versieht und dann an den anfragenden Browser ausliefert:
  
<!--T:7-->
 
 
<pre>#!/bin/sh
 
<pre>#!/bin/sh
 
echo -ne "Content-type: text/xml; charset=UTF-8\n\n"
 
echo -ne "Content-type: text/xml; charset=UTF-8\n\n"
Line 52: Line 48:
 
</pre>
 
</pre>
  
<!--T:8-->
+
Im Ergebnis entspricht ein Auslesen des Ports 5557 dem Aufruf von "livedataxml.cgi" und eine Abfrage von Port 5556 dem Skript "livedata.cgi".
Therefore, reading data from socket 5557 is equivalent to calling "livedataxml.cgi" and socket 5556 reports same data as delivered by "livedata.cgi".
+
  
===Template-based Individual Data=== <!--T:9-->
+
===Template-basierende individuelle Daten===
Scripts presented before return data in a standard format. As a variant you can also define a template like explained in Template section of this wiki, hand that over to "template.cgi" script and get a filled template in return.
+
Der vorangegangenen Skripte liefern Daten in einem Standardformat aus. Unter Verweundung des Meteobridge-Template-Mechanismus, der auch hier im Wiki beschriebven ist, kann mit dem Skript "template.cgi" eine angepasste Ausgabe von Meteobridge-Variablen in Form eines mit Daten gefüllten Templates erreicht werden.
  
<!--T:10-->
+
Das Skript wird mit der URL "http://ip-of-meteobridge/cgi-bin/template.cgi" aufgerufen. Dabei ist das zu füllende Template als Parameter in der Form "template=DEIN_TEMPLATE_TEXT" mitzugeben. Als optionaler Parameter kann der in der HTTP-Antwort zu verwendende Content-Type mitgegeben via "contenttype=CONTENT_TYPE" mitgegeben werden. Beide Parameter müssen URL-codiert übergeben werden, wobei Sonderzeichen als "%XX" (XX ist der zweistellige Hexadezimalkode) und Leerzeichen als "+" zu spezifizieren sind.
URL to call is "http://ip-of-meteobridge/cgi-bin/template.cgi" with mandatory parameter "template=YOUR_TEMPLATE_TEXT" and optional paramater "contenttype=CONTENT_TYPE". Both parameters have to be URL-encoded with special characters represented as "%XX" (where XX is a two digit hex code) and spaces are represented by "+".
+
  
<!--T:11-->
+
Beispiel: Um die aktuelle Außentemperatur und Feuchte zu erhalten, liefert die URL <pre>http://ip-des-meteobridge/cgi-bin/template.cgi?template=[DD].[MM].[YY]+[HH]:[mm][APM]%0D[th0temp-act]%BAC%0d[th0hum-act]%25&contenttype= " text/plain;charset=iso-8859-1</pre>
Example: In oder to get current outdoor temp and humidity this URL<pre>http://ip-of-meteobridge/cgi-bin/template.cgi?template=[DD].[MM].[YY]+[HH]:[mm][APM]%0D[th0temp-act]%BAC%0d[th0hum-act]%25&contenttype=text/plain;charset=iso-8859-1</pre>
+
die folgende Ausgabe <pre>01.06.13 04:55PM
returns <pre>01.06.13 04:55PM
+
 
23.2ºC
 
23.2ºC
 
61.0%</pre>
 
61.0%</pre>
 +
 +
==Zusätzliche Eigenschaften der Meteobridge PRO==
 +
Die Meteobridge PRO ermöglicht Templates auf dem PC-Netzwerklaufwerk "/data/templates/" abzulegen. Durch Aufruf von "http://ip-of-meteobridge/cgi-bin/template.cgi?templatefile=mydata.http" wird die Datei "mydata.http" im Ordner "/data/templates" mit aktuellen Daten gefüllt und ausgeliefert.
 +
 +
Beispiel: Es existiert eine Template-Datei "mydata.http" im Template-Ordner:
 +
<pre>[DD].[MM].[YY] [HH]:[mm][APM]
 +
[th0temp-act]°C
 +
[th0hum-act]%</pre>
 +
Request "http://ip-of-meteobridge/cgi-bin/template.cgi?templatefile=mydata.http&contenttype=text/plain;charset=utf-8" returns this:
 +
<pre>08.01.16 11:00AM
 +
3.5°C
 +
94.0%</pre>

Latest revision as of 08:23, 16 June 2018

<languages />
Der in Meteobridge enthaltene Web-Server kann neben der Realisierung des Administrationsinterfaces auch Anfragen zu den aktuell vorliegenden Wetterdaten beantworten. Es sind drei HTTP-Dienste definiert, unter denen man diese Daten abrufen kann, entweder in standardisierter Form als Textdatei oder als XML-Datenstrom oder in einem bentzerdefinierten Format. Auch wenn es aus Sicherheitsgründen nicht empfehlenswert ist, diesen Zugang für einen Zugriff von außerhalb des LANs zu öffnen, könnte man beim Aufschalten der Firewall des LANs diese Art der Abfragemöglichkeit für Anfragen von Außen zugänglich machen. Für die Anlieferung von Daten ins Internet empfehlen sich die die unter Sendedienste aufgeführten Methoden. Hinweis: Um die HTTP-Dienste aufrufenzu können ist eine HTTP-Authentifizierung mit Benutzernamen und Passwort notwendig. Diese erfolgt als Präfix zur URL in der Form "<Benutzername>:<Passwort>@".

Live-Daten als XML

Mit dem Meteobridge HTTP-Request wie "http://ip-of-meteobridge/cgi-bin/livedataxml.cgi", wobei "ip-of-meteobridge" durch die korrekte IP der Meteobridge ersetzt werden muss, liefert Meteobridge Wetterdaten in XML-Notation aus. Die von Meteobridge erzeugte Ausgabe beginnt mit "<logger>" und endet mit "</logger>". Die Werte der Sensoren werden mit den sensorspezifischen Tags "THB", "TH", "SOIL", "LEAF", "WIND", "RAIN", "UV", "SOLAR" berichtet. Das anhängende Beispiel illustriert das XML-Format:

<logger>
  <THB date="20121227224318" id="thb0" temp="26.0" hum="37" dew="10.2" 
       press="1008.8" seapress="1010.1" fc="2"/>
  <TH date="20130104141909" id="th0" temp="9.1" hum="95" dew="8.3"/>
  <RAIN date="20130104141856" id="rain0" rate="0.0" total="3.0" delta="0.0"/>
  <WIND date="20130104141916" id="wind0" dir="109" gust="0.9" wind="2.2" chill="9.1"/>
</logger>

Jedes Sensordatenpaket enthält immer die Felder "date" und "id". Die anderen Parameter sind sensorspezifisch. Die Bedeutung der Parameter ist wie folgt:

  • date: UTC Zeitstempel der Sensordaten im Format "JJJJMMTThhmmss"
  • id: ID des Sensors, die aus einem Sensorkurzbezeichnung gefolgt von einer Zahl ("0") besteht.
  • temp: Temperatur in Grad Celsius (mit einer Nachkommastelle)
  • hum: Relative Luftfeuchte in Prozent (keine Nachkommastellen) oder Angabe als wettness oder centibar bei LEAF oder SOIL Sensoren
  • dew: Taupunkttemperatur in Grad Celsius (mit einer Nachkommastelle)
  • press: Luftdruck auf Stationshöhe ohne Höhenkorrektur in hPa (mit einer Nachkommastelle)
  • seapress: Luftdruck auf Meeresspiegelhöhe zurückgerechnet in hPa (mit einer Nachkommastelle)
  • fc: Vorhersage, sofern von der Wetterstation bereitgestellt. Da dieser Wert wenig zuverlässig ist, raten wir davon ab, diesen zu verwenden.
  • rate: Regenrate in mm pro Stunde (mit einer Nachkommastelle).
  • total: Aktueller Wert des Regenwippenzählers umgerechnet auf mm (mit einer Nachkommastelle).
  • delta: Hinzugekommene Regenmenge in mm seit dem letzten Auslesen (mit einer Nachkommastelle).
  • wind: Aktuelle gemittelte Windgeschwindigkeit im m/s (mit einer Nachkommastelle).
  • gust: Aktuelle, nicht gemittelte Windgeschwindigkeit in m/s (mit einer Nachkommastelle).
  • dir: Windrichtung in Grad (0-359, keine Nachkommastellen).
  • chill: Windchill-Temperatur in Grad Celsius (mit einer Nachkommastelle).
  • ...

Live-Daten als Textdatei

Mit dem HTTP-Request "http://ip-of-meteobridge/cgi-bin/livedata.cgi", wobei "ip-of-meteobridge" durch die IP der Meteobridge zu ersetzen ist, gibt Meteobridge die aktuellen Sensorwerte als Textdatei aus. Das Ergebnis besteht aus einer Reiehe von Zeilen, die jeweils einen Sensor mit seinen Werten repräsentieren. Die Struktur ist gleich der XML-Daten im vorangegangenen Abschnitt, jedoch ohne die umgebende XML-Struktur:

20130104142614 thb0 26.9 38 11.4 1020.4 1021.7 2
20130104142610 rain0 0.0 3.0 0.0
20130104142636 th0 9.1 95 8.3
20130104142652 wind0 160 2.2 1.8 8.0

Live-Daten über eine Socket-Verbindung

Bei den oben angegebenen Verfahren wird eine HTTP-Authentifizierung wie für das gesamte Meteobridge Web-Interface benötigt. Wenn man sich das Skript "livedataxml.cgi" ansieht, kann man erkennen, dass dieses ledglich Daten vom Port 5557 liest, mit einem HTTP-Header versieht und dann an den anfragenden Browser ausliefert:

#!/bin/sh
echo -ne "Content-type: text/xml; charset=UTF-8\n\n"
nc 127.0.0.1 5557 2>/dev/null

Im Ergebnis entspricht ein Auslesen des Ports 5557 dem Aufruf von "livedataxml.cgi" und eine Abfrage von Port 5556 dem Skript "livedata.cgi".

Template-basierende individuelle Daten

Der vorangegangenen Skripte liefern Daten in einem Standardformat aus. Unter Verweundung des Meteobridge-Template-Mechanismus, der auch hier im Wiki beschriebven ist, kann mit dem Skript "template.cgi" eine angepasste Ausgabe von Meteobridge-Variablen in Form eines mit Daten gefüllten Templates erreicht werden.

Das Skript wird mit der URL "http://ip-of-meteobridge/cgi-bin/template.cgi" aufgerufen. Dabei ist das zu füllende Template als Parameter in der Form "template=DEIN_TEMPLATE_TEXT" mitzugeben. Als optionaler Parameter kann der in der HTTP-Antwort zu verwendende Content-Type mitgegeben via "contenttype=CONTENT_TYPE" mitgegeben werden. Beide Parameter müssen URL-codiert übergeben werden, wobei Sonderzeichen als "%XX" (XX ist der zweistellige Hexadezimalkode) und Leerzeichen als "+" zu spezifizieren sind.

Beispiel: Um die aktuelle Außentemperatur und Feuchte zu erhalten, liefert die URL
http://ip-des-meteobridge/cgi-bin/template.cgi?template=[DD].[MM].[YY]+[HH]:[mm][APM]%0D[th0temp-act]%BAC%0d[th0hum-act]%25&contenttype= " text/plain;charset=iso-8859-1
die folgende Ausgabe
01.06.13 04:55PM
23.2ºC
61.0%

Zusätzliche Eigenschaften der Meteobridge PRO

Die Meteobridge PRO ermöglicht Templates auf dem PC-Netzwerklaufwerk "/data/templates/" abzulegen. Durch Aufruf von "http://ip-of-meteobridge/cgi-bin/template.cgi?templatefile=mydata.http" wird die Datei "mydata.http" im Ordner "/data/templates" mit aktuellen Daten gefüllt und ausgeliefert.

Beispiel: Es existiert eine Template-Datei "mydata.http" im Template-Ordner:

[DD].[MM].[YY] [HH]:[mm][APM]
[th0temp-act]°C
[th0hum-act]%

Request "http://ip-of-meteobridge/cgi-bin/template.cgi?templatefile=mydata.http&contenttype=text/plain;charset=utf-8" returns this:

08.01.16 11:00AM
3.5°C
94.0%