Loxone Webservices

ALLGEMEIN

• Web-Service-Befehle unterstützen sowohl den internen als auch den externen Zugriff.
• Der aktuelle Miniserver unterstützt zudem HTTPS.

Der Aufbau eines Web-Service-Befehls lautet wie folgt:

http://user:password@IPAddressMiniserver/command/control/value.

Aus Sicherheitsgründen wird beim Miniserver Gen. 1 empfohlen, die Zugangsdaten beim Eingeben eines Befehls in die Adressleiste wegzulassen.

Stattdessen fordert der Browser die Login-Daten in einem separaten Fenster an.

Einige Befehle erfordern einen Benutzer mit Vollzugriff.

Nach der Ausführung des Befehls wird das Ergebnis im Browser angezeigt.

Zum Beispiel ruft der folgende Befehl die aktuelle Softwareversion des Miniservers ab:

Wenn der Befehl erfolgreich ist, enthält die Antwort den Statuscode „200“, was bedeutet, dass die Anfrage akzeptiert und verarbeitet wurde.

Aufbau im Detail

• control: kann jeder Ein- oder Ausgang sein, real oder virtuell. Ausgänge können nur für Statusabfragen verwendet werden.
• value: Wenn „value“ nicht angegeben wird, wird der aktuelle Wert der Steuerung zurückgegeben.
  • Für digitale Werte sind folgende Eingaben erlaubt:
    • „Ein“, „On“, „Aus“, „Off“, „1“, „0“, „Impuls“ oder „Pulse“.

Bei virtuellen digitalen Eingängen mit zwei Ausgängen (z. B. auf/ab, links/rechts, ab Version 1.5.4.16) sind folgende Werte erlaubt:

• Für analoge Eingänge sind folgende Werte erlaubt:
  • (0–10 V)-Eingänge arbeiten im Bereich von 0 bis 10,00.
  • Es gibt keine formale Begrenzung (z. B. sind Temperaturen wie 21.5 oder -5.2 gültig).
  • Als Dezimaltrennzeichen wird ein Punkt (.) verwendet.
• Für Texteingaben sind folgende Werte erlaubt:
  • Der Miniserver verwendet UTF-8, daher sollten alle Zeichen, die von UTF-8 unterstützt werden, korrekt funktionieren.

Beispiel – Impuls Eingang

Bevor ein Puls an das System gesendet werden kann, benötigt der Miniserver einen virtuellen Eingang, der den Befehl akzeptiert.

Sobald der virtuelle Eingang hinzugefügt und im Miniserver gespeichert wurde, muss der Befehl gesendet werden.

Nachfolgend ein Beispiel, wie eine Drittanbieteranwendung einen Pulsbefehl an den Loxone Miniserver sendet:

In diesem Beispiel werden die Standard-Anmeldedaten verwendet (Benutzername: admin, Passwort: admin) sowie der virtuelle Eingang mit dem Namen „Test Input“.

Durch das Drücken der „Senden“-Taste in der Anwendung wird der Befehl über die IP-Adresse an den Miniserver gesendet, dieser meldet sich an und verarbeitet den Befehl.

Wird der Befehl erfolgreich gesendet, lautet die Rückmeldung im XML-Format:

In der Loxone Config wird der virtuelle Eingang für einen kurzen Moment aufleuchten, wenn der „Live View“ aktiviert ist.

*In these examples, Postman is the 3rd party app being used to send the commands.

STATUS & SCHALTEN

STATUSABFRAGE EINES CONTROL

Statusabfragen über den Web-Service sind nur für Ein- und Ausgänge möglich und nicht für Funktionsbausteine.

TASTER

Beispiel – Taster Baustein

Bevor ein Befehl an das System gesendet werden kann, benötigt der Miniserver einen Taster-Funktionsbaustein, der den Befehl akzeptiert.

Sobald der Taster hinzugefügt und im Miniserver gespeichert wurde, muss der Befehl gesendet werden.

Nachfolgend ein Beispiel, wie eine Drittanbieteranwendung einen „On“-Befehl an den Loxone Miniserver sendet:

In diesem Beispiel werden die Standard-Anmeldedaten verwendet (Benutzername: admin, Passwort: admin) sowie der Taster mit dem Namen „Push-Button“. Durch das Drücken der „Senden“-Taste in der Anwendung wird der Befehl über die IP-Adresse an den Miniserver gesendet, dieser meldet sich an und verarbeitet den Befehl. Der letzte Teil des Befehls kann je nach Situation auf „On“ oder „Off“ geändert werden.

Wird der Befehl erfolgreich gesendet, lautet die Rückmeldung im XML-Format:

Der Code „200“ bedeutet, dass der Befehl akzeptiert und verarbeitet wurde.

Im Loxone Interface wird der Taster je nach gesendetem Befehl („On“/„Off“) den Zustand entsprechend ändern.

*In diesen Beispielen wird die Drittanbieteranwendung „Postman“ verwendet, um die Befehle zu senden.

ABFRAGE: STATUSÄNDERUNGEN

Miniserver-Konfiguration, Statistiken & Befehle

Die folgenden Befehle bieten Systemsteuerung, SPS-Operationen, Netzwerkstatistiken und Konfigurationsoptionen für den Miniserver.

1. SPS-Befehle (Speicherprogrammierbare Steuerung) oder PLC-Befehle (Programmable Logic Controller)

Diese Befehle ermöglichen es Ihnen, das SPS-System zu überwachen und zu steuern.

2. Konfigurationsbefehle

Diese Befehle ermöglichen es Ihnen, Miniserver-Einstellungen abzurufen oder zu ändern.

3. Systemüberwachungsbefehle

Diese Befehle liefern Informationen zur Systemleistung und Statistiken

4. Datum- und Uhrzeitverwaltung

Systemdatum und -uhrzeit verwalten

5. Task-Überwachung

Status und Eigenschaften der Systemaufgaben abrufen

6. Systemsteuerung & Dateiverwaltung

Diese Befehle ermöglichen das Neustarten des Miniservers und die Verwaltung von Systemdateien.

7. Systemprotokolle (logs) & Statistiken

Protokolle (logs) und Systemdaten abrufen

8. Ausführung externer Web-Services

Web-Service-Anfragen an externe Geräte senden

Befehle für Geräte

Extensions

Die folgenden Befehle gelten für Erweiterungen.

Zur Ausführung ist ein Benutzer mit Vollzugriffsrechten erforderlich.

Tree und Air Geräte

Die folgenden Befehle gelten für bestimmte Air- oder Tree-Geräte.

Zur Ausführung ist ein Benutzer mit Vollzugriffsrechten erforderlich.

Verwendung der Miniserver-Weboberfläche in einem iFrame

Standardmäßig erlaubt der Miniserver aus Sicherheitsgründen keine Einbettung in einen iFrame. Um diese Funktion zu aktivieren, muss sie explizit mit dem folgenden Web-Service-Befehl freigegeben werden:

http://<miniserver-ip>/dev/sys/allowhttpiframe/1