Written and (C) 2015 Oliver Wagner owagner@tellerulam.com
Provided under the terms of the MIT license.
knx2mqtt is a gateway between a KNX bus interface and MQTT. It receives group telegrams and publishes them as MQTT topics, and similarily subscribes to MQTT topics and converts them into KNX group writes.
It's intended as a building block in heterogenous smart home environments where an MQTT message broker is used as the centralized message bus. See https://github.com/mqtt-smarthome for a rationale and architectural overview.
- Java 1.7 SE Runtime Environment: https://www.java.com/
- Calimero (2.2.1): https://github.com/calimero-project/calimero / https://www.auto.tuwien.ac.at/a-lab/calimero.html (used for KNX communication)
- Eclipse Paho: https://www.eclipse.org/paho/clients/java/ (used for MQTT communication)
- Minimal-JSON: https://github.com/ralfstx/minimal-json (used for JSON creation and parsing)
The Calimero library is able to directly talk to EIBnet/IP gateways or routers. However, knx2mqtt can be used in conjunction with eibd if eibd is run as an EIBnet/IP server with option "-S". Note that this is not the same as eibd's proprietary TCP protocol which by default uses TCP port 6720.
knx2mqtt uses the group address hierarchy as defined in ETS4 for topics. The group addresses are translated to hierarchical group names if a ETS4 project file is specifed. Example
knx/set/Keller/Beleuchtung/Kellerflur Schalten
A special topic is prefix/connected. It holds an enum value which denotes whether the adapter is currently running (1) and connected to the KNX bus (2). It's set to 0 on disconnect using a MQTT will.
The message format generated is a JSON encoded object with the following members:
- val - the actual value, in numeric format
- ts - timestamp, in milliseconds since Epoch, when this message was generated
- lc - timestamp, in milliseconds since Epoch, when the value last changed (this is only accurate over the runtime of an knx2mqtt instance; if knx2mqtt is restarted, all values will be assumed to have changed when they are first received on the bus)
- knx_src_addr - when sending message, knx2mqtt fills in the source EIB address of the group write which triggered the message
- knx_textual - a textual representation of the value, or the numeric value with a unit specififer (e.g. "100%")
The interpretation of KNX values is not specified as part of the wire protocol, but done by the device configuration. It is therefore important for knx2mqtt to know about the datapoint definition of a group address.
The easiest way to archieve this is to specify a ETS4 exported project file (.knxproj). knx2mqtt will read and parse this both for the group address names and data point types. A multi-level approach to determining the data point type is used, with the ultimate fallback being the data size in bits. It is recommended to always define DPTs in your ETS4 projects, notably when converting ETS3 projects.
Special treatment is given to boolean DPTs: Instead of translating them into their textual representations, they are transfered (and accepted) as numeric "0" and "1" values.
Since the parsing of parsing of the ETS4 project file is a memory- and CPU intensive process, the parsed information is stored in a cache file (the project file with the suffix ".cache"). The cache file is completely optional; if it's not present, older than the project file or incompatible with this version of knx2mqtt, it's simply ignored and the usual project file parsing takes place.
Configuration options can either be specified on the command line, or as system properties with the prefix "knx2mqtt". Examples:
java -jar knx2mqtt.jar knx.ip=127.0.0.1
java -Dknxmqtt.knx.ip=127.0.0.1 -jar knx2mqtt.jar
-
knx.type
Connection type. Can be either TUNNELING or ROUTING. Defaults to TUNNELING.
-
knx.ip
IP address of the EIBnet/IP server/gateway (no default, must be specified)
-
knx.port
Port of the EIBnet/IP server/gateway. Defaults to 3671.
-
knx.localip
IP address (interface) to use for originating EIBnet/IP messages. No default, mainly useful in ROUTING mode to specify the multicast interface.
-
knx.ets4projectfile
-
knx.ets5projectfile
A ETS4 or ETS5 exported projectfile (".knxproj"). No default. Will be used to determine group address names and DPTs. A pre-parsed cache of this file is stored under the same name with the suffix ".cache".
-
mqtt.server
ServerURI of the MQTT broker to connect to. Defaults to "tcp://localhost:1883".
-
mqtt.clientid
ClientID to use in the MQTT connection. Defaults to "knx2mqtt".
-
mqtt.topic
The topic prefix used for publishing and subscribing. Defaults to "knx/".
When running knx2mqtt on a server class machine, it makes sense to limit the memory usage to 128MB using the java options
-Xmx128M
- Project overview: https://github.com/mqtt-smarthome
-
0.13 - 2015/09/16 - owagner
- fix reading of ETS5 project files (trivial change)
- added knx.ets5projectfile as a new option for specifying the project file. Currently aliases directly to ets4projectfile
- update minimal-json to 0.9.4
-
0.12 - 2015/07/19 - owagner
- fix: topic/connected state was always 1 after a MQTT reconnect
- generate "ts" and "lc" timestamp fields in published messages
-
0.11 - 2015/07/18 - owagner
- fixed float conversion to number. Previously, float values were added as strings to the JSON-encded object, possibly causing issues in logic engines
- updated minimal-json to 0.9.2, calimero to 2.2.1 (final) and eclipse-paho to 1.0.2
- ignore intermediate syslog I/O errors
-
0.10 - 2015/04/11 - owagner
- added caching of parsed project files to speed up startup esspecially on low-end CPUs
- heavily speed up parser, partially using SAX instead of DOM
-
0.9 - 2015/04/04 - owagner
- fixed bug in ETS4 project reader which would not find a datapoint definition at the ComObject level
- fixed another bug which would except over DPT definitions (vs. DPST definitions)
- made project file parsing more robust in case only some connections into a GA had DPT definitions
- added a fallback when hitting a DPT for which Calimero does not yet have a translator (for example, 20.103 HVAC mode). In that case, a 5.005 translator (one byte integer) fallback is used.
- build updated to use Calimero 2.2.1-beta
-
0.8 - 2015/03/08 - owagner
- support /get/ function, which issues a KNX Group Read
-
0.7 - 2015/03/02 - owagner
- added a syslog log handler which is active by default and can be overriden using JUL properties
-
0.6 - 2015/01/29 - owagner
- use a SoftReference to cache XML documents during project file loading, to reduce initial memory impact
-
0.5 - 2015/01/28 - owagner
- now capable of reading ETS4 project files to determine both group address names and their DPT values. Obsoletes "knx.groupaddressfile"
- now properly converts incoming and outgoing messages according to the specified data point values.
- includes JSON attribute "knx_textual" with a textual representation of the DPT value
-
0.4 - 2015/01/25 - owagner
- adapted to new mqtt-smarthome topic hierarchy scheme: /status/ for reports, /set/ for setting values
- prefix/connected is now an enum (0 - disconnected, 1 - connected to broker, 2 - connected to KNX bus)
- use QoS 0 for published status reports
-
0.3 - 2015/01/05 - owagner
- make sure numeric values are not sent as strings
- change type guessing to send integer numbers not as floats if they have a decimal point, but no fractional part
-
0.2 - 2015/01/02 - owagner
- converted to Gradle build