Command line tools

Reference for knxproj, knxprobe, knxdownload, knxprogram and knxcap.

Five tools live under cmd/ in the repository and share their code with the application. Build them with go build -o bin/ ./cmd/... (see Build). All of them use Go’s flag package, so -h prints the flags and a flag can be written -name value or -name=value.

Tool	Purpose	Touches the bus?	Changes a device?
`knxproj`	Inspect a `.knxproj` file	No	No
`knxprobe`	Discover gateways, listen, and run read-only diagnostics	Listens. Some options send read requests	No
`knxdownload`	Build the memory image a device should hold and compare it with the device	Only with `-verify`, read-only	No, never
`knxprogram`	Load a project device into a real device	Yes	Only with `-write`
`knxcap`	Decode KNXnet/IP tunnelling captures (tshark output)	No	No

Conventions

Project passwords are never taken on the command line. Use -pwfile FILE (the file holds the password, line breaks at the end are removed). knxproj also reads the environment variable KNXPROJ_PASSWORD when -pwfile is not given. A project without a password needs neither.
Addresses. Individual addresses are written area.line.device (1.1.21). Group addresses are written main/middle/sub (3/0/10); the tools that send a group read also accept the two-level form main/sub.
Gateways. -addr (knxprobe), -gateway (knxprogram) and -verify (knxdownload) take a host:port address. -tcp selects tunnelling over TCP instead of UDP.
No default gateway. knxprobe and knxprogram refuse to start without -addr or -gateway, except for knxprobe -discover (multicast) and -usb-list.
Exit status. 0 on success, 1 for an error, 2 for a usage error.

knxproj

Inspect an ETS 6 project file from the command line.

knxprobe

Discover gateways, listen to the bus, and run read-only diagnostics from the command line.

knxdownload

Build the memory image a device should hold for a project and compare it with the device. Read-only.

knxprogram

Load a project device into a real KNX device. Reads only unless -write is given.

knxcap

Decode KNXnet/IP tunnelling captures made with tshark.