Technical Document

Niagara KNXnet/IP Driver Guide

May 12, 2021

Niagara KNXnet/IP Driver Guide
Tridium, Inc.
3951 Westerre Parkway, Suite 350
Richmond, Virginia 23233
U.S.A.
Confidentiality
The information contained in this document is confidential information of Tridium, Inc., a Delaware
corporation (“Tridium”). Such information and the software described herein, is furnished under a license
agreement and may be used only in accordance with that agreement.
The information contained in this document is provided solely for use by Tridium employees, licensees, and
system owners; and, except as permitted under the below copyright notice, is not to be released to, or
reproduced for, anyone else.
While every effort has been made to assure the accuracy of this document, Tridium is not responsible for
damages of any kind, including without limitation consequential damages, arising from the application of the
information contained herein. Information and specifications published here are current as of the date of this
publication and are subject to change without notice. The latest product specifications can be found by
contacting our corporate headquarters, Richmond, Virginia.

Trademark notice
BACnet and ASHRAE are registered trademarks of American Society of Heating, Refrigerating and Air-
Conditioning Engineers. Microsoft, Excel, Internet Explorer, Windows, Windows Vista, Windows Server, and
SQL Server are registered trademarks of Microsoft Corporation. Oracle and Java are registered trademarks
of Oracle and/or its affiliates. Mozilla and Firefox are trademarks of the Mozilla Foundation. Echelon, LON,
LonMark, LonTalk, and LonWorks are registered trademarks of Echelon Corporation. Tridium, JACE,
Niagara Framework, and Sedona Framework are registered trademarks, and Workbench are trademarks of
Tridium Inc. All other product names and services mentioned in this publication that are known to be
trademarks, registered trademarks, or service marks are the property of their respective owners.

Copyright and patent notice

This document may be copied by parties who are authorized to distribute Tridium products in connection
with distribution of those products, subject to the contracts that authorize such distribution. It may not
otherwise, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic
medium or machine-readable form without prior written consent from Tridium, Inc.
Copyright © 2021 Tridium, Inc. All rights reserved.
The product(s) described herein may be covered by one or more U.S. or foreign patents of Tridium.
Contents
About this guide .................................................................................................5
Document change log ................................................................................5
Related documentation ..............................................................................6
Chapter 1 About the KNXnet/IP driver ............................................................7
Compatibility .............................................................................................7
Requirements.............................................................................................8
Driver modules...........................................................................................9
ETS FAQs.................................................................................................10
Driver FAQs .............................................................................................11
Tunnelling FAQs.......................................................................................14
Compound Structures ..............................................................................15
Quick start ...............................................................................................16

Chapter 2 Station setup..................................................................................17

Adding a Knx Network .............................................................................17
About KNX Data Defs...............................................................................18
Loading the Data Defs....................................................................19
Loading the Data Defs manually......................................................20
Examining the Data Defs ................................................................21
Updating the Data Defs ..................................................................21
Configuring the connection to the KNX Network.......................................23
Device setup ............................................................................................25
Discovering devices........................................................................25
Importing devices from an ETS project file ......................................27
Adding devices manually ................................................................29
Adding points from an ETS project file ......................................................30
Troubleshooting.......................................................................................33

Chapter 3 Components...................................................................................37
knxnetIp-Connections ..............................................................................37
knxnetIp-ConnectionsCommsCounters .....................................................38
knxnetIp-KnxDevice .................................................................................38
knxnetIp-KnxDeviceFolder .......................................................................41
knxnetIp-EndPoint ...................................................................................41
knxnetIp-EndPointCommsCounters ..........................................................42
knxnetIp-GroupDataManage ....................................................................43
knxnetIp-KnxInstallation ...........................................................................44
knxnetIp-LocalInterface ............................................................................45
knxnetIp-LocalInterfaces...........................................................................46
knxnetIp-KnxNetwork ..............................................................................46
knxnetIp-KnxPollScheduler .............................................................49
knxnetIp-KnxStationDataDefs.........................................................51
knxnetIp-KnxPointDeviceExt ....................................................................51
knxnetIp-TunnelConnection......................................................................53
knxnetIp-TunnelConnectionCommsCounters ............................................55

May 12, 2021 3

Contents Niagara KNXnet/IP Driver Guide

Chapter 4 Windows ........................................................................................59

Discover Import Device ............................................................................59
Import an ETS project file .........................................................................60
New (Edit) KNX device .............................................................................60

Chapter 5 Plugins (views) ...............................................................................63

knxnetIp-KnxDeviceManager....................................................................63

Glossary ............................................................................................................65
Index.................................................................................................................67

4 May 12, 2021

About this guide
This topic contains important information about the purpose, content, context, and intended audience for
this document.
Produ ct D ocu men t at i on
This document is part of the Niagara technical documentation library. Released versions of Niagara software
include a complete collection of technical information that is provided in both online help and PDF format.
The information in this document is written primarily for Systems Integrators. To make the most of the infor-
mation in this book, readers should have some training or previous experience with Niagara software, as well
as experience working with JACE network controllers.
Document Content
This document describes how to set up and use the Knxnet/IP driver.
C A U T I O N : Protect against unauthorized access by restricting physical access to the computers and devices
that manage your building model. Set up user authentication with strong passwords, and secure compo-
nents by controlling permissions. Failure to observe these recommended precautions could expose your net-
work systems to unauthorized access and tampering.

Document change log

Updates (changes and additions) to this document are listed below.
May 12, 2021
Deleted an invalid feature in driver summary list.
October 22, 2019
• Updated during the release of Niagara 4.8.
• Edited all topics for grammar and style.
• Replaced Properties chapter with Components chapter.
• Added screen captures and how to access properties.
• Reorganized FAQs.
• Created Troubleshooting topic.
• In the topic, “About this guide”, added a caution note alerting customers to restrict access to all com-
puters, devices, field buses, components, etc., that manage their building model.

July 24, 2018

Updated for the 1.6 release of the driver.
2018
Editorial changes only.
January 11, 2017
Added FAQ’s and property details.

September 28, 2016

Added property details.
August 4, 2016
Added property topics.

May 12, 2021 5

 Niagara KNXnet/IP Driver Guide

July 26, 2016

• Added Property reference chapter and draft property topics.
• Edited About KNX DataDefs.
• Edited Points in Fault — KNXnet/IP Interface FAQ.
• Added topics for Add Devices to the KNX Network and Add Points.
• Added About, Examining and Updating KNX Data Defs.
• Added KNXnet/IP driver conflict FAQ.
April 04, 2016

Related documentation
Several other documents are available for learning how to use the Niagara Knxnet/IP driver.
• Niagara Drivers Guide explains concepts.
• Getting Started with Niagara explains concepts.

May 12, 2021 6

Chapter 1 About the KNXnet/IP driver
Topics covered in this chapter
♦ Compatibility
♦ Requirements
♦ Driver modules
♦ ETS FAQs
♦ Driver FAQs
♦ Tunnelling FAQs
♦ Compound Structures
♦ Quick start

The KNX decentralized, distributed network protocol manages building controls, such as HVAC and lighting
systems. The Niagara Framework® KNX driver models devices that conform to the KNX protocol standard.
The KNXnet/IP driver:
• Provides a license feature: knxnetIp
• Works with NiagaraAX-3.8 and Niagara 4.1 versions and later
• Supports the JACE-3E, JACE-6, JACE-6E and JACE-8000 (it does not support the JACE-2)
• Supports both ETS4 (Engineering Tools Software) and ETS5 KNX tools
• Supports versions 12-14 of the ETS knxproject xml schema
• Uses the more data-rich ETS project file as a source of KNX system data for discovery
• Supports ETS Two Level, Three Level and Free Level group addressing
• Supports the full list of current KNX datapoint types defined in the knx Master Data xml file
• Supports manufacturer-specific KNX datapoint types with values exposed as hex strings
• Supports enhanced point discovery to improve pre-setting Point Facets, Point Names, Hierarchy and
Point types
• Supports complex multi-value KNX datapoint types
Consistent modelling (knxnetIp-device = Niagara-device and KNX Group Address = Niagara-point)
• Supports knxnetIp tunnelling
• Supports proxy routing
• Supports enhanced bus-data-received functionality
• Provides documentation as a PDF and Workbench help
• Makes no reference to the EIB (European Installation Bus)

Compatibility
The knxnetIp driver is compatible with standard KNX Services.

KnxnetIp services compatibility

KnxnetIp Se rvice Support

Core Services Fully supported

Device Management Client only

May 12, 2021 7

Chapter 1 About the KNXnet/IP driver Niagara KNXnet/IP Driver Guide

KnxnetIp Service Support

Tunnelling
Data Link Layer — Fully Supported
CEMI Raw— Not Supported
KNX Busmonitor— Not Supported

Routing Service Not Supported

Remote Logging Not supported

Remote Configuration and Diagnostics Not supported

Object Server Not supported

Routing
Through a tunnel connection the driver supports physical routers, which route KNX messages.
The driver does not support the KNX protocol’s Routing Service, which broadcasts messages around the en-
tire network.
The driver provides proxy routing, which uses a tunnel to connect to a router device for the purpose of send-
ing messages.
KNX system specification editions
Here are the specific KNX System Specification document editions:
• 03_01_02 Glossary v01.04.00 AS.pdf
• 03_02_06 Communication Medium KNX IP v01.00.02 AS.pdf
• 03_03_02 Data Link Layer General v01.02.02 AS.pdf
• 03_03_07 Application Layer v01.06.04 AS.pdf
• 03_06_03 EMI_IMI v01.03.03 AS.pdf
• 03_07_02 Datapoint Types v01.08.03 AS.pdf
• 03_07_03 Standardized Identifier Tables v01.03.01 AS.pdf
• 03_08_01 Overview v01.04.02 AS.pdf
• 03_08_02 Core v01.05.02 AS.pdf
• 03_08_03 Management v01.06.02 AS.pdf
• 03_08_04 Tunnelling v01.05.04 AS.pdf

Re qu irem en ts
Requirements include installer training, ETS data, software, hardware, and licensing.
Systems integrator training
The procedures in this document assume that you are Niagara certified and experienced at configuring
stations.
ETS proj ec t req ui reme n ts
Using ETS (Engineering Tool Software), export the ETS Project. This provides the source of the KNX system
data for the Knxnet/IP driver.

8 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 1 About the KNXnet/IP driver

F ig ure 1 ETS Project view

P l a t f o r m p re re q u i s i t e s
The KNXnet/IP driver requires a NiagaraAX or Niagara 4 platform that supports Hot Spot VM (virtual ma-
chine) from Oracle. It does not support the JACE 2, 4, or 5. The KNXnet/IP driver only supports an IP con-
nection to the KNX network.
Ve r s i o n
These Niagara versions support the KNXnet/IP driver:
• NiagaraAX-3.8
• Niagara 4.1 and later
L ic en si ng req ui reme n t
• The knxnetIp feature must be present in your Workbench platform and station platform licenses.
• Attributes associated with the knxnetIp feature are listed in the table.
Attribute Description

device.limit This attribute is common to most features. It defines the maximum number of devices that can be connected to
this driver.

history.limit This attribute is common to most features. It defines the maximum number of histories that can be used for this
feature.

installation.limit This attribute defines the maximum number of KNX installations that can be connected to this driver.

interface.limit This attribute defines the maximum number of platform interfaces that can be connected to this driver.

point.limit This attribute is common to most features. It defines the maximum number of points used on this feature.

schedule.limit This attribute is common to most features. It defines the maximum number of schedules used on this feature.

Driver modules
KNX integration requires modules for both NiagaraAX and Niagara 4 versions.
NiagaraAX KNX modules
Two modules are required for the KNXnet/IP driver:
• knxnetIp.jar
• docknxnetIp.jar

Niagara 4 KNX modules

Three modules are required for the KNXnet/IP driver:

May 12, 2021 9

Chapter 1 About the KNXnet/IP driver Niagara KNXnet/IP Driver Guide

• knxnetlp-doc.jar
• knxnetIp-rt.jar
• knxnetIp-wb.jar

E T S FA Q s
The implementation of a KNX network begins with the ETS project.

D o e s t h e ‘ B u s C o n n e c t i o n ’ p ro p e r t y re q u i re c o n f i g u r a t i o n i n E T S ?
Fi gu re 2 Bus Connection property in ETS

No. To import devices from an exported ETS Project file it is not necessary to configure the B u s C o n n e c t i o n
property in ETS.

Can I di scove r poi nt s f rom di ffe ren t ETS proje ct s a n d a dd t he m t o t h e same d evi ce ?
Fi gu re 3 Multi-level project

Yes you can. You can also add points from different projects that use different Group Address Style strat-
egies. It is possible to mix points from Two Level, Three Level and Free Group Address styles in the same
device.

10 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 1 About the KNXnet/IP driver

A p a s s w o rd - p ro t e c t e d d i a l o g u e o p e n s w h e n I t r y t o d i s c o v e r d e v i c e s a n d p o i n t s . W h y i s
t hi s a n d wh at password do I en t e r?
The KNX ETS can export a project with a password. The KNXnet/IP driver can open the project when you
present the correct credentials. You will need to enter the same password used to set up the ETS project.

D r i v e r FA Q s
What is a KNXnet/IP Interface device?
A KNXnet/IP Interface device is a hardware device that supports KNXnet/IP tunnelling only. A single inter-
face, such as the Weinzierl 730 and the Siemens N 148/22 may support multiple KNXnet/IP tunnelling con-
nections. These devices can have simultaneous tunnelling connections, which are managed by defining
multiple KNX individual device addresses on the device. In the KNXnet/IP driver, this is called the Individual
Device Address and allows the KNX network to be accessed by both ETS and the KNXnet/IP driver.
Wh at i s a K NXn e t/ IP rout e r de vic e ?
This is a hardware device that supports both KNXnet/IP tunnelling and KNXnet/IP routing connections, as
well as having the filter table to allow the device to perform as a coupler. Some KNXnet/IP Routers, such as
the Siemens N 146/02 allow multiple tunnelling connections.

Wh at i s K NXn e t /IP rou ti n g?

KNXnet/IP Routing is a multicast-based telegram, which allows a KNXnet/IP router to perform the function
of a line or area coupler. This means the backbone of a KNXsystem can be Ethernet-based, allowing a much
higher speed of transmission and more flexibility when installing. The KNXnet/IP router also provides a filter
table to manage the flow of traffic where needed.
The KNXnet/IP driver does not support KNXnet/IP Routing.

Wh at i s p roxy rou ti n g?
The KNXnet/IP driver does not directly support the KNXnet/IP Routing Service. Proxy routing:
• Enables the KNXnet/IP driver to communicate with KNXnet/IP router devices whose IP subnet differs
from the Host IP subnet.
• Allows the KNXnet/IP driver to communicate with multiple KNXnet/IP router devices without using up a
KNXnet/IP tunnelling connection in each KNXnet/IP router.
Proxy routing relies on configuring a KNXnet/IP device in the station using a KNXnet/IP tunnelling connec-
tion to one KNXnet/IP router device that has the same IP subnet address as the host. The KNXnet/IP router
device’s filtering needs to be configured to allow it to route messages from the KNXnet/IP tunnelling con-
nection to other KNXnet/IP router devices and vice-versa.
The other KNXnet/IP routerdevices can then be configured as KNXnet/IP devices in the station with their
C o n n e c t i o n M e t h o d property set to Proxy Routing and their proxy device address and other connection
properties set to the KNXnet/IP device that was configured to use the KNXnet/IP tunnelling connection de-
scribed above.
Wh at K NX ne t /IP d evi ce a ddre ss i nf or mat i on doe s t he KNX dr i ve r n e ed an d ho w doe s i t
obtain it?
Interfaces and routers are the two primary KNXnet/IP device types. The KNXnet/IP driver needs three ad-
dresses to communicate with either of these device types:
• I p A d d re s s : Obtained from the KNXnet/IP device either over the KNX network using the driver’s search-
network-for-devices feature or by manual data entry.
• C o n t r o l P o r t N u m b e r : Obtained from the KNXnet/IP device either over the KNX network using the driv-
er’s search-network-for-devices feature, by manual data entry, or by default.
N O T E : The default C o n t ro l P o r t N u m b e r is 3671.

May 12, 2021 11

Chapter 1 About the KNXnet/IP driver Niagara KNXnet/IP Driver Guide

• I n d i v i d u a l D e v i c e A d d r e s s : Obtained from the KNXnet/IP device either over the KNX network using
the driver’s search-network-for-devices feature, by manual data entry, or by using importing devices from
the driver’sknxproj file.
N O T E : Manual data entry is not available in v29 of the KNXnet/IP driver.
The KNXnet/IP driver’s search-network-for-devices (device discovery) feature uses a multicast connection.
N O T E : If both the I p A d d r e s s and C o n t ro l P o r t N u m b e r are known by the KNXnet/IP driver, it does not in-
itiate a search request via a multicast connection.
Does the KNXnet/IP driver support multicast telegrams?
The term “multicast” can apply to both IP Multicast and the KNX point-to-multi-point, connection-less (multi-
cast) transport layer communication mode.
To facilitate device discovery on the network, the KNXnet/IP driver does support IP Multicast.
N O T E : The default I P M u l t i c a s t A d d r e s s is 224.0.23.12.
The KNXnet/IP driver inherently supports the KNX point-to-multi-point, connection-less (multicast) transport
layer communication mode in so far as it makes use of the A_GroupValue_Read-PDU, A_GroupValue_Re-
sponse-PDU and A_GroupValue_Write-PDU Application Layer services, which are only supported using this
communication mode.
Does the KNX driver support KNXnet/IP devices that do not support multicast?
Yes, providing the I p A d d r e s s and C o n t ro l P o r t N u m b e r are known to the KNXnet/IP driver. They can both
be entered manually.
N O T E : Multicast–connection support is part of the Core: KNXnet/IP service, which is mandatory for all certi-
fied KNXnet/IP devices.
W h a t c o n t ro l s t h e r a t e o f K N X d a t a re q u e s t s f ro m t h e d r i v e r ?
The I n t e r M e s s a g e D e l a y setting in the tunnel connection paces the out-going data requests from the driv-
er. This can be used to reduce the rate of data requests in cases where a KNXnet/IP Interface device cannot
cope with the traffic volume, caused possibly by its implementation settings or by its operating speed. The
I n t e r M e s s a g e D e l a y default setting of minimum 15ms has proved successful with Siemens interface devi-
ces. Any problems arising from this being set too small would manifest as control points intermittently hav-
ing a Read Fault: Timed out waiting for L_Data_con (condition).
Fi gu re 4 Inter Message Delay

Each out-going data request actually involves six packets travelling between the KNXnet/IP driver and the
KNXnet/IP Interface as follows:
1. Request from KNXnet/IP driver to KNXnet/IP Interface
2. Acknowledgement from KNXnet/IP Interface to KNXnet/IP driver
3. Confirmation from KNXnet/IP Interface to KNXnet/IP driver
4. Acknowledgement from KNXnet/IP driver to KNXnet/IP Interface
5. Reply from KNXnet/IP Interface to KNXnet/IP driver
6. Acknowledgement from KNXnet/IP driver to KNXnet/IP Interface
This appears as several flashes on the KNXnet/IP Interface’s LEDs.

12 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 1 About the KNXnet/IP driver

N O T E : There is an important difference in the implementation of I n t e r M e s s a g e D e l a y between the

KNXnet/IP driver and the EIBnet/IP driver. In the EIBnet/IP driver the I n t e r M e s s a g e D e l a y was applied be-
tween all out-going messages, including acknowledgements and all connection control messages. The
KNXnet/IP driver only applies the I n t e r M e s s a g e D e l a y between data request messages.

Ca n I h ave more t ha n on e KNX n et wor k in my sta t ion ?

No. There can only be one K n x N e t w o r k in a station.
F ig ure 5 Driver Manager view

H o w d o e s t h e d r i v e r p re v e n t c o m m u n i c a t i o n s t r a ff i c f ro m s w a m p i n g t h e K N X t w i s t e d p a i r
line?
The KNXnet/IP driver prevents the KNX twisted pair line from being swamped with traffic by controlling the
number of concurrently active group address read operations and is set by the M a x P e n d i n g R e a d s prop-
erty in the G r o u p D a t a M a n a g e r. The term “active” in this context means that:
1. A particular group address read operation reached the head of the group data operation queue.
2. The communications stack sent an L_Data_req message to the KNXnet/IP device and received an L_Da-
ta_con reply, but has not yet received a corresponding L_Data_ind message.
The default value of M a x P e n d i n g R e a d s is 4 but, unfortunately, there is no clear guidance in the KNX Specs
as to what an acceptable M a x P e n d i n g R e a d s value should be. However, having this value too small does
not cause a read–queue–is–full fault.
F ig ure 6 Max Pending Reads

Is the IP port adjustable?

This question is sometimes asked by IT departments who need control over the IP port usage on their
network.
P ro t o c o l : The KNX System specifications specify that UDP (User Datagram Protocol) is used for KNXnet/IP
connections rather than TCP (Transmission Control Protocol) and, therefore, the following commentary on
ports and messaging is in relation to UDP.
D e v i c e a n d D r i v e r P o r t s : There are four logical UDP ports allocated for each tunnel connection between
the KNXnet/IP driver and a KNXnet/IP Interface device. Two ports (one for control and one for data) are at
the device and two ports are at the driver (control and data). Activities, such as opening, closing, the connec-
tion and for heart beat use the control port. Point data use the data port.
P o r t n u m b e r s : It is usual that KNXnet/IP Interface devices use port 3671 for both control and data, but this
may not always be the case. The KNXnet/IP driver dynamically allocates the two ports it uses to communi-
cate with the device when establishing and maintaining a connection. In this way, the driver can separate the
messaging between multiple devices concurrently by allocating different port numbers. In the driver, the
control and data ports for each device are always different.

May 12, 2021 13

Chapter 1 About the KNXnet/IP driver Niagara KNXnet/IP Driver Guide

P o r t n u m b e r s e l e c t i o n : The ETS tool sets the port numbers used by the KNXnet/IP Interface device (pro-
vided that the device can be configured). The port numbers that the KNXnet/IP driver chooses dynamically
for each Local Interface range between a port-minimum (0-65535) and port-maximum (0-65535). The default
values of these are 3500 and 4000 although they can be changed when setting up of the driver. Clearly, re-
ducing the range restricts the number of potential device connections and, ultimately, if the range offers only
one port number, the driver will not function because two ports is a minimum for each device connection.
R e c y c l i n g p o r t n u m b e r s : When dynamically choosing a new port number, the KNXnet/IP driver starts at
the port minimum number (default setting) and chooses the next available port number or it cycles through
the range. You can select this behaviour when setting up the driver.

T u n n e l l i n g FA Q s
KNXnet/IP tunnelling is the primary method of interfacing to a KNX system. It allows for Unicast communica-
tion from a single external device to the KNX system. This is akin to using a USB or Serial Interface to inter-
face to the KNX system.
What maintains the tunnel connection?
The C o n t r o l E n d P o i n t connects, maintains and disconnects the tunnel connection. To be more precise,
control of the tunnel connection is the only thing the C o n t ro l E n d P o i n t does. The C o n t ro l E n d P o i n t sees
very little traffic, only two or three messages to connect or disconnect and one or two messages per minute
to maintain the connection.
Fi gu re 7 Maximum Received Packets Que Size

The M a x i m u m R e c e i v e d P a c k e t s Q u e S i z e controls the size of the control end point’s receive queue. It de-
faults two five packets. If this value were too small, there would be an indication of lost frames in the hidden
R x F r a m e s L o s t Q u e u e F u l l communications counter.

Fi gu re 8 Rx Frames Lost Queue Full

Whi ch q ue u e is us ed fo r dat a t hrou gh t h e tu n n el c onn e ct ion ?

The M a x i m u m R e c e i v e d P a c k e t s Q u e S i z e controls the size of the tunnel connection’s D a t a E n d P o i n t re-
ceive queue. All G ro u p A d d r e s s messages pass through this queue and End Point so it is much busier than
the C o n t ro l E n d P o i n t . Because it handles more traffic, its default queue size of 50 is larger than that of the
C o n t r o l E n d P o i n t ’s queue size.

14 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 1 About the KNXnet/IP driver

F ig ure 9 Maximum Received Packets Que Size

Unlike the G ro u p D a t a O p e r a t i o n Q u e u e , the necessary size of this queue does not depend on the number
and frequency of control point polling. Instead, it depends on how quickly the KNXnet/IP driver can process
incoming messages, which in turn depends on the overall CPU usage in the platform.
You can monitor the success or otherwise of received data by inspecting the R x F r a m e s L o s t Q u e u e F u l l
counter in the hidden communications counters. Depending on the number and frequency of lost Rx frames
you can try increasing the M a x i m u m R e c e i v e d P a c k e t s Q u e S i z e in steps of 50, until no more Rx frames
are being lost.
F ig ure 10 Rx Frames Lost Queue Full

C om p o und S tr uc tu res
The KNX standard specifies that some Datapoint Types (DPT) have compound structures, where one DTP
contains several data fields. So, how does the KNXnet/IP driver write to a KNX compound structure DPT?
This topic answers this question with an example.
Datapoint Type 222.100 is a DPT with three sets of room temperature setpoints, each of which is a 16-bit
float value. The room temperature setpoint comfort (TempSetpComf), room temperature setpoint standby
(TempSetpStdby) and room temperature setpoint economy (TempSetpEco) are all encoded within the same
DPT.
From the standpoint of the framework’s driver data model, each of these setpoints is a separate proxy point
but, on the wire, KNX compounds them into one group address. Therefore, when it writes to the group ad-
dress the KNXnet/IP driver must know the current value of every field before overwriting the DPT. To do
this, the driver reads the whole group address before individually overwriting the data. This behaviour can
be seen in the following ETS Group Monitor diagnostic of Group Address 7/1/0, which is a 222.100 DPT:

F ig ure 11 Datapoint Type compound structures

• Line 1: Read group address

May 12, 2021 15

Chapter 1 About the KNXnet/IP driver Niagara KNXnet/IP Driver Guide

• Line 2: Response data 00 00 00 00 00 00

• Line 3: Write TempSetpComf data 0C 1A 00 00 00 00 (Decimal 3098)
• Line 4: Read group address
• Line 5: Response data 0C 1A 00 00 00 00
• Line 6: Write TempSetpStdby Data 0C 1A 06 A4 00 00 (Decimal 1700)
• Line 7: Read group address
• Line 8: Response data 0C 1A 06 A4 00 00
• Line 9: Write TempSetpEco Data 0C 1A 06 A4 05 DC (Decimal 1500)
• Line 10: Read group address
• Line 11: Response data 0C 1A 06 A4 05 DC

Quick start
The basic steps to configure a station to communicate with a KNX system involve setting up Workbench,
commissioning the Supervisor or JACE platform and configuring input proxy points.
Step 1 Plan and then configure the KNX system using the ETS (Engineering Tool Software).
This software is separate from the Niagara Workbench
Step 2 Using ETS, export the ETS Project. This provides the source of KNX system data for the KNXnet/IP
driver.
Step 3 Copy the KNXnet/IP driver modules to the C:\Niagara\Framework-n.n.nn\Modules folder,
where Framework-n.n.nn is the version of the
Step 4 Commission the remote controller platform.
Commissioning is documented in the controller guide.
Step 5 Set up a KnxNetwork in the station.
The detailed procedures in this guide begin with this step.
Step 6 Update the KNX Data Defs (data definitions).
Step 7 Configure the connection.
Step 8 Set up one or more KNX devices in the station.
Step 9 Set up one or more KNX points in the station.
Step 10 Set up alarms and other components.
For information on how to set up alarms, refer to Niagara Alarms Guide.

16 May 12, 2021

Chapter 2 Station setup
Topics covered in this chapter
♦ Adding a Knx Network
♦ About KNX Data Defs
♦ Configuring the connection to the KNX Network
♦ Device setup
♦ Adding points from an ETS project file
♦ Troubleshooting

The KNXnet/IP driver integrates a KNX system into a station.

The KNXnet/IP driver uses a familiar framework driver hierarchy of an upper-tier parent network component
and one or more child device components, each with device extension (ext) child components.

Adding a Knx Network

Adding the network is the first step to configuring the station.
P re re q u i s i t e s :
You configured and exported the ETS Project, copied the Knxnet/IP driver modules to the Niagara folder
on the PC, commissioned the remote controller, and are working in Workbench on a PC.
Step 1 In the Nav tree, expand the station and double-click on D r i v e r s node.
The D r i v e r M a n a g e r view opens.
Step 2 In the D r i v e r M a n a g e r view, open the KNXnet/IP driver palette in the side bar.

Step 3 Select the k n x n e t l p module and click O K .

Step 4 Drag or copy the KnxNetwork component from the palette to the D r i v e r M a n a g e r view.

May 12, 2021 17

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

Step 5 Name the network and click O K .

The added KnxNetwork appears with a Status of {down,alarm,unackedAlarm}, because its
K N X D a t a D e f s have not yet been loaded.
You are now ready to load the data definitions.

About KNX Data Defs

For the KNXnet/IP driver to translate the encoded native KNX Group Address data from the KNX devices to
the human friendly format displayed in the properties of control points, and vice versa, the driver needs in-
formation about the standard KNX Datapoint Types as published in the KNX specification document: 03_
07_02 Datapoint Types v01.08.03 AS.pdf (or later version). This information is collectively referred to
as the KNX Data Definitions or KNX Data Defs.
The KNX Data Defs are stored in a file called knx_extra.xml. In addition, there is information about the units,
minimum and maximum values, and compatible Control Point types for each of the KNX Datapoint Types
Workbench contains a copy of the KNX Data Defs. Each station also has its own copy of KNX Data Defs.
The knx_extra.xml file works along similar lines to KNX’s knx_master.xml file, which is part of the ETS
installation and is updated from time to time with new KNX Datapoint Types by the KNX organization. The
knx_extra.xml file is fundamental to the correct operation of the KNXnet/IP driver and it is internally
signed to avoid the possibility of introducing erroneous operation of the KNXnet/IP driver.
Each release of the KNXnet/IP driver contains a version of knx_extra.xml that is current at the time of re-
lease, however newer versions of the knx_extra.xml file will be published to keep pace with changes to
the KNX knx_master.xml.
N O T E : There is no correlation between the version number of the KNX Data Defs (for example 027) and the
version number of the KNXnet/IP driver module (for example 3.8.41.1.0.29).

18 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

Loading the Data Defs

Loading the Knx Data Defs is a prerequisite to setting up the network. Workbench and the station maintain
separate copies of data definitions. Each should contain the same definitions. This procedure assumes you
are loading definitions for the first time into both Workbench and a remote controller station.
P re re q u i s i t e s : You are working in Workbench on a PC. The KNX network driver has been added to the D r i v -
e r s node in the appropriate station.
Step 1 In the station, expand S t a t i o n → C o n f i g and double-click the D r i v e r s node in the Nav tree.
The D r i v e r M a n a g e r view opens.

Notice that the KnxNetwork is {down}.

Step 2 Double-click on the KNXNetwork driver row in the table.
If this is the first time you are using Workbench with a KnxNetwork, the driver checks for the KNX
data definitions. If it detects new definitions, it updates the station database automatically.

The driver makes only a single attempt to synchronize data definitions per session, unless the pre-
vious attempt failed.
After updating data definitions, it opens the K N X D e v i c e M a n a g e r view.
Step 3 Double-click the D r i v e r s node in the Nav tree again.
Once the data definitions are loaded, unless an error occurred, KNX Data Definition setup is com-
plete, and the D r i v e r M a n a g e r view clears the {down} status of the K N X N e t w o r k .

Step 4 If the load failed, try one of the following:

• Open the K n x D e v i c e M a n a g e r (by double-clicking the K n x N e t w o r k node in the Nav tree) or
open the P o i n t M a n a g e r (by expanding a K n x N e t w o r k → K n x D e v i c e and double-click the
P o i n t s folder), then force a load attempt by clicking C h e c k D a t a D e f s .

• Click T o o l s → K N X I m p o r t S e r v i c e , right-click K n x D a t a D e f s and click the A c t i o n s → L o a d D a t a

Defs.
The data definitions should load.

May 12, 2021 19

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

You are ready to update data definitions in the remote station and configure the KNX network driver’s con-
nection to the physical KNXnet/IP network.

Loading the Data Defs manually

If the automatic load of the KNX Data Defs failed, you can load them manually.
P r e r e q u i s i t e s : You are working in Workbench with the D r i v e r M a n a g e r view open.
Step 1 Expand T o o l s → O p t i o n s → K N X I m p o r t S e r v i c e .
Step 2 Set Automatically Use Newer Data Defs to false.

Step 3 In the D r i v e r M a n a g e r view, double-click on the K N X N e t w o r k d r i v e r and open its D e v i c e M a n -

a g e r view.

Step 4 If this is the first time your Workbench has been used with a K N X N e t w o r k , the I m p o r t T e m p o r a -
r i l y D i s a b l e d window opens.

Step 5 To load the Workbench Service’s K N X D a t a D e f s , click Ye s .

The I m p o r t T e m p o r a r i l y D i s a b l e d window, with reference to the station’s K N X D a t a , opens.

20 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

Step 6 To load the station’s K N X D a t a D e f s , click Ye s .

The D r i v e r M a n a g e r view clears the {down} status of the K N X N e t w o r k .

You are now ready to configure the KNX network driver’s connection to the physical KNXnet/IP network.
N O T E : If loading failed for some reason, there is a button available in the D e v i c e and P o i n t M a n a g e r views
to force a loading attempt.

Examining the Data Defs

You can examine the current status and version of the KNX Data Defs in use in both the Supervisor and re-
mote stations.
P re re q u i s i t e s : You are connected to the station and working in Workbench.
Step 1 To view the Data Defs in the Supervisor station, expand T o o l s and double-click the K N X I m p o r t
Service.
The K N X I m p o r t S e r v i c e view opens.
Step 2 Expand Knx Data Defs and review the definitions that are currently loaded in the Supervisor
station.
Step 3 To view the Data Defs in a remote controller station, expand C o n f i g → D r i v e r s in the Nav tree,
right-click the K n x N e t w o r k and click V i e w s → A X P r o p e r t y S h e e t .
The network P r o p e r t y S h e e t opens.
Step 4 Expand Knx Data Defs and review the definitions that are currently loaded in the remote station.

Updating the Data Defs

From time to time the KNX Data Defs in the Workbench and station may need to be updated. Workbench
and the station maintain separate copies of data definitions. This procedure updates the Workbench defini-
tions and uses them to update the remote station’s data definitions.
P re re q u i s i t e s : The PC running Workbench and the remote station already contain KNX Data Defs.
New versions of the knx_extra.xml file are published to a DropBox folder available here: https://www.
dropbox.com/sh/uwkdggd10fi1955/AAAhMkD6CoQtLx-A_DPEoguga?dl=0
The latest version is always knx_extra.xml in the root of this shared Dropbox folder.
N O T E : Older versions are available in the Previous Versions of knx_extra.xml sub-folder, however it
should not be necessary to use these and if one were required you must rename it to remove the _vXXX
suffix.

May 12, 2021 21

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

Step 1 Obtain the latest knx_extra.xml from Dropbox and put it in the knx sub-folder of your Niagara
installation on your PC (for example:. C:\Niagara\Niagara-n.n.nn\knx\knx_extra.xml).

Step 2 In Workbench, click T o o l s → K N X I m p o r t S e r v i c e .

The AX Property Sheet opens.
Step 3 Do one of the following: To automatically update the Workbench data definitions,
• Right-click Knx Data Defs followed by clicking the A c t i o n s → L o a d D a t a D e f s .

• Click Imported Files.

The driver examines the new knx_extra.xml file you copied into the knx sub-folder of your in-
stallation and displays:

Step 4 To continue with the automatic update, click Ye s .

The driver automatically updates the data definitions.
If you clicked Imported Files, the E t s P r o j e c t F i l e I m p o r t M a n a g e r view opens. Otherwise the
focus remains on the A X P ro p e r t y S h e e t .
Step 5 To update the remote station’s KNX Data Defs, navigate to the Supervisor’s K n x D e v i c e M a n a g e r
or K n x P o i n t M a n a g e r view.

22 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

As it loads the view, the driver checks the station’s version of the data definitions against Work-
bench’s version. Since the versions differ, the driver prompts you:

Step 6 To synchronize data definitions between Workbench and the station, click Ye s .
The driver updates the data definitions.
Step 7 To view the current status of the data definitions in the remote station, right-click the K n x N e t w o r k
node in the Nav tree, click V i e w s → A X P ro p e r t y S h e e t ,and confirm the status of the Knx Data
Defs.

Configuring the connection to the KNX Network

The KNXnet/IP driver’s connection to the physical network can now be configured.
P re re q u i s i t e s : The KNX network driver has been added to the D r i v e r s node and the Data Defs loaded in
Workbench and the station.
Step 1 To open the KnxNetwork P r o p e r t y S h e e t , right-click the K n x N e t w o r k node in the Nav tree, click
V i e w s → A X P r o p e r t y S h e e t , and expand the L o c a l I n t e r f a c e s → L o c a l I n t e r f a c e properties.

May 12, 2021 23

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

A default Local Interface has been added to the KNXnet/IP driver and a default Knx Installation has
been added to the Local Interface.
Step 2 Select the Adapter Id to use for this connection to the physical KNX Network.
N O T E : You can add additional Local Interfaces from the palette for each of the platform’s TCP/IP
Interfaces to use for connecting to a physical KNX Network. All the Local Interfaces in the station
must have different Adapter Ids.

Step 3 Expand the Knx Installation section of the A X P r o p e r t y S h e e t and enter the Multicast Ip
Address.

24 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

N O T E : If you are using more than one Knx IP Multicast Address, you can add additional Knx Instal-
lation instances from the palette to any Local Interface. All the Knx Installation instances under a
Local Interface must have different Knx IP Multicast Addresses.
Step 4 To update the database, click S a v e .
You are now ready to add KNXnet/IP interface devices to the KNX network driver.

Device setup
Setting up the network involves adding and configuring devices and points.
You add KNX device instances to the station in three ways:
• By using the framework to discover the devices on a connected, physical KNX network
• By importing device data from an ETS project file (*.knxproj)
• By manually inputting the device data

Discovering devices
Discovery adds KNX device instances to the station database.
P re re q u i s i t e s : The KNX network driver has been be added to the D r i v e r s node. The KNX Data Defs are
loaded. The connection to the physical KNXnet/IP network has been configured.
Step 1 Expand the station C o n f i g node, double-click the D r i v e r M a n a g e r node, and double-click the
KNXNetwork driver row in the table.
The K n x D e v i c e M a n a g e r view opens.

May 12, 2021 25

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

Step 2 Click D i s c o v e r.
The D i s c o v e r / I m p o r t D e v i c e s window opens.

Step 3 Select the Search network for Devices option, choose which Knx Installation to search from
the drop-down list and click O K .
The discovery process takes about 10 seconds for each Knx Installation search.

Step 4 Drag Device(s) from the D i s c o v e re d pane to the D a t a b a s e pane or click A d d .

The A d d window opens.

26 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

N O T E : As discovery adds the devices to the database it updates the Knx Installation and Ip
Address properties. You do not need to configure them here.
Step 5 Make any other configuration changes and click O K .

I mp orti ng de vic es from a n E TS p roj ect fi le

Instead of discovering devices, you may import them from an ETS project file.
P re re q u i s i t e s : The KNX network driver has been be added to the D r i v e r s node. The KNX Data Defs are
loaded. The connection to the physical KNXnet/IP network has been configured.
Step 1 Expand the station C o n f i g node, double-click the D r i v e r M a n a g e r node, and double-click the
KNXNetwork driver row in the table.
The K n x D e v i c e M a n a g e r view opens.

Step 2 Click D i s c o v e r.
The D i s c o v e r / I m p o r t D e v i c e s window opens.

May 12, 2021 27

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

Step 3 Select the Import Devices from cache/file and the Import from file options and click on
the File Chooser.
The F i l e C h o o s e r window opens.

Step 4 Navigate to and select your ETS Project file, click O p e n , then click O K in the D i s c o v e r / I m p o r t D e -
v i c e s window.
The time it takes to import an E T S P r o j e c t f i l e is proportional to its size.
The E t s P r o j e c t F i l e I m p o r t view opens.

Step 5 Drag the device(s) from the D i s c o v e r e d pane to the D a t a b a s e pane or click A d d to display the
A d d window.

28 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

N O T E : This process imports only the Individual Device Address from the ETS Project file.
You must configure the Knx Installation for each device. It is not necessary to configure the Ip
Address now because the first time the framework connects to the device, using the device’s In-
dividual Device Address, it retrieves the Ip Address from the device itself.
Step 6 Configure the Knx Installation and click O K .

Adding devices manually

If neither discovery nor importing from the ETS project file works you can add devices manually.
P re re q u i s i t e s : The KNX network driver has been be added to the D r i v e r s node. The KNX Data Defs are
loaded. The connection to the physical KNXnet/IP network has been configured.
Step 1 Expand the station C o n f i g node, double-click the D r i v e r M a n a g e r node, and double-click the
KNXNetwork driver row in the table.
The D e v i c e M a n a g e r view opens.

Step 2 Click N e w.

May 12, 2021 29

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

The N e w [devices] window opens.

Step 3 Enter the N u m b e r t o A d d [of devices] and click O K .

A second N e w window opens.

N O T E : When you add devices manually, you must configure both the Knx Installation and Ip
Address for each device. It is not necessary to configure the Individual Device Address be-
cause, when the KnxNetwork driver first tries to connect to the device, the driver uses the Ip Ad-
dress to discover the Individual Device Address from the dervice itself.
Step 4 Configure any other properties and click O K .

Ad d ing p oi nts from an E TS p roj ec t fi le

The only method to add KNX points through discovery is by using the ETS project file.
Prerequis i tes :
One or more Knx device instances has been be added and configured to the Knxnet/IP driver.
Step 1 Expand C o n f i g → D r i v e r s → K n x N e t w o r k → K n x D e v i c e .
Step 2 Double-click on P o i n t s node.
The K n x P o i n t M a n a g e r view opens.

30 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

Step 3 Click D i s c o v e r.
The D i s c o v e r / I m p o r t D e v i c e s window opens.

N O T E : The cache retains all the previously loaded ETS project files. To speed import, you can im-
port from cache. When you do so, the driver checks to detect changes to the original file since it
was last imported into the cache.
Step 4 Select Import from cache or Import from file option and click O K .
The E t s P r o j e c t F i l e I m p o r t view opens.

May 12, 2021 31

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

Step 5 Drag point(s) from the D i s c o v e re d pane into the D a t a b a s e pane or click A d d .
The A d d window opens.

32 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

Step 6 To add points into the database, click O K .

T roub l es hoo t ing

This topic covers some issues and how to resolve them.

Can I have both the KNXnet/IP driver and EIBnet/IP driver running in my station?
No. There is an absolute certainty of conflict between the KNXnet/IP driver and the older EIBnet/IP driver if
they are running concurrently. If there is an EIBnet/IP driver in the station, delete it before you enable the
KNXnet/IP driver.
W h y, w h e n d i s c o v e r e d p o i n t s a re a d d e d t o t h e D a t a b a s e , a r e t h e y i n { f a u l t } ?

One of the many reasons why points can go to a {fault} condition, relates to the R1 firmware revision of
the Siemens N 148/22 KNXnet/IP Interface device. It may also occur with other KNXnet/IP Interface devices.
The problem is caused by the KNXnet/IP Interface device failing to respond with an acknowledge message
although message confirmation has been requested by the KNXnet/IP driver.
You may also observe that the F a u l t C a u s e property of the point proxy extension indicates Read fault:
confirmation — Confirm Timed Out.

May 12, 2021 33

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

One way to overcome this problem is to upgrade the R1 firmware revision level of the Siemens N 148/22
KNXnet/IP Interface device (or any other KNXnet/IP interface device). It is beyond the scope of this docu-
ment to detail the steps to accomplish this, but manufacturers of KNXnet/IP interface devices may provide
tools and guidance to upgrade their firmware.
Another way to overcome the problem is available within the KNXnet/IP driver. To do this, configure the
KNXnet/IP driver not to request an acknowledgement to its messages. To configure this use a hidden prop-
erty in the tunnel connection of the KNXnet/IP driver.
Unhide the r e q u e s t A c k n o w l e d g e m e n t s slot of the K n x N e t w o r k → K n x D e v i c e → C o m m s C o n n e c t i o n -
s→Tunnel Conn.

Change the Request Acknowledgements property to false.

Why do some points randomly change state between {stale} and/or {fault} and {ok}?

If, after appropriate time-outs, the KNXnet/IP driver fails to receive requested data from the KNX device,
points go to a {fault} and/or {stale} state.
If the KNX device subsequently transmits data, for example a change of state or value, the KNXnet/IP driver
receives this unsolicited message thereby causing a change of proxy point status.

34 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 2 Station setup

W h y, w h e n d i s c o v e r e d p o i n t s a re a d d e d t o t h e D a t a b a s e , s o m e a r e { s t a l e } a n d s o m e a r e
not?

One of the many reasons why points can go to a stale state relates to the ETS project file.
When points are added to the database from a ETS project file, their subscription properties are automati-
cally configured based on the communications flags set in the ETS project. These are the flags for the KNX
device's group objects, which are associated with the point's Group Address.
If a group address has at least one KNX device group object associated with it that has its Read Communi-
cation Flag property enabled, the Poll once on subscribed, Poll once on operational and Poll
until answer after poll once properties are set to true. This triggers an immediate poll of the Group
Address (because this view is itself subscribed to the point).
If a Group Address has no associated KNX device group objects that have their Read Communication
Flag enabled, its subscription properties are all set to false by default. The value, however, may be up-
dated (and become not stale) in the KNXnet/IP driver when any subsequent unsolicited messages regarding
the Group Address are received from the KNX system.
Here are the Read Communication Flag settings for some of the points in the example shown above:
N O T E : The Control Output (Control value) object has its Transmit flag set. This causes an unsolicited mes-
sage transmission from the KNX device.

Please explain the Read fault: The ‘Read’ queue is full.

This fault occurs when an attempt is made to enqueue (add an item to a queue) a read request of a particular
Group Address, where the queue is already full and the Group Address in question is not already in the

May 12, 2021 35

Chapter 2 Station setup Niagara KNXnet/IP Driver Guide

queue. The queue in question is the Group Data Operation Queue, which holds a list of group data opera-
tions (Group Address reads or writes) waiting to be started as soon as the communications stack is able.
The Group Data Operation Queue has its size exposed under the hidden L D a t a Wo r k e r child of the G r o u p
D a t a M a n a g e r, immediately preceding the Hop Count property and can be seen in the example below. The
default value of the Group Data Operation Queue is 50.
Subject to how many Group Addresses are being polled, how often, and the amount of available RAM, you
could try increasing the value to 1000 to overcome the fault.

36 May 12, 2021

Chapter 3 Components
Topics covered in this chapter
♦ knxnetIp-Connections
♦ knxnetIp-ConnectionsCommsCounters
♦ knxnetIp-KnxDevice
♦ knxnetIp-KnxDeviceFolder
♦ knxnetIp-EndPoint
♦ knxnetIp-EndPointCommsCounters
♦ knxnetIp-GroupDataManage
♦ knxnetIp-KnxInstallation
♦ knxnetIp-LocalInterface
♦ knxnetIp-LocalInterfaces
♦ knxnetIp-KnxNetwork
♦ knxnetIp-KnxPointDeviceExt
♦ knxnetIp-TunnelConnection
♦ knxnetIp-TunnelConnectionCommsCounters

Components include services, folders and other model building blocks associated with a module. You may
drag them to a P r o p e r t y or W i r e S h e e t from a palette.
Descriptions included in the following topics appear as context-sensitive help topics when accessed by:
• Right-clicking on the object and selecting V i e w s → G u i d e H e l p
• Clicking H e l p → G u i d e O n T a rg e t

knxnetIp-Connections
These properties configure data communication options.

F ig ure 12 Comms Connections properties

To access these properties, expand C o n f i g → D r i v e r s → K n x N e t w o r k → K n x D e v i c e in the station Nav tree,

right-click the C o m m s C o n n e c t i o n s node, click V i e w s → A X P r o p e r t y S h e e t , and expand G r o u p D a t a
M a n a g e r.
To configure the hidden L Data Worker and Hop Count properties you must first turn off the hidden config
flag. To do so, right-click G r o u p D a t a M a n a g e r in the Nav tree, click V i e w s → A X S l o t S h e e t , right-click the
hidden property row(s) in the table, click Config Flags, un-check the Hidden flag, and click O K .

May 12, 2021 37

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Property Value Description

Maximum Re- number (defaults Controls the size of the C o n t r o l E n d P o i n t receive queue: 2,
ceived Packets to 5) 3 ... max.
Que Size
Because the C o n t r o l E n d P o i n t is only used to connect, main-
tain and disconnect the T u n n e l C o n n e c t i o n , it sees very little
traffic. (only 2 or 3 messages to connect or disconnect and 1 or
2 messages per minute to maintain the connection). If this val-
ue were too small it would show up in the R x F r a m e s L o s t
Q u e u e F u l l counter under the hidden C o m m s C o n n e c t i o n s /
Comms Counters.
Control End Point additional proper- Holds information and configuration for the Control End Point:
ties End Point: state=Closed or state=Open. Refer to knxnetIp-EndPoint,
page 41.

Comms Counters Connections Holds information on the Communications Counters. Refer to

(hidden) Comms Counters knxnetIp-ConnectionsCommsCounters, page 38.

Include In Trace true (default) or Controls whether or not this information is included in the sta-
(hidden) false tion Spy Log.

Tunnel Conn Tunnel Connection Holds information and configuration for the Tunnel Connec-
tion. Refer to knxnetIp-TunnelConnection, page 53.

knxnetIp-ConnectionsCommsCounters
These properties provide communications statistics counters for the Comms Connections. By default, this is
a hidden folder.
Fi gu re 13 Connections Comms Counters properties

To access these hidden properties, you must first remove the config hidden flag, then expand C o n f i g → D r i -
v e r s → K n x N e t w o r k → K n x D e v i c e → C o m m s C o n n e c t i o n s in the station Nav tree, and double-click the
Comms Counters.
Property Value Description
Rx Frames Lost read-only Reports the Rx frames lost when the queue is full : 0, 1, 2 ...
Queue Full max.
The M a x i m u m R e c e i v e d P a c k e t s Q u e S i z e controls the size
of the C o n t r o l E n d P o i n t ’s receive queue size. It defaults of 5.
If this value were too small, there would be an indication of lost
frames here.
Rx Frames Lost No read-only Reports the Rx frames lost due to no packet worker: 0, 1, 2
Packet Worker ... max.

knxnetIp-KnxDevice
This component is the container for all KNXnet/IP proxy points.

38 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

F ig ure 14 Knx Device properties

To access these properties, expand C o n f i g → D r i v e r s → K n x D e v i c e in the station Nav tree, right-click the
K n x D e v i c e node, click V i e w s → A X P r o p e r t y S h e e t .
In addition to the standard properties (Status, Enabled, Fault Cause, Health, and Alarm Source In-
fo), these properties are unique to the KNX Data Defs.

Property Value Description

Config Status read-only Displays the status of the configuration.

Device Id read-only Identifies the device.

Knx Installation drop-down list (de- Selects the multicast address group to which this device
faults to the cur- belongs.
rent interface,
including none
selected)
Ip Address nnnn.nnnn. Specifies the numerical label assigned to an object, which is
nnnn.nnnn connected to a network that uses the Internet Protocol for
communication.
Control Port –1, 1, 2, ... Identifies the port number on the controller or computer used
Number 65535 (defaults to to connect to the network.
-1)
If using fox streaming, which uses the station to render the vid-
eo stream, this port should be different from the station’s fox
port. If you are not using fox streaming, this port should be
the same as the station’s fox port.

Individual Device nnn.nnn.nnn Defines the unique number that identifies the current device
Address object on the network.
Mac Address read-only Specifies the data link layer MAC address of the device.

May 12, 2021 39

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Property Value Description

Device Friendly read-only Displays the alternate name for the KNXnet/IP interface
Name device.
D I Bs, Device Info additional DIBs are Description Information Blocks. These blocks config-
properties ure devices. Refer to Device Info properties, page 40

D I Bs, Supported read-only Indicates that the driver supports no service families.
Service Families
Group Data Group Data Holds information and configuration for the Group Data Man-
Manager Manager ager. Refer to knxnetIp-GroupDataManage, page 43.
Points Knx Point Device Serves as a container for information and configuration proper-
Ext ties for the KNX proxy points. Refer to knxnetIp-KnxPointDevi-
ceExt, page 51

Connection Tunnelling (de- Displays the current mechanism for connecting the device to
Method fault) or Proxy the station.
Routing
Comms Connections Holds information and configuration of the Comms connec-
Connections tions. Refer to knxnetIp-Connections, page 37.

De vic e In f o prop er t ie s
Description Information Blocks of the KNXnet/IP Interface device.

Fi gu re 15 Device Info properties

To access these properties, expand C o n f i g → D r i v e r s → K n x N e t w o r k → K n x D e v i c e in the station Nav tree,

right-click the K n x D e v i c e node, click V i e w s → A X P r o p e r t y S h e e t , and expand D I B s → D e v i c e I n f o .

Property Value Description

Knx Medium read-only Displays the Knx medium.

Device Status read-only Displays the current status of the device.

Individual Address read-only Displays the individual address for the device.

Project Number read-only Displays the ETS project identifier.

Installation read-only Displays the installation number.

Number
Serial Number read-only Displays a serial number.

40 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Property Value Description

Routing Multicast read-only Displays the routing multicast address, in the form: nnn.nnn.
Address nnn.nnn.
Mac Address read-only Displays the of the KNXnet/IP interface device.

Device Friendly read-only Displays the alternate name for the KNXnet/IP interface
Name device.

knxnetIp-KnxDeviceFolder
This component serves as a container for KNX devices.
Use this folder to organize devices in the station by geographic location or some other grouping.

knxnetIp-EndPoint
This component appears in the palette as the Multicast End Point. The same component appears under the
KnxDevice, CommsConnection as a Control End Point and in a Tunnel Conn as a Data End Point. The proper-
ties for each end point are the same.
F ig ure 16 End Point properties

Here is how to access the three versions of this component. All three instances of this component require
you to expand C o n f i g → D r i v e r s → K n x N e t w o r k in the station Nav tree. From the K n x N e t w o r k node, the
procedure varies depending on the instance you are looking for.
Ve r s i o n t o a c c e s s How to access

Multicast End Point Right-click the K n x N e t w o r k node, click V i e w s → A X P ro p e r t y S h e e t , expand L o c a l I n t e r-

f a c e s → L o c a l I n t e r f a c e → K n x I n s t a l l a t i o n , and M u l t i c a s t E n d P o i n t or double-click it.
Double-clicking on M u l t i c a s t E n d P o i n t and clicking H e l p → G u i d e O n T a rg e t opens this
Multicast End Point help topic.

Control End Point Expand K n x D e v i c e → C o m m s C o n n e c t i o n s in the Nav tree, right-click the C o n t r o l E n d

P o i n t node, and click V i e w s → A X P ro p e r t y S h e e t or double-click the C o n t ro l E n d P o i n t
node.

Data End Point Expand K n x D e v i c e → C o m m s C o n n e c t i o n s → T u n n e l C o n n in the station Nav tree, right-

click the D a t a E n d P o i n t node, and click V i e w s → A X P r o p e r t y S h e e t or double-click the
D a t a E n d P o i n t node.

To configure the hidden Comms Counters and Include In Trace properties you must first turn off the hid-
den config flag. To do so, right-click end point in the Nav tree, click V i e w s → A X S l o t S h e e t , right-click the
hidden property row(s) in the table, click Config Flags, un-check the Hidden flag, and click O K .

May 12, 2021 41

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Property Value Description

End Point State read-only Reports the current state of the end point.
state=Closed or state=Open
Local IP Address read-only Reports the local IP address in the format: nnn.nnn.nnn.
nnn.
Local Port read-only Reports the port number for the local port in the format:
nnnn.
Remote IP Read-only Reports the IP address of the KNXnet/IP interface device in
Adddress the format: nnn.nnn.nnn.nnn.
Remote Port read-only Reports the port number at KNXnet/IP interface device in the
format: nnnn.
Max Packet Size numeric, 128 — Defines the packet size.
512 (Defaults to
128)
Comms Counters additional Holds information on the Communications Counters. Refer to
(End Point Comms properties knxnetIp-EndPoint, page 41
Counters) (hidden)
Include In Trace true (default) or Controls whether or not this information is included in the sta-
(End Point Include false tion Spy Log.
In Trace) (hidden)

knxnetIp-EndPointCommsCounters
These properties provide communications statistics counters for the control end point. By default, this is a
hidden folder.
Fi gu re 17 End Point Comms Counters properties

The end point comms counters to view depends on your end point. There may be three instances in the sta-
tion: Multicast End Point, Control End Point and Data End Point. To access these hidden properties, first
change the hidden flag for C o m m s C o u n t e r s properties, then expand C o n f i g → D r i v e r s → K n x N e t -
w o r k → K n x D e v i c e in the station Nav tree, double-click one of the end point components (Multicast, Control
or Data) and click the C o m m s C o u n t e r s component.

Property Value Description

Invalid Frame read-only Reports invalid frame headers: 0, 1, 2 ... max.
Headers
Rx Own Packets read-only Reports ignored Rx Own packets: 0, 1, 2 ... max.
Ignored
Packets Sent read-only Reports packets sent: 0, 1, 2 ... max.

42 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Property Value Description

Packets Sent With read-only Reports packets sent with an inter-message delay: 0, 1, 2
Inter Message ... max.
Delay
Packets Received read-only Reports packets received: 0, 1, 2 ... max.
Frames Lost Be- read-only Reports frames lost because the listener contains null: 0, 1, 2
cause Listener is ... max.
Null
Frames Received read-only Reports frames received with an unsupported version of the
With Unsupported protocol: 0, 1, 2 ... max.
Protocol Version

knx netI p -G ro up Da taM anag e

These properties configure the G ro u p D a t a M a n a g e r view.
F ig ure 18 Group Data Manager properties

To access these properties, expand C o n f i g → D r i v e r s → K n x N e t w o r k in the station Nav tree, right-click the
K n x D e v i c e node, click V i e w s → A X P r o p e r t y S h e e t , and expand G r o u p D a t a M a n a g e r.
To configure the hidden L Data Worker and Hop Count properties you must first turn off the hidden config
flag. To do so, right-click G r o u p D a t a M a n a g e r in the Nav tree, click V i e w s → A X S l o t S h e e t , right-click the
hidden property row(s) in the table, click Config Flags, un-check the Hidden flag, and click O K .

Property Value Description

L Data Worker, 1, 2, 3 ... max Defines the size of the G ro u p D a t a O p e r a t i o n Q u e u e that
Max Queue Size Defaults to 1000 holds a list of Group Address reads or writes waiting to be
(hidden) started as soon as the comms stack is able.
L Data Worker stands for the Link Data Worker.
Hop Count 0, 1 , 2 ... 7 (De- Defines a counter for managing frames. Each communications
(hidden) faults to 6) frame contains a hop count. A frame’s hop count is decre-
mented by the KNXnet/IP Router devices to avoid looping
messages. When it becomes zero, the frame is discarded from
the KNX network.

May 12, 2021 43

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Property Value Description

Max Pending 1, 2, 3 ... 10 Controls how many concurrently Active G ro u p A d d r e s s R e a d
Reads (Defaults to 4) O p e r a t i o n s are allowed. Active means that a particular opera-
tion has reached the head of the G ro u p D a t a O p e r a t i o n
Q u e u e and the Comms.Stack has sent an L_Data_req mes-
sage to the KNXnet/IP Interface devices and received an L_
Data_con reply, but has not yet received a corresponding L_
Data_ind message. This limit is intended to prevent the KNX
twisted-pair line from being swamped with this driver’s traffic
although there is no clear guidance on this in the KNX
specifications.

Read Before Write 100ms ... 6secs Defines the amount of time to wait before timing out on a
Timeout (Defaults to 0.5 read-before-write. Read Before Write Timeout.
secs)

knxnetIp-KnxInstallation
Holds information and configuration for the KNX Installation. In addition to the standard properties (Status,
Enabled, and Fault Cause), these properties are unique to Knx Installation.
Fi gu re 19 Knx Installation properties

To access these properties, expand C o n f i g → D r i v e r s in the station Nav tree, right-click the K n x N e t w o r k
node, click V i e w s → A X P ro p e r t y S h e e t , and expand L o c a l I n t e r f a c e s → L o c a l I n t e r f a c e → K n x I n s t a l l a t i o n .
In addition to the standard properties (Status, Enabled, and Fault Cause), this property sheet provides these
properties.

Property Value Description

Config Status read-only Displays the current configuration state of the KNX driver.

Knx Installation Id read-only Displays the ID from the KNX Installation.

Multicast Ip nnn.nnn.nnn. Identifie the address used to broadcast a message to a group

Address nnn (Defaults to of destination computers simultaneously. (Do not confuse mul-
224.0.23.12) ticast with physical layer point-to-multipoint communication.)

Multicast Port number (defaults Configures the port number to multi-cast.

Number to 3671)
Maximum Re- number (Defaults Configures the size of the Tunnel Connection’s Data End Point
ceived Packets to 5) receive queue.
Que Size

44 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

knxnetIp-LocalInterface
KNXnet/IP interfaces are used for programming KNX systems from the Ethernet side. These properties hold
information and configuration values for the local programming interface.
F ig ure 20 Local Interface properties

To access these properties, expand C o n f i g → D r i v e r s in the station Nav tree, right-click the K n x N e t w o r k
node, click V i e w s → A X P r o p e r t y S h e e t , and expand L o c a l I n t e r f a c e s → L o c a l I n t e r f a c e .
In addition to the standard properties (Status, Enabled, and Fault Cause), these properties support the
local interface function.
Property Value Description
Config Status read-only Displays the current configuration state of the local interface.

Local Interface Id read-only Identifies the interface by its number.

Adapter Id drop-down list Identifies the type of adapter among these options: Ehternet2,
Ethernet, Local Area Connection* 9, Local Area Connetion*
11, Wi-Fi, Bluetooth Network Connection.
Types that are not available include “[Disabled]” beside the
option name.

Adapter read-only Describes the adapter.

Description

Adapter IP read-only Reports the IP address of the adapter.

Address
Local Port Min numeric, 1 — Defines the lowest port number from which the driver dynami-
65535 (Defaults to cally assigns the next available number. Obtain Local Socket
3500) Behaviour enables dynamic port assignment.

Local Port Max numeric, 1 — Defines the highest port number to which the driver dynami-
65535 (Defaults to cally assigns the next available number. Obtain Local Socket
4000) Behaviour enables this dynamic port assignment.

May 12, 2021 45

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Property Value Description

Last Used Local read-only Displays the port number assigned most recently.
Port
Obtain Local Sock- Drop-down list (de- Selects how to assign ports.
et Behaviour faults to Recycle
Recycle Ports Immediately causes the driver to assign the
Ports Immediately)
next port starting at Local Port Min.
Cycle Through All Ports cycles through the range of ports.

knxnetIp-LocalInterfaces
This component serves as a container under the KnxNetwork for local interfaces.
This is a default container under the KnxNetwork.

knxnetIp-KnxNetwork
This component is the base container for all KNXnet/IP devices and their child data objects (KNX proxy
points).
Fi gu re 21 KnxNetwork Property Sheet

46 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Property Value Description

Status read-only Indicates the condition of the network, device or component
at the last check.
{ok} indicates that the component is licensed and polling
successfully.
{down} indicates that the last check was unsuccessful, per-
haps because of an incorrect property, or possibly loss of net-
work connection.
{disabled} indicates that the Enable property is set to
false.
{fault} indicates another problem. Refer to Fault Cause
for more information.
Enabled true (default) or Activates (true) and deactivates (false) use of the object
false (network, device, point, component, table, schedule, descrip-
tor, etc.).
Fault Cause additional Indicates the reason why a system object (network, device,
properties component, extension, etc.) is not working properly (in fault).
This property is empty unless a fault exists.

Health additional Reports the status of the network, device or component. This
properties advisory information, including a time stamp, can help you rec-
ognize and troubleshoot problems but it provides no direct
management controls.

Alarm Source Info additional Contains a set of properties for configuring and routing alarms
properties when this component is the alarm source.
Monitor additional Configures a network's ping mechanism, which verifies net-
properties work health. This includes verifying the health of all connected
objects (typically, devices) by pinging each device at a re-
peated interval.

Tuning Policies Tuning Policy Map Refer to Tuning Policies/Default Policy, page 47.

Poll Scheduler Knx Poll Scheduler Refer to knxnetIp-KnxPollScheduler, page 49.

Local Interfaces Local Interfaces Refer to knxnetIp-LocalInterface, page 45.

Knx Data Defs Additional Refer to knxnetIp-KnxStationDataDefs, page 51.

properties

Tuning Policies/Default Policy

The network Tuning Policies holds one or more collections of rules for evaluating both write requests (for ex-
ample, to writable proxy points) as well as the acceptable freshness of read requests from polling.This is the
default tuning policy which is always installed. More tuning policies may be created by copying and editing
this default policy.

May 12, 2021 47

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Fi gu re 22 Tuning Policies, Default Policy properties

Property Value Description

Min Write Time hh-mm-ss, 0ms Specifies the minimum amount of time allowed between writes
... +inf Defaults to writable proxy points, especially ones that have one or more
to 00–00–00 linked inputs. This provides a way to throttle rapidly changing
values so that only the last value is written.
The default value (0) disables this rule causing all value changes
to attempt to write.
Max Write Time hh-mm-ss, 0ms Specifies the maximum amount of time to wait before rewrit-
... +inf Defaults ing the value, in case nothing else has triggered a write, to
to 00–00–00 writable proxy points. Any write action resets this timer.
The default (0) disables this rule resulting in no timed rewrites.
Write On Start true (default) or Determines a writeable proxy point’s behavior when the sta-
false tion starts.
true initiates a write when the station first reaches a steady
state.
false prevents a write when the station first reaches a steady
state.
N O T E : Consider setting to false except for critical proxy
points, otherwise large networks may experience write-queue-
overflow exceptions.
Consider setting this to false for most tuning policies, except
for those selectively assigned to more critical writable proxy
points. This is particularly important for large networks with
many writable proxy points. For example, a Network with
4,000 writable proxy points, if configured with only the default
tuning policy (at default values), will upon station startup at-
tempt to write to all 4,000 points, putting a significant load on
the station. As a consequence, the driver (network) may gener-
ate write queue overflow exceptions.

Write On Up true (default) or Determines a writable proxy point’s behavior when the point
false and its parent device transition from down to up.
true initiates a write when a transition from down to up
occurs.
false prevents a write when a transition from down to up
occurs.

48 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Property Value Description

Write On Enabled true (default) or Determines a writable proxy point’s behavior when the point’s
false status transitions from disabled to normal (enabled).
true initiates a write when the transition occurs.
false prevents a write when the transition occurs.
The disabled-to-enabled status transition can be inherited
globally by points if the parent device had been set to dis-
abled—or network-wide if the driver network was set to dis-
abled. Therefore, be aware that if left at true, all associated
writable points receive a write upon either the device or net-
work when it transitions from status disabled to enabled.
Stale Time hh-mm-ss, 0ms Defines the period of time without a successful read (indicated
... +inf Defaults by a read status of {ok}) after which a point’s value is consid-
to 00–00–00 ered to be too old to be meaningful (stale).
A non-zero value causes the point to become stale (status
stale) if the configured time elapses without a successful read,
indicated by Read Status {ok}.
The default value (zero) disables the stale timer causing points
to become stale immediately when unsubscribed.
By default, the system indicates a stale proxy point status by a
tan background color. In addition, stale status is considered in-
valud for any downstream-linked control logic.

knxnetIp-KnxPollScheduler
The network Poll Scheduler maintains a group of four rate buckets to service pollables, three of which corre-
spond to configured poll rates (slow, normal and fast) and one (dibs stack) which is allocated for pollables
that transition to a subscribed state.

F ig ure 23 Poll Scheduler properties

To access these properties, expand C o n f i g → D r i v e r s in the station Nav tree, right-click the K n x N e t w o r k
node, click V i e w s → A X P r o p e r t y S h e e t , and expand P o l l S c h e d u l e r properties.

May 12, 2021 49

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Property Value Description

Poll Enabled true (default) or Enables and disables the Poll Scheduler.
false
Fast Rate hh-mm-ss, 1ms Configures the interval that defines this polling rate. The inter-
... +inf Defaults val applies to devices, which the driver can poll.
to 00–00–01
Normal Rate hh-mm-ss, 1ms Configures the interval that defines this polling rate. The inter-
... +inf Defaults val applies to devices, which the driver can poll.
to 00–00–05
Slow Rate hh-mm-ss, 1ms Configures the interval that defines this polling rate. The inter-
... +inf Defaults val applies to devices, which the driver can poll.
to 00–00–30
Statistics Start read-only date Reports either the last manual reset of poll statistics or, if sta-
time tistics have not been reset, the first steady state time immedi-
ately following the last station restart.
Average Poll read-only time Reports the average time spent during each poll event. This
does not relate to the total time required to complete a poll
cycle for any of the three rates. It is the time spent polling a
given group of objects before pausing and switching to anoth-
er group either using the same or a different poll rate.
Busy Time read-only time Displays a percentage of time spent by the poll thread actually
polling points using all poll rates. Includes (in parentheses) the
ratio of time spent polling/total time since statistics were
restarted.
Given a small amount of time is spent transitioning among poll
rates, and with the thread sleeping to evenly space out polling
messages, it is unlikely to ever see Busy Time reach exactly
100%. However, any percentage above 95% indicates that the
poll thread is basically spending all of its time actually polling.
N O T E : In the case of the Poll Service for a BACnet network
port, because two threads are used for polling, it is possible to
see a Busy Time approaching 200%. In this case, divide Busy
Time in half to get an average busy time for each thread.
Total Polls read-only Numeric Reports the total number of polls conducted and the time
over time spent waiting for polls to execute. This time is the same time
indicated in the ratio of the Busy Time property. Typically, the
total poll count indicates the number of times the PollService
polled any object. It is not a running total of the actual poll
cycles.
Dibs Polls read-only Numeric Reports the percentage and ratio of the number of DIBS polls
% (Numeric/ versus total polls.
Numeric)
Fast Polls read-only Numeric Reports the number of polls made processing the fast queue.
% (Numeric/
Numeric)
Normal Polls read-only Numeric Reports the number of polls made processing the normal
% (Numeric/ queue.
Numeric)

50 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Property Value Description

Slow Polls read-only Numeric Reports the number of polls made processing the slow queue.
% (Numeric/
Numeric)
Dibs Count read-only current= Reports the current and average number of components in the
numeric average= DIBS stack. (DIBS stands for Distributed Internet Backup
numeric System).
Fast Count read-only current= Reports the current and average number of components in the
numeric average= fast queue.
numeric
Normal Count read-only current= Reports the current and average number of components in the
numeric average= normal queue.
numeric
Slow Count read-only current= Reports the current and average number of components in the
numeric average= slow queue.
numeric
Fast Cycle Time read-only average Reports the average cycle time for the fast queue.
= time
Normal Cycle Time read-only average Reports the average cycle time for the normal queue.
= time
Slow Cycle Time read-only average Reports the average cycle time for the slow queue.
= time

knxnetIp-KnxStationDataDefs
KNX Data Defs properties are part of the KNX Import Service. K n x D a t a D e f s is a container for the specifi-
cations of the KNX Datapoint Types, which are imported from the knx_extra.xml file.
F ig ure 24 Knx Data Defs properties

To access these properties, expand C o n f i g → D r i v e r s in the station Nav tree, right-click the K n x N e t w o r k
node, click V i e w s → A X P r o p e r t y S h e e t , and expand K n x D a t a D e f s .

Property Value Description

Data Defs Status read-only Characterizes the state of the Data Defs.
Version read-only Reports the version of the Data Defs.

Stats read-only Provides additional information.

knxnetIp-KnxPointDeviceExt
All KNXnet/IP proxy extension types (K Kn x B o o l e a n P r o x y E x t , K n x N u m e r i c P r o x y E x t , K n x S t r i n g P r o x y E x t
and K n x E n u m P r o x y E x t ) share the same set of configuration properties. Any instance of any of the KNXnet/
IP proxy extension types is a proxy for one or more group address in a KNX installation.

May 12, 2021 51

Chapter 3 Components Niagara KNXnet/IP Driver Guide

The KNXnet/IP proxy extension types take on the readable-writable personality of the control point they are
attached to. For example, a K n x N u m e r i c P r o x y E x t , when used as an extension on a numeric point has read-
only functionality, but when used on as an extension on a numeric writable it can read and write attribute
values.
Fi gu re 25 Example of proxy extension properties

You access these properties by expanding C o n f i g → D r i v e r s → K n x N e t w o r k → K n x D e v i c e → P o i n t s followed

by double-clicking the point in the Nav tree or the row in the K n x P o i n t M a n a g e r view.
The KNXnet/IP proxy extension types are the point-level component in the Framework architecture. In addi-
tion to the standard properties (Status, Fault Cause, Enabled), these properties apply to the KNX Proxy
extension. Other properties, Device Facets, Conversion, Tuning Policy Name, Read Value, and
Write Value are defined in the Niagara Drivers Guide.

Type Value Description

KNX ID read-only
Displays the KNX Installation ID.

Group Addresses additional features Defines a list of group addresses from which the value of this
proxy extension can be updated.
The first group address in the list is the primary group address
and cannot be deleted, but can be edited. This proxy exten-
sion directs read and write requests to this address.
The remaining group addresses update the proxy extension
output value. This happens when the driver receives a mes-
sage from any of these addresses.
Data Value Type ID drop-down list (de- Defines the KNX data type for the address. It includes the size
faults to Unknown) of the data value and its function. For example the data item

52 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Type Value Description

may be a byte character or a one-byte percentage value. You
typically use the data type as specified by the project file when
you import the project, however, on occasion you may add
points manually and will need to select the correct data type
yourself.
Poll Enable true or false Enables and disables adding and removing the group address
(es) configured on this proxy extension to the Poll Scheduler.
In KNX, a group address responds to a read request only if it is
configured to do so. For group addresses, where there is no
bus device configured to send the value in response to a read,
it makes sense not to poll the group address. In other cases, it
may desirable not to put additional traffic on the bus if that
traffic is not absolutely necessary.
Poll Once On true or false Forces a poll when a point enters a subscribed state, such as
Subscribed when a user views it on a point list. If enabled, the resulting
poll occurs independently of any other poll setting (for in-
stance, it occurs even if Poll Enable is false and if the Poll
Scheduler rate is zero or disabled.) To modify this behaviour,
configure the Poll Until Answer Received On Poll Once
property.

Poll Once On true or false Forces a poll when the point status changes from disabled to
Operational enabled, down to up, and fault to noFault. If enabled, the re-
sulting poll is independent, and occurs independently of any
other poll setting (for instance, it occurs even if Poll Enable
is false and if the Poll Scheduler rate is zero or disabled.)
To modify this behaviour, configure the Poll Until Answer
Received On Poll Once property.

Poll Until Answer true or false Setting Poll Once On Subscribed orPoll Once On Opera-
After Poll Once tional to true, and this value to true, modifies the poll
once behaviour to poll until the driver receives a valid value in-
stead of polling once and discarding the value. This has the ef-
fect of subscribing the point to the Poll Scheduler until
such time as the point receives data addressed to the first
group address in the list provided the value is a valid value for
this point type. When these conditions are satisfied, the point
is unregistered from the poll scheduler.

Poll After Write true or false Enables and disables a poll for a value after a write. This prop-
erty is independent of the Poll Enable property.

Poll Frequency Fast, Normal, or Selects how often to poll the device. The Poll Scheduler de-
Slow fines these rates.

knxnetIp-TunnelConnection
These properties configure the tunnel connection.

May 12, 2021 53

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Fi gu re 26 Tunnel connection properties

To access these properties, expand C o n f i g → D r i v e r s → K n x N e t w o r k → K n x D e v i c e → C o m m s C o n n e c t i o n s in

the station Nav tree, right-click the T u n n e l C o n n e c t i o n node, and click V i e w s → A X P r o p e r t y S h e e t .
To configure the hidden properties you must first turn off the hidden config flag. To do so, right-click T u n n e l
C o n n e c t i o n in the Nav tree, click V i e w s → A X S l o t S h e e t , right-click the hidden property row(s) in the table,
click Config Flags, un-check the Hidden flag, and click O K .

Property Value Description

Maximum Re- number (defaults Controls the size of the Tunnel Connection’s D a t a E n d P o i n t
ceived Packets to 50) receive queue: 2, 3 ... max.
Que Size
All G ro u p A d d re s s messages pass through this queue and
end point so it is much busier than the C o n t ro l E n d P o i n t . Be-
cause it handles more traffic, its default queue size of 50 is
larger than that of the C o n t r o l E n d P o i n t .
Inter Message number (defaults Paces the out-going data requests from the driver: 15ms ...
Delay to 15ms) 5secs.
This can be used to reduce the rate of data requests in cases
where a KNXnet/IP Interface device cannot cope with the traf-
fic volume caused, possibly, by its implementation settings or
by its operating speed. The default setting of minimum 15ms
has proved successful with Siemens interface devices. Any
problems arising from this being set too small would manifest
as control points intermittently having a read fault: Timed out
waiting for L_Data_con.

Remote Control read-only Reports the IP address in the format: nnn.nnn.nnn.nnn.

Hpai, Ip Address

Remote Control read-only (defaults Reports the Port number in the format: 0, 1, ... 65535 .
Hpai, Port to –1 if no
connection)
Data End Point read-only Reports the current state of the data end point: state=
Closed or state=Open. Refer to .

54 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Property Value Description

Last Connect Error read-only Reports any error returned at the last connection in the format:
string.
Channel Id read-only (defaults Reports the channel ID from 0 ... 255.
to –1 if no
connection)
Channel Status read-only Reports the status of the channel in the format: no connec-
tion or connection.
Always Send Heart true (default) or Controls the reporting of heart beats.
Beats false
Wrong Seq Num- Send Disconnect Defines what reaction the driver should make to a Wrong Se-
ber Reaction Request (default) quence Number.
(hidden) or Just Ignore or
Send NAK E_Se-
quence_Number

Include In Trace true (default) or Controls if this information is included in the station Spy Log.
(hidden) false
Individual Address read-only Reports the individual address in the format: nn.nn.nn.

Confirmation Time- read-only Confirms when the time out occurred in the format: hh mm ss.
out (hidden)
Comms Counters Tunnel Connection Holds information on the Communications Counters. Refer to
(hidden) Comms Counters knxnetIp-EndPointCommsCounters, page 42.

Request Acknowl- true (default) or Request acknowledgements.

edgements false
(hidden)

knxnetIp-TunnelConnectionCommsCounters
These properties provide communications statistics counters for the Tunnel Connection. By default, this is a
hidden folder.

May 12, 2021 55

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Fi gu re 27 Tunnel Connection Comms Counters properties

To access these hidden properties, first change the hidden flag for C o m m s C o u n t e r s , then expand C o n -
f i g → D r i v e r s → K n x N e t w o r k → K n x D e v i c e → C o m m s C o n n e c t i o n s → T u n n e l C o n n in the station Nav tree,
right-click C o m m s C o u n t e r s the node, click V i e w s → A X P ro p e r t y S h e e t .

Property Value Description

Rx Frames Lost read-only Reports the Rx frames lost due to a full queue in the format:
Queue Full 0, 1, 2 ... max.
You can monitor the success or otherwise of received data by
inspecting this counter. Depending on the number and fre-
quency of lost frames, you can try increasing the M a x i m u m
R e c e i v e d P a c k e t s Q u e S i z e in steps of 50, until no more
frames are lost.
Rx Frames Lost No read-only Reports the Rx frames lost due to no packet worker in the for-
Packet Worker mat: 0, 1, 2 ... max.
Frames Received read-only Reports the frames received in the format: 0, 1, 2 ... max.

Frames Received read-only Reports the frames received with the wrong source IP address
Wrong Source IP in the format: 0, 1, 2 ... max.
Address
Invalid Frames read-only Reports the invalid frames received in the format: 0, 1, 2 ...
Received max.
Closed Because All read-only Reports the number of times (in the format: 0, 1, 2 ... max)
Clients the transmission closed due to all clients being unregistered.
Unregistered

56 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 3 Components

Property Value Description

Closed Because Rx read-only Reports the number of times (in the format: 0, 1, 2 ... max)
Packet Queue Size the transmission closed due to a change in the size of the Rx
Changed packet queue.

Closed Because read-only Reports the number of times (in the format: 0, 1, 2 ... max)
Connection State the transmission closed due to a time out.
Response Timeout

Closed Because read-only Reports the number of times (in the format: 0, 1, 2 ... max)
Connections Pro- the transmission closed due to the connections processor
cessor Stopping stopping.

Good Ack read-only Reports a good acknowledgment received in the format: 0,

Received 1, 2 ... max.
Rx Wrong Service read-only Reports the number of incorrect Rx service-type frames re-
Type Frames ceived in the format: 0, 1, 2 ... max.
Closed Because read-only Reports the number of closures (in the format: 0, 1, 2 ...
Ack Error Received max) due to an acknowledgment error was received.
Closed Because read-only Reports the number of closures (in the format: 0, 1, 2 ...
No Ack Received max) due to receiving no acknowledgment.
Ack Frames Sent read-only Reports the number of acknowledgment frames sent in the for-
mat: 0, 1, 2 ... max.
Request Frames read-only Reports the number of request frames sent in the format: 0,
Sent 1, 2 ... max.
Rx Frames With read-only Reports the number of Rx frames sent (in the format: 0, 1, 2
Wrong Channel Id ... max) with the wrong channel Id.
Rx Frames Correct read-only Reports the number of Rx frames sent (in the format: 0, 1, 2
Sequence Number ... max) with the correct sequence number.
Rx Frames Re- read-only Reports the number of Rx frames sent (in the format: 0, 1, 2
peated Sequence ... max) with a repeated sequence number.
Number
Rx Frames Wrong read-only Reports the number of Rx frames sent (in the format: 0, 1, 2
Sequence Number ... max) with a wrong sequence number (read-only).
Closed Because read-only Reports the number of closures (in the format: 0, 1, 2 ...
Debug Rx Wrong max) due to a debug Rx wrong sequence number.
Sequence Number
Rx Ack Frames read-only Reports the number of Rx acknowledgment frames (in the for-
(hidden) mat: 0, 1, 2 ... max) sent.
Rx Unknown Chan- read-only Reports the number (in the format: 0, 1, 2 ... max) of Rx un-
nel Sub Service known channel sub services.
(hidden)
Good Confirm Re- read-only Reports the number (in the format: 0, 1, 2 ... max) of good
ceived (hidden) confirmation messages received.

May 12, 2021 57

Chapter 3 Components Niagara KNXnet/IP Driver Guide

Property Value Description

Error Confirm Re- read-only Reports the number (in the format: 0, 1, 2 ... max) of error
ceived (hidden) confirmation messages received.

No Confirm Re- read-only Reports the number (in the format: 0, 1, 2 ... max) of no
ceived (hidden) confirmation messages received.

58 May 12, 2021

Chapter 4 Windows
Topics covered in this chapter
♦ Discover Import Device
♦ Import an ETS project file
♦ New (Edit) KNX device

Windows create and edit database records or collect information when accessing a component. You access
them by dragging a component from a palette to a Nav tree node or by clicking a button.
Windows do not support O n V i e w ( F 1 ) and G u i d e o n T a r g e t help. To learn about the information each
contains, search the help system for key words.

Discover Import Device

This window filters the source of information used to add KNX devices to the station database.
F ig ure 28 Discover Import Device properties

You open this window when you double-click on the K n x N e t w o r k node in the station Nav tree and click the
D i s c o v e r button.
Property Value Description
Search network for radio button and Selects the group (installation) of KNX devices on the network
Devices, ‘Knx In- drop-down list to search: Knx Installation (Local Interface...)
stallation to search’
Import Devices drop-down list Selects a location in memory from which to acquire device
from cache/file, Im- information..
port from cache
Import Devices File Chooser Selects a file, usually in the Supervisor PC, from which to ac-
from cache/file, Im- quire device information.
port from file

May 12, 2021 59

Chapter 4 Windows Niagara KNXnet/IP Driver Guide

Property Value Description

Name Decoration drop-down list Optionally adds to the device name in cache the date and time
the driver discovered the device.
Prepend File Date And Time adds the data at the beginning
of the record.
Append File Date And Time adds the data at the end of the
record.
Name in Cache text Defines a cache of devices discovered on previous searches.
You might use this cache if a discovery is currently not
possible.

Im p o rt an E T S p ro jec t f il e
This window defines the ETS project file that contains the data definitions.
Fi gu re 29 Import an ETS project file

You open this window after clicking T o o l s → K N X I m p o r t S e r v i c e by clicking on the I m p o r t e d F i l e s , slot fol-
lowed by clicking the I m p o r t button.

Property Value Description

File to import File Chooser Identifies the location of the ETS project file on the Supervisor
PC.
Name Decoration drop-down list (de- Optionally adds to the device name in cache the date and time
faults to None) the driver discovered the device.
Prepend File Date And Time adds the data at the beginning
of the record.
Append File Date And Time adds the data at the end of the
record.
Name in cache text Defines a cache of devices discovered on previous searches.
You might use this cache if a discovery is currently not
possible.

New (Edit) KNX device

This window manually configures device properties

60 May 12, 2021

Niagara KNXnet/IP Driver Guide Chapter 4 Windows

F ig ure 30 New KNX Device properties

You open this window when you double-click on the K n x N e t w o r k node in the station Nav tree and click the
N e w button.
Property Value Description
Name text Provides descriptive text that reflects the identity of the entity
or logical grouping.

Knx Installation drop-down list (de- Selects the multicast address group to which this device
faults to the cur- belongs.
rent interface,
including none
selected)
Ip Address nnnn.nnnn. Specifies the numerical label assigned to an object, which is
nnnn.nnnn connected to a network that uses the Internet Protocol for
communication.
Control Port –1, 1, 2, ... Identifies the port number on the controller or computer used
Number 65535 (defaults to to connect to the network.
-1)
If using fox streaming, which uses the station to render the vid-
eo stream, this port should be different from the station’s fox
port. If you are not using fox streaming, this port should be
the same as the station’s fox port.

Individual Device nnn.nnn.nnn Defines the unique number that identifies the current device
Address object on the network.
Connection drop-down list (de- Defines how this KNX device routes messages to a KNX
Method faults to router.
Tunnelling)
Mac Address read-only Specifies the data link layer MAC address of the device.

Device Friendly read-only Displays the alternate name for the KNXnet/IP interface
Name device.

May 12, 2021 61

Chapter 4 Windows Niagara KNXnet/IP Driver Guide

62 May 12, 2021

Chapter 5 Plugins (views)
Topics covered in this chapter
♦ knxnetIp-KnxDeviceManager

Plugins provide views of components and can be accessed in many ways. For example, double-click a
component in the Nav tree to see its default view. In addition, you can right-click on a component and select
from its V i e w s menu.
For summary documentation on any view, select H e l p → O n V i e w (F
F1 ) from the menu or press F 1 while the
view is open.

knxnetIp-KnxDeviceManager
This view lists the KNX devices on the network.
F ig ure 31 KNX Device Manager view

You access this D a t a b a s e view by double-clicking the C o n f i g → D r i v e r s → K n x N e t w o r k node in the Nav tree.
Columns
Column name Description

Connection Method Indicates how this device routes messages to a KNX router.

Control Port Number Reports the port number on the controller or computer used to connect to the network.

Device Friendly Name Displays the alternate name for the KNXnet/IP interface device.

Enabled Indicates if the network, device, point or component is active or inactive.

Individual Device Address Reports the unique number that identifies this device on the network.

Ip Address Reports the IP address of the device.

Knx Installation Reports the multicast address group to which this device belongs.

Mac Address Reports the data link layer MAC address of the device.

Name Reports the name of the entity or logical grouping.

Path Reports the location of the device in the station

May 12, 2021 63

Chapter 5 Plugins (views) Niagara KNXnet/IP Driver Guide

Colu mn name Description

Proxy Device If you are using proxy routing, displays the name of another KNX device that acts as the
proxy for this device.

Status Reports the current condition of the entity as of the last refresh: {alarm}, {disabled}, {down},
{fault}, {ok}, {stale}, {unackedAlarm}

Type Identifies the type of KNX device.

Buttons
• N e w F o l d e r creates a new folder for devices. Each such folder provides its own set of manager views.
• N e w creates a new device record in the database.
• E d i t opens the device’s database record for updating.
• D i s c o v e r runs a discover job to locate installed devices, which appear in the D i s c o v e re d pane. This view
has a standard appearance that is similar to all D e v i c e M a n a g e r views.
• C a n c e l ends the current discovery job.
• A d d inserts into the database a record for the discovered and selected object.
• M a t c h associates a discovered device with a record that is already in the database.
• C h e c k D a t a D e f s updates the data definitions in the station.
• T a g I t associates metadata, such as location or unique configuration with the object.
• T e m p l a t e C o n f i g accesses the station template that defines configuration options. You would select a
template to set up the device with pre-configured properties.

64 May 12, 2021

Glossary
BatiBUS This protocol was an open field bus for home appliances control and
communication. After merging with two other protocols, it is part of the KNX
standard.
BMS Building Management System
EHS The European Home Systems (EHS) protocol was aimed at home appliances
control and communication. Now, after merging with two other protocols, it is
part of the KNX standard
EIB The European Installation Bus or Instabus is a decentralised open system to
manage and control electrical devices within a facility. Now, after merging with
two other protocols, it is part of the KNX standard

ETS The Engineering Tool Software (ETS) is a PC software tool which enables the
design, engineering and configuration of installations based on KNX certified
products. The tool, which is manufacturer independent, enables a system
integrator to combine products from different manufacturers into one solution

ETS project This term describes an entity that consists of a group of KNX devices and the
links between them. It may also contain KNX catalog data. The ETS software
tool manages and maintains these projects.
KNX KNX is a worldwide Standard for control in both commercial and residential
buildings
KNX device KNX devices are KNX system components that are connected together by a
two-wire bus allowing them to exchange data. Sensors and actuators are
examples of typical KNX devices.

KNX installation A KNX installation comprises KNX devices, which are accessible through a
KNX IP device.
KNXnet/IP driver This is the Niagara KNXnet/IP driver that supports the standard KNX network
protocol.

KNXnet/IP routing This term refers to a multicast-based telegram, which allows a KNX IP router to
perform the function of a line or area coupler.

KNXnet/IP Tunnelling This term refers to the primary method of interfacing to a KNX system, which
enables point-to-point communication (unicast) from a single external device to
the KNX system. This is akin to using a USB or serial interface.
OSI The Open Systems Interconnection model (OSI model) is a conceptual model
that standardizes the communications functions of a telecommunication or
computer system without regard to their underlying internal structure and
technology. Its goal is the interoperability of diverse communication systems
with standard protocols.

May 12, 2021 65

Chapter 5 Plugins (views) Niagara KNXnet/IP Driver Guide

66 May 12, 2021

Index
A I
About this guide...................................................5 import an ETS project file....................................60
adapter Id ..........................................................23 installation..........................................................16
IP interface device ..............................................11
IP tunnelling .......................................................14
C
compatibility K
services.............................................................7
Compatibility Knx Device .........................................................38
knxnetIp Services ..............................................7 Comms Connections .......................................37
components .......................................................37 Comms Connections/Comms Counters ............38
compound structures..........................................15 Comms Connections/Tunnel Conn ...................53
connection Comms Connections/Tunnel Conn/Comms
configuring .....................................................23 Counters .......................................................55
Control End Point ...............................................41 DIBs/Device Info .............................................40
Group Data Manager.......................................43
Knx Installation ...................................................44
D KNX requirements
ETS project .......................................................8
data defs systems integrator ............................................8
about..............................................................18 KnxDeviceFolder ................................................41
examining .......................................................21 KnxDeviceManager ............................................63
load automatically ...........................................19 KNXnet/Ip driver
load manually ..................................................20 about................................................................7
updating .........................................................21 Knxnet/IP driver modules......................................9
Data End Point ...................................................41 KNXnet/IP driver modules ....................................9
data request rate ................................................12 KnxNetwork ................................................. 13, 46
device Knx Data Defs .................................................51
add manually...................................................29 local interface..................................................45
discovery ........................................................25 Poll Scheduler .................................................49
import ............................................................27 KnxPointManager ...............................................51
setup ..............................................................25
device address ...................................................11
discover import device........................................59 L
Document change log...........................................5
driver local interface .....................................................23
about................................................................7 Local Interfaces ..................................................46
driver manager ........................................ 17, 25, 29
M
E modules ...............................................................9
End Point Comms Counters ................................42 multicast ............................................................12
ETS bus connection ............................................10 devices
ETS Bus Connection............................................10 that do not support multicast .......................12
ETS different projects .........................................10 Multicast End Point.............................................41
ETS project file ...................................................27
ETS project password .........................................11
N
network .............................................................13
F adapter Id .......................................................23
add.................................................................17
FAQ ...................................................................11
configure connection.......................................23
installation ......................................................23
IP multicast address.........................................23

May 12, 2021 67

Index Niagara KNXnet/IP Driver Guide

local interface..................................................23
new KNX device .................................................60

P
platform requirements ..........................................9
plugins ...............................................................63
point manager ....................................................30
points
add.................................................................30
discover ..........................................................30
port ...................................................................13
prerequisites ........................................................9
proxy routing .....................................................11

Q
quick start ..........................................................16

R
Related documentation.........................................6
requirements........................................................8
licensing requirement ........................................9
router device ......................................................11
routing ........................................................... 8, 11

S
software version ...................................................9
specification .........................................................8
station
setting up .......................................................17

T
traffic control......................................................13
troubleshooting..................................................33
tuning policy.......................................................47
tunnel
connection ......................................................14
queue .............................................................14
tunneling............................................................14

V
version .................................................................9
views..................................................................63

W
windows.............................................................59

68 May 12, 2021