Servermodus

Der Servermodus ermöglicht die Ausführung spezieller Aktionen innerhalb einer Statusanzeige oder eines Grundrisses. Die Befehle können über einen HTTP-Aufruf ausgelöst werden, beispielsweise durch Eingabe in die Adresszeile eines Internetbrowsers und anschließende Bestätigung.

Aufbau der Befehle

Die Befehle sind wie folgt aufgebaut: 

http://IP-ADRESSE:PORT/?BEFEHL&OPTIONEN
  1. Die Angabe des HTTP-Protokolls "http://"
    Die Angabe des Protokolls bleibt unverändert bestehen.

  2. Der Endpunkt der App "IP-ADRESSE:PORT"
    Der Endpunkt der App kann über die Einstellungen der Smartha App in Erfahrung gebracht werden. Im Menüpunkt "Einstellungen" unter dem Eintrag "Endpunkt der App für Serverbefehle" werden die IP-Adresse sowie der Port angegeben.

  3. Das auszulösende Ereignis "/?BEFEHL&OPTIONEN"
    Die verschiedenen zur Verfügung stehenden Befehle und Optionen werden weiter unten aufgelistet.

Ein Beispiel für einen Befehl könnte wie folgt aussehen: 

http://192.168.0.56:12012/?speak=Waschmaschine%20ist%20fertig&language=de-DE

Dieser Befehl lässt auf dem verwendeten Gerät den Text "Waschmaschine ist fertig" ausgeben.

Achtung an die CCU-Benutzer: Es kann unter Umständen notwendig sein, die URL in Anführungszeichen zu setzen:

system.Exec("wget \"http://192.168.178.90:12012/?playaudio&audioName=alarm3\" -O /var/tmp/httpRequest",&stdout,&stderr);

Liste aller Befehle

Im Folgenden werden alle zur Verfügung stehenden Befehle und Optionen genauer erläutert.

Mit diesem Befehl kann ein Popup mit eigenem Titel und Text angezeigt werden.

Befehl:

/?showframe=INHALT&title=TITEL
  • INHALT muss mit dem anzuzeigenden Inhalt ersetzt werden.
  • TITEL muss durch den anzuzeigenden Titel ersetzt werden.

Bei Verwendung mehrerer Wörter ist zu beachten, dass Leerzeichen im Befehl durch das Kürzel %20 ersetzt werden müssen.

Beispiel:

/?showframe=Mehrere%20Wörter&Titel=Test

Dieser Befehl kann ein angezeigtes Popup wieder ausblenden.

Befehl:

/?hideframe=1

Der Befehl kann nur dann eingesetzt werden, wenn aktuell ein Popup in der smartha App angezeigt wird.

Sprachausgabe

Die Smartha App bietet die Möglichkeit einen frei definierbaren Text als Sprachausgabe wiederzugeben.

Befehl:

/?speak=TEXT&language=SPRACHE
  • TEXT muss mit dem auszugebenden Text ersetzt werden.
  • SPRACHE muss mit dem Kürzel der Ausgabesprache ersetzt werden. Auf aktuellem Stand wird die Sprache Deutsch (Kürzel de-DE) unterstützt.

Bei Verwendung mehrerer Wörter ist zu beachten, dass Leerzeichen im Befehl durch das Kürzel %20 ersetzt werden müssen.

Damit eine Sprachausgabe erfolgen kann, muss die Lautstärke des verwendeten Gerätes eingeschaltet sein.

Beispiel:

/?speak=Waschmaschine%20ist%20fertig&language=de-DE

Zu einem Display wechseln

Die Smartha App bietet die Möglichkeit zu einem bestimmten Display zu wechseln.

Befehl:

/?switch_display&name=NAME
  • NAME muss mit dem Namen der Statusanzeige bzw. des Grundrisses aus der Smartha App ersetzt werden.

Bei Verwendung mehrerer Wörter ist zu beachten, dass Leerzeichen im Befehl durch das Kürzel %20 ersetzt werden müssen.

Beispiel:

/?switch_display&name=Grundriss

Gerätesteuerung öffnen

Die Smartha App bietet die Möglichkeit die Steuerung eines in der App beliebiges Gerätes zu öffnen.

Befehl:

/?opendevice&id=ID
  • ID muss mit der Geräte-ID der App ersetzt werden. Diese findet sich im Bearbeitungsdialog des jeweiligen Gerätes.

Beispiel:

/?opendevice&id=38325E88-1AE4-4779-8EBD-58B87A1C700D

Audiodatei abspielen

Die Smartha App bietet die Möglichkeit eine Audiodatei abzuspielen.

Befehl:

/?playaudio&url=URL&command=COMMAND
/?playaudio&audioName=AUDIONAME
  • URL muss mit der URL zu der Audiodatei ersetzt werden. Diese URL muss vom Gerät erreichbar sein und kann z.B. auf ein NAS im lokalen Netzwerk oder auf eine Datei im Internet verweisen. Dieser Parameter "URL" hat zum "AUDIONAME" Vorrang. Wenn also beide angegeben sind, wird nur URL verwendet.
  • AUDIONAME muss durch den Namen der Audiodatei der eigenen Audios in der App ersetzt werden. Ist dieser Parameter gesetzt, wird die Datei, welche in den eigenen Audios hinterlegt ist abgespielt.
  • COMMAND unterstützt 'play' (Abspielen) und 'stop' (Stoppen). Ist kein COMMAND Paramter angegeben wird automatisch 'play' genutzt.

Beispiel:

/?playaudio&url=http://control.easy-smarthome.de/alarm3.wav&command=play
/?playaudio&audioName=alarm
/?playaudio&command=stop