XML-API

Version 1.20

Dieses AddOn stellt einige nützliche Skripte auf der HomeMatic-Zentrale zur Verfügung, die auch von einigen 3rdParty-Programmen benötigt werden. Über einfache HTTP-Aufrufe lassen sich z.B. sämtliche Raum- oder Gewerkenamen auslesen oder den Status eines Kanals lesen bzw. setzen.

Aufruf

Nach der Installation und dem Neustart der HomeMatic-Zentrale kann die alternative Web-Oberfläche mit folgender URL aufgerufen werden:

http://<IP-DEINER-CCU>/config/xmlapi/[Skript_Name]

Der Platzhalter [CCU_IP] ist dabei durch die IP-Adresse der HomeMatic-Zentrale zu ersetzen. Für [Skript_Name] ist einer der folgenden Routinen einzusetzen:

Routine Beschreibung
devicelist.cgi Liste aller Geräte mit Kanälen (Enthält u.a. die Namen, Seriennummern, Gerätetypen und ID's)
functionlist.cgi Liste aller Gewerke mit Kanälen (Enthält u.a. die Namen, Seriennummern (pro Kanal) und ID's)
sysvarlist.cgi Liste alle Systemvariablen mit Werten
statelist.cgi Liste alle Geräte mit Kanälen und aktuellen Werten (Enthält u.a. die Namen, Datenpunkte (z. B. LowBatt), aktuelle/alte Werte (Dimmer))
programlist.cgi Liste aller Programme (Enthält u.a. die Namen, Beschreibungen und ID's)
favoritelist.cgi Liste aller Favoriten (Enthält eine gruppierte Darstellung sämtlicher Favoriten)
runprogram.cgi Startet ein Programm mit der angegebenen ID
roomlist.cgi Liste aller Räume mit Kanälen (Enthält u.a. die Namen und ID's)
statechange.cgi Ändern ein Kanal-Zustandes
state.cgi Gibt den Status eines einzelnen Geräts aus

Sämtliche Skripte erzeugen daraufhin eine XML-Struktur mit den entsprechenden Daten (Geräte, Gewerke, ...) die z. B. von einem externen Programm ausgewertet werden könnte. Jeder XML-Listeneintrag enthält zudem einen Timestamp der letzten Änderung sowie die CCU-interne ID (ise_id) des Geräts, Kanals, ...

Diese ID wird auch benötigt, wenn man über "statechange.cgi" z.B. einen Aktor ansteuern möchte:

http://192.168.178.200/config/xmlapi/statechange.cgi?ise_id=12345&new_value=0.20

Würde hinter der ise_id=12345 ein Dimmer stehen, würde dieser jetzt auf 20% dimmen.

Bitte beachten:

Der Aufruf an eine der hier vorgestellten Routinen erfolgt ohne voherige Anmeldung. Ist die HomeMatic-Zentrale ohne besonderen Schutz über das Internet erreichbar, kann dies ein Sicherheitsrisiko darstellen und gilt entsprechend zu beachten!

Tipps zur Installation:

Um ein AddOn auf der CCU zu installieren, ist dieses zunächst lokal herunterzuladen und dann über den Punkt "Systemsteuerung -> Zusatzsoftware" hochzuladen.

Die heruntegeladene Datei darf vor dem Einspielen nicht(!) entpackt werden. Es gibt Browser (z.B. Safari), die gezippte Dateien automatisch entpacken. Diese Funktion muss daher evtl. zunächst deaktiviert werden.

Spezifikationen
Typ: Zusatzsoftware
Autor/en: hobbyquaker
Zielgruppe: Anwender
Einstiegshürde: Niedrig
Kompatibilität: CCU1, CCU2, CCU3, RaspberryMatic
Alle Angaben ohne Gewähr!
Weitere Informationen:
XML-API-Webseite
- Code scannen, um zur Orginalseite zu gelangen -