webservices
Das Webservices Plugin stellt ein REST basiertes API für SmartHomeNG bereit. Es werden PUT und GET Kommandos unterstützt.
Anforderungen
Das Plugin benötigt CherryPy um zu laufen, sowie ein konfiguriertes http Modul in SmartHomeNG.
Grundsätzlich ist das http Modul in SmartHomeNG bereits konfiguriert. Die Konfiguration kann über das
Admin Interface geändert werden oder durch direkte Änderung in der Datei etc/module.yaml jeweils mit anschließendem
Neustart von SmartHomeNG.
Konfiguration
Die Informationen zur Konfiguration des Plugins sind unter Plugin ‚webservices‘ Konfiguration beschrieben.
plugin.yaml
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
items.yaml
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
logic.yaml
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Funktionen
Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Beispiele und Nutzungshinweise
Das Webservices Plugin unterstützt drei leicht unterschiedliche Arten von Zugriffen, die im Folgenden beschrieben werden.
Web Interface
Das webservices Plugin verfügt über ein Webinterface, mit dessen Hilfe die Items, die das Plugin nutzen kann, übersichtlich dargestellt werden.
Wichtig
Das Webinterface des Plugins kann mit SmartHomeNG v1.4.2 und davor nicht genutzt werden. Es wird dann nicht geladen. Diese Einschränkung gilt nur für das Webinterface. Ansonsten gilt für das Plugin die in den Metadaten angegebene minimale SmartHomeNG Version.
Aufruf des Webinterfaces
Das Plugin kann aus dem Admin Interface aufgerufen werden. Dazu auf der Seite Plugins in der entsprechenden Zeile das Icon in der Spalte Web Interface anklicken.
Außerdem kann das Webinterface direkt über http://\<SmartHomeNG_IP\>:\<http_modul_port\>/plugin/\<webservices\>
aufgerufen werden.
http_modul_port steht in diesem Fall für den im http Modul definierten Port.
webservices steht für den Namen mit dem das Plugin in etc/plugin.yaml definiert worden ist.
Beispiele
Folgende Informationen können im Webinterface angezeigt werden:
Oben rechts werden allgemeine Parameter zum Plugin angezeigt.
Im unteren Teil werden die Items angezeigt, die per REST Interface abgefragt werden können: