Skip to main content

A library to gather information from ETS project files used for KNX

Project description

(X)KNX Project

Pre-commit Discord codecov

Extracts KNX projects and parses the underlying XML.

This project aims to provide a library that can be used to extract and parse KNX project files and read out useful information including the group addresses, devices, their descriptions and possibly more.


Currently, xknxproject supports extracting (password protected) ETS 4, 5 and 6 projects and can obtain the following information:

  • Areas, Lines, Devices and their individual address and channels
  • CommunicationObjectInstance references for their devices (GA assignments)
  • Group Addresses and their DPT type if set
  • The application programs communication objects, their respective flags and the DPT Type
  • Location information of devices (in which rooms they are)
  • Functions assigned to rooms

Caution: Loading a middle-sized project with this tool takes about 1.5 seconds. For bigger projects this might as well be >3s.

Not all supported languages are included in project / application data. If the configured language is not found, the default language will be used - which is manufacturer / product dependent.


pip install xknxproject


"""Extract and parse a KNX project file."""
from xknxproject.models import KNXProject
from xknxproject import XKNXProj

knxproj: XKNXProj = XKNXProj(
    password="password",  # optional
    language="de-DE",  # optional
project: KNXProject = knxproj.parse()

The resulting KNXProject is a typed dictionary and can be used just like a dictionary, or can be exported as JSON. You can find an example file (exported JSON) in our test suite under

The full type definition can be found here:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xknxproject-3.6.0.tar.gz (42.2 kB view hashes)

Uploaded Source

Built Distribution

xknxproject-3.6.0-py3-none-any.whl (44.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page