Inhalt
Heizungssteuerung API
Controme ermöglicht die Steuerung und das Abfragen von Temperaturen über einfache http-Befehle. Mit der API können mit einfachen http-Befehlen Informationen abgerufen und Einstellungen vorgenommen werden. Die Kommunikation erfolgt über den Controme Quad-Core Miniserver.
Ein kleines Tool zur Implementierung in Open Hab finden Sie hier.
Sofern Controme an einen KNX-Server angebunden werden soll, kann dieser nach entsprechender Einrichtung per http-Befehl sowohl Solltemperaturen an Controme schicken, als auch Soll- und Ist-Temperaturen von Controme abfragen.
Allgemeine Beschreibung
Hinweis: Die Controme-API wird auf Anfrage auf Ihrem lokalen Controme-Server freigeschalten. Bitte senden Sie uns hierzu eine Email mit der Mac-Adresse ihres Controme-Servers an support@controme.com
Adressformat:
/get/json/v1/[HAUSID]/[
und
/set/json/v1/[HAUSID]/[
wobei [DATA] je nach Methode optional ist.
Die Methoden sind:
get-Methoden
get-rooms
+ /get/…/rooms/
# [
# {
# „id“: etage.id
# „etagenname“: etage.name,
# „raeume: [
# {
# „id“: raum.id
# „name“: raum.name,
# „icon“: raum.icon
# },
# …
# ]
# },
# …
# ]
+ /get/…/temps/
# [
# {
# „id“: etage.id,
# „etagenname“: etage.name,
# „raeume“: [
# {
# „id“: raum.id
# „name“: raum.name,
# „solltemperatur“: raum.solltemp,
# „total_offset“: total_offset,
# „offsets“: offsets,
# „temperatur“: last,
# „sensoren“: [
# {
# „name“: sensor.name,
# „beschreibung“: sensor.description,
# „wert“: last_val,
# „letzte_uebertragung“: last_ts,
# „raumtemperatursensor“: true/false
# },
# …
# ]
# },
# …
# ]
# },
# …
# ]
get-roomoffsets
+ /get/…/roomoffsets/[RAUMID]/
# [
# {
# „id“: etage.id,
# „name“: raum.name,
# „offsets“: offsets
# }
# ]
+ /get/…/rltemps/[RAUMID]/
# [
# {
# „id“: sensor.id,
# „name“: sensor.name,
# „beschreibung“: sensor.description,
# „wert“: last_val or null,
# „letzte_uebertragung“: last_ts or null,
# „ausgang“: last_out or null
# },
# …
# ]
+ /get/…/outs/
# [
# {
# „id“: etage.id
# „etagenname“: etage.name,
# „raeume“: [
# {
# „id“: raum.id
# „name“: raum.name,
# „ausgang“: {
# „[[nummer]]“: 1/0,
# …
# }
# },
# …
# ]
# },
# …
# ]
set-Methoden
Die /set/ Aufrufe haben POST als HTTP Methode. In den POST Daten muss immer “user” und “password” mit Ihren Logindaten enthalten sein. Da wir auf dem Miniserver keine Zertifikate installiert haben, wäre es sinnvoll, wenn Sie /set/ Aufrufe nur im lokalen Netz abschicken. Wenn der Benutzer nicht authentifiziert werden kann, wird ein Statuscode 403 zurückgegeben.
set-soll
+ /set/…/soll/[RAUMID]/
Setzt die Solltemperatur im Raum. POST enthält zusätzlich “soll” mit einer Dezimalzahl als Wert.
set-roomoffset
+ /set/…/roomoffset/[RAUMID]/
Legt ein Modul für einen Raum an mit einem gegebenen Namen und Offset. Das Modul speichert übergebene Werte nur im Cache mit einer Lebenszeit von 10 Minuten. Die Werte müssen also ggf. regelmäßig erneuert werden. POST enthält zusätzlich “offset” (eine Dezimalzahl) und “offset_name” (ein String).
set-houseoffset
+ /set/…/houseoffset/
PHP-Script Beispiele
Lesen von Temperaturen
Where $argv[1] is the sensor name you have been configured in the Controme set-up. It will be later defined in the .item file.
Auslesen der Set-Temperaturen
Setzen von Set-Temperaturen
Setzen von Ist-Temperaturen
Es können Ist-Temperaturen von externen Systemen gesetzt werden. Hierzu müssen Sensor-Schnittstellen mit Lizenz-IDs von Controme generiert werden, die in Smart-Heat-OS angelegt werden können. Pro Sensor fallen hierfür Kosten in Höhe von €10,- netto an. Die lizensierten Sensor-IDs und die zugehörige Schnittstellenbeschreibung erhalten Sie auf Anfrage per Email. Bitte senden Sie bei Bedarf eine Anfrage an support@controme.com
Implementierungsbeispiel in OpenHab
Hinweise zur Controme API
Die Schnittstellenbeschreibungen für das Controme Smart-Heat-System sind für erfahrene Entwickler gedacht, welche Drittsysteme an Controme Smart-Heat anbinden wollen. Bitte beachten Sie, dass wir seitens Controme keinen technischen Support für die API liefern.
Die Schnittstellenbeschreibungen werden mit jedem Update von Controme Smart-Heat laufend aktualisiert. Wir behalten es uns vor mit einem Update Änderungen an den Schnittstellen vorzunehmen.