knxproj

Inspect an ETS 6 project file from the command line.

knxproj reads a .knxproj file and prints information about it. It never touches the bus and never changes the file.

knxproj [-pwfile FILE] [-list] [-extract NAME -out FILE] project.knxproj
knxproj [-pwfile FILE] -device 1.1.21 [-params] project.knxproj
knxproj [-pwfile FILE] -ga 3/0/10 project.knxproj

Flags

FlagMeaning
-pwfile FILEFile holding the project password. Without it the environment variable KNXPROJ_PASSWORD is used.
-listList the entries of the outer and inner archive, with their sizes.
-device ADDRPrint this device (for example 1.1.21): product, manufacturer, place, comment, description, and its group objects with flags, data type and linked group addresses.
-paramsWith -device: also print the parameter pages with their values.
-ga ADDRPrint this group address (for example 3/0/10) with its name, data type, range, and the devices and objects linked to it.
-extract NAMEWrite this inner entry to the file given by -out.
-out FILEOutput file for -extract. Written with mode 0600.

With none of -list, -extract, -device or -ga, it prints the project name and whether it is password protected.

Examples

printf '%s\n' 'my password' > pw.txt && chmod 600 pw.txt

knxproj -pwfile pw.txt -list house.knxproj
knxproj -pwfile pw.txt -device 1.1.21 -params house.knxproj
knxproj -pwfile pw.txt -ga 3/0/10 house.knxproj

Or with the environment variable, which keeps the password out of any file:

KNXPROJ_PASSWORD='my password' knxproj -device 1.1.21 house.knxproj