Projekt auf Eis gelegt, geht teilweise in https://github.com/hobbyquaker/ccu.io auf.
API zum Ausführen von Scripten, Prozessen, XML RPC und anderen HTTP-POST-Requests sowie zum Upload von Dateien auf der HomeMatic CCU, speziell auf die Anforderungen von Web-Anwendungen ausgelegt.
Die WebAPI steht in zwei Varianten zur Verfügung, einmal mit Authentifizierung (webapi_auth.tar.gz), einmal ohne (webapi.tar.gz).
Achtung: Eine Installation der WebAPI ohne Authentifizierung eröffnet jedem der Port 80 (http) bzw 443 (https) erreichen kann die Möglichkeit Scripte auf der HomeMatic CCU auszuführen. (Sicherheit ähnlich wie bei der "XML API")
Alle Scripte senden den HTTP-Header "Access-Control-Allow-Origin: *" - d.h. die Scripte können ohne Beschränkungen durch die "Same Origin Policy" in Browser-Anwedungen aufgerufen werden. Hmscript.cgi und xmlrpc.cgi können quasi auch als "Proxy" betrachtet werden der es ermöglicht XML RPC und Remote Script über Port 80/443 der CCU abzuwickeln und so das Problem mit der Same Origin Policy zu umgehen. Proxy.cgi eröffnet darüberhinaus die Möglichkeit beliebige HTTP POST Requests per XHR mit der CCU als Proxy durchzuführen.
Erwartet das Homematic Script als POST Daten und gibt die Script-Ausgabe zurück
- content - das Ausgabeformat (xml/json/html/plain) - Diese Angabe dient lediglich dazu einen passenden Header und passende Fehlermeldungen zu erzeugen, die Ausgabe selbst muss im TCL Script eigenständig erzeugt werden.
- debug - true/false - erzeugt eine Ausgabe die alle Variablen enthält (ähnlich Remote Script via Port 8181)
- session (nur in Variante mit Authentifizierung)
Startet beliebige Prozesse auf der CCU, übergibt die POST-Daten als STDIN und gibt STDOUT zurück.
Durch Umleiten der Ausgabe/Eingabe lassen sich hiermit auch Dateien auf der CCU lesen oder schreiben.
- content - das Ausgabeformat (xml/json/html/plain) - Diese Angabe dient lediglich dazu einen passenden Header und passende Fehlermeldungen zu erzeugen, die Ausgabe selbst muss im TCL Script eigenständig erzeugt werden.
- debug - true/false - erzeugt eine Ausgabe die auch STDERR enthält
- session (nur in Variante mit Authentifizierung)
Erwartet das TCL Script als POST Daten und gibt die Script-Ausgabe zurück
- content - das Ausgabeformat (xml/json/html/plain) - Diese Angabe dient lediglich dazu einen passenden Header und passende Fehlermeldungen zu erzeugen, die Ausgabe selbst muss im TCL Script eigenständig erzeugt werden.
- session (nur in Variante mit Authentifizierung)
Dient dazu Dateien per HTTP POST auf die CCU hochzuladen. Siehe auch upload-test.html
- path - der Pfad wo die Datei abgelegt werden soll (mit abschließendem Slash!)
- overwrite - true/false - Wenn Du true werden evtl. vorhandene Dateien überschrieben
- session (nur in Variante mit Authentifizierung)
- file - der Dateiupload
Gibt die Version und die Variante (mit oder ohne Authentifizierung) im JSON Format zurück
Dient als Proxy um XML RPC via Port 80 bzw 443 ausführen zu können.
- port - der Zielport (2000/2001/2002)
- session (nur in Variante mit Authentifizierung)
Dient dazu unter Umgehung der "Same Origin Policy" (ein Sicherheitsmerkmal moderner Browser) XHR POST Requests an beliebige URLs zu stellen.
Querystring und POST-Daten werden unverändert durchgereicht.
- hmwa_url - die Aufzurufende URL
- hmwa_session (nur in Variante mit Authentifizierung)
(nur in Variante mit Authentifizierung vorhanden)
Eine Session eröffnen. Gibt die Session-ID zurück
- username
- password
(nur in Variante mit Authentifizierung vorhanden)
Beendet eine Session
- session
(nur in Variante mit Authentifizierung vorhanden)
Erneuert eine Session. Sollte in Intervallen kürzer als der in der CCU konfigurierte Session-Timeout aufgerufen werden
- session
Die Nutzung dieser Software erfolgt auf eigenes Risiko. Der Author dieser Software kann für eventuell auftretende Folgeschäden nicht haftbar gemacht werden!
© 2012, 2013 hobbyquaker https://github.com/hobbyquaker
Diese Software ist freie Software. Sie können sie unter den Bedingungen der GNU General Public License, wie von der Free Software Foundation veröffentlicht, weitergeben und/oder modifizieren, gemäß Version 3 der Lizenz. Die Veröffentlichung dieser Software erfolgt in der Hoffnung, daß sie Ihnen von Nutzen sein wird, aber OHNE IRGENDEINE GARANTIE, sogar ohne die implizite Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Details finden Sie in der GNU General Public License.
HomeMatic und das HomeMatic Logo sind eingetragene Warenzeichen der eQ-3 AG