[External integration] - KNX

Development
1

Hello everyone,

In response to the request KNX Protocol Integration, here is an external integration that connects Gladys to a KNX installation.

What it does

It communicates with the bus via a KNX IP interface on your network, locally only: nothing goes out to the Internet. Gladys does not have a native KNX integration.

KNX does not allow discovering devices: you declare each one with its ETS group addresses (buttons « Declare a light », « Declare a shutter »… in the configuration), then you add it from the Discovery tab.

Features

  • Devices: lights (dimming, color), switches, shutters and curtains, sensors (temperature, humidity, CO2, power, energy…), binary sensors (motion, window contact, smoke…), thermostats.
  • Connection: UDP or TCP tunneling, KNX IP Secure, routing; automatic interface search.
  • KNX Bus widget: connection, traffic, last telegrams.
  • Scene triggers: telegram received on selected addresses, connection lost, connection restored.
  • Scene actions: send a value, read a value, recall a KNX scene.

Scene examples:

  • when the « All off » button at the entrance sends off → also turn off non-KNX lights;
  • when the alarm is activated → recall the KNX scene « Away » and close the shutters;
  • when the KNX connection is lost → notify the household.

Installation

Available in the store later today, pending indexing (search for « KNX »), or now from the repository URL: Integrations → Install an integration → https://github.com/William-De71/gladys-knx. Gladys 5.1.1 minimum.

  1. Enter the IP address of the interface (or leave blank), then Test the connection.
  2. Declare your devices with their ETS group addresses (1/2/3).
  3. Add them from the Discovery tab.
  4. Add the « KNX Bus » widget to a dashboard.

Screenshots

Illustration generated from the integration code (not a screenshot of a real Gladys):

KNX Bus Widget (generated illustration)

Known limitations

  • Not tested on a real KNX installation, only against the KNXUltimate tunneling server and automated tests: your feedback on real hardware is welcome.
  • No ETS project import: addresses are entered manually.
  • No KNX Data Secure, no ventilation, no thermostat modes (comfort, eco…) for now.
  • Multicast routing usually does not reach the container: prefer tunneling.
How it works, for the curious

The integration is a Node.js container that uses the KNXUltimate library (the one from node-red-contrib-knx-ultimate). Declarations are stored in Gladys’ configuration, hence in its backups. Each telegram is decoded with the data point type (DPT) of its address, and only changes are sent to Gladys (up to 240 states per minute). The interface search goes through Gladys’ core, the only one that can broadcast on the local network.

Your feedback

In response to this thread or in a GitHub issue, with the versions of Gladys and the integration, the model of the interface and the logs (ideally with DEBUG=gladys-integration-sdk).

Apache 2.0 license. Thanks to the Gladys team for the documentation and the external integrations SDK, and to the author of KNXUltimate.

KNX is a trademark of KNX Association; this project is not affiliated with it.