KNX IoT Point API stack configuration

Each KNX IoT device must be configured to make it working as a part of the KNX network.

For demo purposes, Nordic Semiconductor provides the dedicated KNX IoT CLI that should be used to configure KNX IoT devices. In the future, KNX IoT devices will be configured using the ETS tool.

KNX IoT CLI commands

The following table presents available CLI commands:

Command

Description

knx dev sn

Read device serial number

knx dev hwv

Read device hardware version

knx dev hwt

Read device hardware type

knx dev model

Read device mode

knx dev sa

Read/write device subnet address

knx dev da

Read/write device address

knx dev hname

Read/write device hostname

knx dev fid

Read/write device fabric identifier

knx dev iid

Read/write device installation identifier

knx dev ia

Read/write device individual address

knx dev port

Read/write device port

knx got

Print/configure Group Object Table

Group Object Table configuration

Group Object Table is used to control interconnections (data sharing) between KNX Datapoint types. Every entry in the Group Object Table consists of the following properties:

Property

Description

Identifier

Unique identifier of the entry, used for fetching and altering entry’s content.

Path

Datapoint’s path, for example, /p/rts/roomtemp.

Group addresses

Addresses of groups the resource is a part of.

Configuration flags

Bitmap used for controlling the communication. Read more about flags.

Configuration flags

For CLI purposes, Configuration flags are represented by assigned bits as inditacted in the following table:

Configuration flag

Bit no.

C: the Communication flag

2nd

R: the Read flag

3rd

T: the Transmit flag

4th

W: the Write flag

5th

U: the Update flag

6th

I: the Initialization flag

7th

Printing Group Object Table entries

In order to read the Group Object Table content, use the knx got print command.

uart:~$ knx got print
[ 0]: 124 /p/ls/room 252 [1]
[ 1]: 256 /p/ls/kitchen 252 [2,3]
[ 2]: 512 /p/ls/garage 252 [4,5,6]

The knx got print command output prints three entries in the Group Object Table. The following table contains description of these entries:

Entry

Identifier

Path

Flags

Group addresses

0

124

/p/ls/room

252 - all flags set

Property is a member of a group with address equal 1.

1

256

/p/ls/kitchen

252 - all flags set

Property is a member of a group with address equal 2 and 3, respectively.

2

512

/p/ls/garage

252 - all flags set

Property is a member of a group with address equal 4, 5 and 6, respectively.

Note

Identifiers are used to distinct entries within a device’s table. They are not used for the communication purposes.

Group addresses meaning

When a property is a member group with a given address, it can send and receive messages within this group. Multiple groups can be assigned to a single group. It lets an actuator react to events from multiple sources and sensors to publish events to multiple groups. When a group is configured, a device joins the corresponding multicast group with an IPv6 address based on the group’s address.

Sample Group Object Table configuration

The following tables show sample sets of configuration for the Light Switch Actuator and Light Switch Sensor.

Light Switch Actuator with a single input

The following entry sample allows the Light Switch Actuator to receive notifications from a group with address equal to 1 for a property with the /p/light/room path.

Entry

Identifier

Path

Flags

Group addresses

0

1

/p/light/room

0x7C

1

Light Switch Sensor with a single output

The following entry sample allows the Light Switch Sensor to send notifications to a group with an address equal to 24 for a property with the /p/light/livingroom path.

Entry

Identifier

Path

Flags

Group addresses

0

2

/p/light/livingroom

0x7C

24

Light Switch Actuator with multiple inputs

The following entry sample allows the Light Switch Actuator to receive notifications from groups with addresses equal to 16 and 17 for a property with the /p/light/basement path.

Entry

Identifier

Path

Flags

Group addresses

0

4

/p/light/basement

0x7C

16 and 17

Light Switch Sensor with multiple outputs

The following entry sample allows the Light Switch Sensor to send notifications to groups with addresses equal to 32 and 64 for a property with the /p/light/kitchen path.

Entry

Identifier

Path

Flags

Group addresses

0

8

/p/light/kitchen

0x7C

32 and 64

Altering Group Object Table entry

In order to add, change, or remove an entry, the following commands can be used:

Action

Commands with available parameters

Adding a new entry

knx got add <id> <path> [<ga>] <flags>

Changing an entry

knx got edit <id> <path> [<ga>] <flags>

Removing an entry

knx got remove <id>

The parameters are described in the following table:

Parameter

Description

Data type

<id>

Identifier

Integer

<path>

Entry paths

String

<ga>

Comma-separated list of Group Addresses

Comma-separated integer list

<flags>

Configuration flags described above

Integer

See the following samples of the commands:

uart:~$ knx got add 11 /p/light/gamingroom 252 [1]
uart:~$ knx got edit 11 /p/light/gamingroom 252 [1,2,3]
uart:~$ knx got remove 11