Schnittstellen Informationen - Liesmich
Inhalt
1.
KO-Gateway Schnittstelle
2.
Logikbaustein SDK
3.
Einige nützliche Links
4.
QuadClient SDK
5.
URL-Endpoints

1.KO-Gateway Schnittstelle

Über die KO-Gateway-Schnittstelle können Kommunikations-Objekte mit Gruppen-Adressen überwacht und gesetzt werden. Der im Experte ab v4.7 enthaltene HS-Monitor demonstriert diese Funktionalität.

Die Dokumetation finden Sie unter \KO Gateway\.

2.Logikbaustein SDK

Seit der Firmware 2.1 besitzt der HS/FS die Möglichkeit, durch eigene Logikmodule die Logik-Funktionalität des HS/FS zu erweitern.

Dabei wird unterschieden zwischen HSL 1.0 und HSL 2.0.

2.1.HSL 1.0

Die Logikbausteine seit Firmware 2.1. Eine ausführliche Dokumentation zur Funktionsweise und Erstellung finden Sie unter \HSL\HSL1 SDK 1.0\.

2.2.HSL 2.0

Ab Firmware 4.5 können Logikbausteine auf Basis der Programmiersprache Python erstellt werden. Zur Entwicklung werden einige Tools zur Verfügung gestellt. Außerdem gibt es neben einer ausführlichen Dokumentation zur Erstellung und zur Funktionsweise dieser Bausteine, ein Step-by-Step "How-To" zur Einrichtung einer eigenen Entwicklungsumgebung, die vollständige Dokumentation des Frameworks und die Quell-Codes einiger Beispiel-Bausteine (siehe \HSL\HSL2 SDK 2.0.x\).

2.3.Logikbausteine an Seriennummer binden

Logikbausteine können an einen bestimmten HomeServer/FacilityServer (Seriennummer) gebunden werden, wodurch diese Bausteine nur noch auf dem Gerät mit dieser Seriennummer arbeiten.

Dazu stehen zwei Applikationen aus dem HS/FS Experte-Setup zur Verfügung.
Die Dokumentation dazu finden Sie unter \HSL\AES_coding\.

2.4.HSLZ-Dateien

Ab Firmware 4.7 gibt es HSLZ-Dateien. Eine HSLZ-Datei ist eine Container-Datei für die Auslieferung eines Logikbausteins mit eventuell vorhandenen zusätzlichen Dateien, z.B. (mehrsprachige) Hilfe oder spezielle Komponenten in einer Verzeichnis-Struktur.

Nähers dazu finden Sie unter \HSL\HSLZ\.

2.5.Vorlage für eine Logikbaustein HTML-Hilfe-Datei

Generell funktioniert jede beliebige gültige HTML-Datei als Hilfe-Datei für einen Logikbaustein, sofern sie den richtig zusammengesetzten Namen hat.
Damit auch die Optik "stimmt", liegt dem SDK eine Vorlage für eine Standard Hilfe-Datei mit allen Blöcken und den im Standard Style-Sheet verwendeten Klassen bei, die Sie nur umbenennen und mit dem für Ihren Logkbaustein nötigen Inhalt füllen müssen. Nicht benötigte Blöcke können einfach gelöscht werden.
Die Vorlage steht in deutscher und englischer Sprache zur Verfügung.

Die Vorlage finden Sie hier:  \HSL\Help Template\[de|en]\log55555.html.

3.Einige nützliche Links

4.QuadClient SDK

4.1.Funktionsvorlagen

Funktionsvorlagen sind visuelle Anzeigeelemente für den QuadClient oder die HS/FS Apps. In einer Funktionsvorlage wird das Aussehen (Darstellung) und Verhalten einer Funktion definiert. Neben den bereits im Setup enthaltenen Funktionsvorlagen besteht auch die Möglichkeit individuelle Funktionsvorlagen zu erstellen.

Weitere Informationen finden Sie hier:
  • Entwicklerforum (https://www.entwicklerforum.gira.de/)
  • Die Beschreibung zur Erstellung von Funktionsvorlagen finden Sie unter \HSL\Help Template\.

4.2.PlugIns

PlugIns sind selbstständig arbeitende Programme, die im QuadClient eingebettet werden können. Neben den bereits im Setup enthaltenen PlugIns besteht auch die Möglichkeit individuelle PlugIns zu erstellen.

Weitere Informationen finden Sie hier:
  • Entwicklerforum (https://www.entwicklerforum.gira.de/)
  • Die Beschreibung zur Erstellung von PlugIns finden Sie unter \Plugin SDK\.

5.URL-Endpoints

HomeServer-Objekte (wie z.B. Kommunikations-Objekte, Szenen, Sequenzen, u.a., siehe Dokumentation) können über eine URL per HTTPS-Aufruf abgerufen bzw. verändert werden.
Als Alternative zum Zugriff über HTTPS stehen die HS-Objekte ebenfalls über eine Verbindung per WebSocket (WS) zur Verfügung.