KNX Gateway Configuration
This node connects to your KNX/IP Gateway.
General
| Property | Description |
|---|---|
| Name | Node name. |
| IP/Hostname | ETH/KNX Router multicast address or Interface unicast IP address. If you have an KNX/IP interface, use the interface’s IP address, for example 1982.168.1.22, otherwise, if you have a KNX/IP router, put the multicast address 224.0.23.12. You can also type an Hostname instead of an IP. |
Configuration
| Property | Description |
|---|---|
| IP Port | The port. Default is 3671. |
| IP Protocol | Tunnel UDP is for KNX/IP interfaces, Multicast UDP is for KNX/IP Routers. Leave Auto for auto detect. Default is “Auto”. |
| KNX Physical Address | The physical KNX address, example 1.1.200. Default is “15.15.22”. |
| Bind to local interface | The Node will use this local interface for communications. Leave “Auto” for automatic selection. If you have more than one lan connection, for example Ethernet and Wifi, it’s strongly recommended to manually select the interface, otherwise not all UDP telegram will reach your computer, thus the Node may not work as expected. Default is “Auto”. |
| Automatically connect to KNX BUS at start | Auto connect to the bus at start. Default is “Yes”. |
| Secure credentials source | Choose how KNX Secure data is supplied: ETS keyring file ** (Data Secure keys - and tunnelling credentials if present - come from the keyring),Manual credentials ** (only KNX IP Tunnelling Secure with a manually entered user), orKeyring + manual tunnel password (Data Secure keys from the keyring while the secure tunnel uses the manual user/password). Remember that KNX Data Secure telegrams always require a keyring file. |
| Tunnel interface individual address | Visible whenever the selected mode includes manual credentials (Manual or Keyring + manual tunnel password). Optional KNX individual address for the secure tunnel interface (for example 1.1.1); leave empty to let KNX Ultimate negotiate it automatically. |
| Tunnel user ID | Visible when manual credentials are used. Optional KNX Secure tunnel user identifier defined in ETS. |
| Tunnel user password | Visible when manual credentials are used. Password of the KNX Secure tunnelling user configured in ETS. |
KNX Secure essentials
• KNX Data Secure protects group-address telegrams and always needs a keyring file containing the group keys.
• KNX IP Tunnelling Secure protects the connection handshake with a commissioning password. Depending on the selected mode, the password can come from the keyring or be entered manually.
Advanced
| Property | Description |
|---|---|
| Echo sent message to all node with same Group Address | Send the msg input coming from the flow, to all nodes having the same group address. The nodes will receive the new msg as if it’s coming from the KNX bus. This is useful in case of using the KNX emulation and in case the connection to the KNX bus is not established. This option will be deprecated in the next version and defaulted to checked. Default is checked. |
| Suppress repeated (R-Flag) telegrams fom BUS | Ignore repeated KNX telegrams coming from the bus. Default is unchecked. |
| Suppress ACK request in tunneling mode | Enable it if you have a very old KNX/IP gateway. It ignores the ACK procedure and accepts all telegrams. Default is unchecked. |
| Delay between each telegram (in milliseconds) | KNX specs states, that the maximum telegram sending speed is 50 telegrams per second. A speed between 25 and 50ms should be fine, unless you’re connecting to a remote KNX Gateway via a slow internet connection (in this case, you should increase the value by, for example, 200 to 500ms or more). |
| Loglevel | Log level, in case you need to debug something with the dev. Default is “Error”, |
| Node status throttle | Delay how often node badges are refreshed. When a delay is selected, intermediate status changes are discarded and the last one is shown after the chosen interval. Select Immediate to keep the legacy real-time behaviour. |
ETS file import
| Property | Description |
|---|---|
| If Group Address has no Datapoint | If a group address doesn’t have a datapoint, it allow to choose wether to stop import, import quth a fake datapoint of 1.001 or to skip import of that group address |
| ETS group address list | Use this section to import your ETS CSV or ESF file. You can either paste the CSV or ESF file content ** orset the file path** , for example ./pi/homecsv.csv. Please refer to the help links for further infos. |
Utility
| Property | Description |
|---|---|
| Gather debug info for troubleshoot | Please click the button and add it to the gitHub issue you want to open, it will help me a lot to helping you. |
| Get all used GA for KNX routing filter | Press READ to retrieve a plain text list of all group address belonging to this gateway, that has been used in the flows. You can use this list to populate your KNX/IP router filter table. |
WORKING WITH THE ETS CSV OR ESF FILE
Instead of create a knx-ultimate node for each Group Address to control, you can import your ETS csv group addresses file or, starting from V 1.1.35, an ESF file as well (If, for example, you only have ETS Inside). Supported ETS versions: ETS 4 and onwards.
Starting from version 1.4.18, you can also simply enter the path to the file in this field (e.g.: /home/pi/mycsv.csv).
Thanks to that, the knx-ultimate node where you selected Universal mode (listen to all Group Addresses) , becomes an universal input/output node, aware of all Datapoints, Group Addresses and Device’s name (ex: Living Room Lamp). Just send the payload to the knx-ultimate node, and it’ll encode it with the right datapoint and send it to the bus. Likewise, when the knx-ultimate node receives a telegram from the bus, it outputs a right decoded payload using the datapoint specified in the ETS CSV or ESF file.
Starting from Version 1.1.11 ** , you can useUniversal mode (listen to all Group Addresses) ** option without the need of an imported ETS CSV or ESF File. You need to pass a message to the node, containing datapoint type and a value. As soon as the node receives a telegram from KNX Bus, it will output a RAW value and beside that, it will try to decode the value without knowing the datapoint type. Note : ETS CSV Group address exported file is way the best option, because it contain a precise datapoints with subtype. ETS ESF exported file is simpler and it doesn’t have the subtype.
If you can use both, please prefer the ETS CSV Group address exported file ** , because the ESF can lead to a false output values. Please manually check and eventually adjust the datapoints each time you import theESF** file. From version 1.4.1 you can import group addresses also at runtime, via msg, using the WatchDog node.
You can work with a mix of knx-ultimate nodes, some with Universal mode (listen to all Group Addresses) checked and some not. You are absolutely free!
Importing the ETS CSV group address list
Heads-up. The name of a group address must not contain tab characters. If ETS does not define a datapoint for a group address you can decide to stop the import, skip that address, or continue by adding it with a temporary 1.001 datapoint.
Export the CSV from ETS
- In ETS open the Group Addresses view, right-click inside the list and choose Export Group Addresses.
- In the export dialog use the following options:
- Output format: CSV
- CSV format: 1/1 Name/Address
- Export with header line: enabled
- CSV separator: Tabulator
- Export the file, then paste its contents into the ETS group address list field (or provide the path to the file).
What to expect during import
- The CSV must contain a datapoint for every group address.
- The gateway parses the file and reports the outcome in the Node-RED debug sidebar:
- ERROR – a datapoint is missing, the import stops.
- WARNING – a datapoint subtype is missing, a default subtype is applied but you should review it (the subtype is the number after the dot, e.g.
5.001).
- Each field should be wrapped in quotes, for example:
"Attuatori luci" "0/-/-" "" "" "" "" "Auto"
Importing the ETS ESF group address list
- In ETS select the project, click the export icon (arrow pointing up) and choose the ESF format (not
.knxprod). - Copy the file contents or point the ETS group address list field to the exported ESF file.