API-Query

Hintergrund und Anwendungen

Das “API-Query” Modul dient dazu einen oder mehrere Mini-Server Netzwerkübergreifend Ergebnisse aus den Modulen “FPS”, “Raumanforderung” und “Vorlauftemperaturkorrektur” abfragen zu lassen und dadurch die Ergebnisse eines anderen Mini-Servers zu verarbeiten bzw. zu ergänzen.

Auf diese weise ist es beispielsweise möglich einen oder mehrere Mini-Server für die Regelung einzelner Wohnungen zu verwenden und an einen Mini-Server, der die Regelung des Heizraums übernimmt, die Ergebnisse von in den Mini-Servern angelegten “Raumanforderungen” zu übermitteln.
Hierbei ist es unerheblich, ob sich der Mini-Server für den Heizraum im gleichen Gebäude oder im gleichen Netzwerk wie die anderen Mini-Server befindet.

Vorbereitung

Um Mini-Server untereinander über verschiedene Netzwerke zu verbinden müssen die Mini-Server in den zu verbindenden Mini-Servern mit MAC-Adresse angelegt werden (wie bei einem Dropserver).
https://support.controme.com/mini-server/#Gegenseitiges_Anlegen_der_Mac-Adressen_am_primaeren_Miniserver_und_am_Dropserver

Anschließend bei beiden Mini-Servern das API-Query Modul aktivieren.

API-Query anlegen

Unter Anlegen der Abfrage einen Namen geben und unter Host auswählen von welchem Mini-Server die Abfrage stattfinden soll.
Unter Schnittstelle kann ausgewählt werden ob eine FPS, eine Raumanforderung oder Vorlauftemperaturkorrektur abgefragt/gepostet werden soll.

Der Anfragetyp kann zwischen GET und POST geändert werden.

Einen anderen Mini-Server abfragen

Um einen anderen Mini-Server abzufragen ist es nicht nötig in dem Mini-Server der abgefragt wird eine “POST” API-Query anzulegen.

Für ein Abfragen muss GET ausgewählt werden.

Nach den Eingaben auf Daten abrufen klicken.

Nach dem Abrufen der Daten kann unter Datenobjekt ausgewählt werden, was genau abgefragt werden soll. Über Abfrageintervall wird in Sekunden angegeben wie oft diese Daten abgerufen werden.

Es kann pro angelegter API-Query ein Punkt abgerufen werden.

Verwenden der von API-Query abgefragten Daten

Die von der API bezogenen Daten können in der FPS unter “zu verknüpfende Ergebnisse aus Plugins” mit dem zuvor in der API-Query vergebenen Namen ausgewählt werden.

Ergebnisse an einen anderen Mini-Server senden

Um einen anderen Mini-Server abzufragen ist es nicht nötig in dem Mini-Server der abgefragt wird eine “POST” API-Query anzulegen.

Das Senden von Ergebnissen an einen anderen Mini-Server kann umgangen werden, indem in dem Mini-Server der einen Wert gesendet bekommen soll eine GET Abfrage des zu übermittelnden Werts angelegt wird.

Für ein “senden” muss POST ausgewählt werden.

Anschließend ist es möglich zwischen “JSON POST” und “Parametriertes POST” auszuwählen.