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.

Durch diese Methode ist es beispielsweise möglich, einen oder mehrere Mini-Server zur Regelung einzelner Wohnungen einzusetzen und die Ergebnisse der „Raumanforderungen“, die in den Mini-Servern festgelegt wurden, an einen separaten Mini-Server zu übermitteln, der für die Steuerung des Heizraums zuständig ist. Es spielt dabei keine Rolle, 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 eine Verbindung zwischen Mini-Servern in verschiedenen Netzwerken herzustellen, ist es erforderlich, die Mini-Server in den betreffenden Mini-Servern mit MAC-Adressen anzulegen, ähnlich wie bei einem Dropserver. Dies ermöglicht eine eindeutige Identifizierung und Kommunikation zwischen den Mini-Servern, unabhängig von ihrem Standort und Netzwerk.
https://support.controme.com/mini-server/#Gegenseitiges_Anlegen_der_Mac-Adressen_am_primaeren_Miniserver_und_am_Dropserver

Nachdem die Mini-Server mit den entsprechenden MAC-Adressen angelegt wurden, ist es erforderlich, das API-Query-Modul sowohl auf dem Mini-Server für die einzelnen Wohnungen als auch auf dem Mini-Server für die Heizungssteuerung zu aktivieren. Durch die Aktivierung dieses Moduls wird die Möglichkeit geschaffen, dass die Mini-Server miteinander über eine API kommunizieren können und so die erforderlichen Daten und Informationen austauschen können.

API-Query anlegen

Um eine API-Abfrage anzulegen, geben Sie einen Namen für die Abfrage ein und wählen Sie den Host aus, von dem aus die Abfrage erfolgen soll, also den entsprechenden Mini-Server.

Unter „Schnittstelle“ können Sie auswählen, ob Sie eine FPS (Fernparametrierschnittstelle), eine Raumanforderung oder eine Vorlauftemperaturkorrektur abfragen oder posten möchten.

Der Anfragetyp kann zwischen GET und POST geändert werden, je nachdem, ob Sie Daten abrufen oder senden möchten.

Einen anderen Mini-Server abfragen

Um einen anderen Mini-Server abzufragen, ist es nicht erforderlich, auf dem abfragenden Mini-Server eine „POST“ API-Abfrage anzulegen. Stattdessen wählen Sie „GET“ aus, um eine Abfrage durchzuführen.

Nachdem Sie die entsprechenden Eingaben gemacht haben, klicken Sie auf „Daten abrufen“.

Nach dem Abrufen der Daten können Sie unter „Datenobjekt“ auswählen, welche spezifischen Informationen abgefragt werden sollen. Das Abfrageintervall legt fest, wie oft diese Daten in Sekunden abgerufen werden sollen.

Es ist zu beachten, dass pro angelegter API-Abfrage nur ein bestimmter Datenpunkt abgerufen werden kann.

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. Wählen Sie den Namen aus, den Sie zuvor in der API-Query vergeben haben. Dies ermöglicht Ihnen, die abgerufenen Daten in der FPS zu nutzen und entsprechende Aktionen oder Einstellungen vorzunehmen.

Ergebnisse an einen anderen Mini-Server senden

Um einen anderen Mini-Server abzufragen, ist es nicht erforderlich, auf dem abfragenden Mini-Server eine „POST“ API-Abfrage anzulegen.

Um Daten an einen anderen Mini-Server zu senden, können Sie eine GET-Abfrage des zu übermittelnden Werts auf dem Mini-Server einrichten, der die Daten empfangen soll.

Wenn Sie Daten „senden“ möchten, wählen Sie „POST“ aus.

Anschließend haben Sie die Möglichkeit, zwischen „JSON POST“ und „Parametriertes POST“ zu wählen. Dies ermöglicht Ihnen, die gewünschte Methode zur Übermittlung der Daten festzulegen.