Interface information - Readme
Content
1.
2.
3.
4.
5.

1.KO-Gateway Interface

Communication objects with group addresses can be monitored and set via the KO-Gateway interface. The HS-Monitor included in the Expert from v4.7 demonstrates this functionality.

You can find the documentation at \KO Gateway\.

2.Logic module SDK

Since firmware 2.1, the HS/FS has the possibility to extend the logic functionality of the HS/FS with its own logic modules.

A distinction is made between HSL 1.0 and HSL 2.0.

2.1.HSL 1.0

The logic modules since firmware 2.1. You can find a detailed documentation about the functionality and creation under \HSL\HSL1 SDK 1.0\.

2.2.HSL 2.0

From firmware 4.5 on, logic blocks can be created based on the Python programming language. Some tools are provided for development. In addition to a detailed documentation on the creation and the functionality of these blocks, there is a step-by-step "How-To" for setting up your own development environment, the complete documentation of the framework and the source codes of some example blocks (see \HSL\HSL2 SDK 2.0.x\).

2.3.Binding logic blocks to serial number

Logic blocks can be bound to a specific HomeServer/FacilityServer (serial number), so these blocks will only work on the device with this serial number.

Two applications from the HS/FS Expert Setup are available for this purpose.
The documentation for this can be found at \HSL\AES_coding\.

2.4.HSLZ files

HSLZ files are available from firmware 4.7 onwards. A HSLZ file is a container file for the delivery of a logic block with possibly existing additional files, e.g. (multilingual) help or special components in a directory structure.

You can find more information on this at \HSL\HSLZ\.

2.5.Template for a logic module HTML help file

In general, any valid HTML file will work as a help file for a logic module, provided it has the correct name.
To make sure that the look is "right", the SDK includes a template for a standard help file with all blocks and the classes used in the standard style sheet. You only have to rename the file and fill it with the content required for your log module. Blocks that are not needed can simply be deleted.
The template is available in German and English.

You can find the template here:\HSL\Help Template\[de|en]\log55555.html.

3.Some useful links

4.QuadClient SDK

4.1.Function templates

Function templates are visual display elements for the QuadClient or the HS/FS Apps. In a function template the appearance (display) and behaviour of a function is defined. Besides the function templates already included in the setup, it is also possible to create individual function templates.

You can find further information here:
  • Developer forum (https://www.entwicklerforum.gira.de/)
  • The description of how to create function templates can be found at \HSL\Help Template\.

4.2.PlugIns

PlugIns are independently working programs that can be embedded in the QuadClient. Beside the plug-ins already contained in the setup there is also the possibility to create individual plug-ins.

You can find further information here:
  • Developer forum (https://www.entwicklerforum.gira.de/)
  • The description of how to create plug-ins can be found at \Plugin SDK\.

5.URL endpoints

HomeServer objects (e.g. communication objects, scenes, sequences, etc., see documentation) can be called up or changed via a URL using HTTPS call.
As an alternative to access via HTTPS, the HS objects are also available via a connection via WebSocket (WS).