XKNX - An asynchronous KNX library written in Python
Documentation
See documentation at: https://xknx.io/
Help
We need your help for testing and improving XKNX. For questions, feature requests, bug reports either open an issue, join the XKNX chat on Discord or write an email.
Development
You will need at least Python 3.11 in order to use XKNX.
Setting up your local environment:
- Install uv
- Create the environment:
uv sync - Install the git hooks:
uv run prek install
Dependencies are declared in pyproject.toml and pinned in uv.lock.
Testing
To run all linters, formatters and the type checker call uv run prek run --all-files
Unit tests are run with uv run pytest
Running specific unit tests can be invoked by: uv run pytest -vv test/management_tests/procedures_test.py -k test_nm_individual_address_serial_number_write_fail
Testing against another supported Python version: uv run --python 3.11 pytest
Home-Assistant
XKNX is the underlying library for the KNX integration in Home Assistant.
Example
"""Example for switching a light on and off."""
import asyncio
from xknx import XKNX
from xknx.devices import Light
async def main():
"""Connect to KNX/IP bus, switch on light, wait 2 seconds and switch it off again."""
async with XKNX() as xknx:
light = Light(
xknx,
name="TestLight",
group_address_switch="1/0/9",
)
xknx.devices.async_add(light)
await light.set_on()
await asyncio.sleep(2)
await light.set_off()
asyncio.run(main())
Attributions
Many thanks to Enertex Bayern GmbH, Weinzierl Engineering GmbH and MDT technologies GmbH for providing us a device to support testing and development of xknx.
3 maintainers
Metadata
3 maintainers
Release files for xknx 4.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xknx-4.0.0.tar.gz | 223.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xknx-4.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 558.3 kB
Release files / xknx-4.0.0.tar.gz
| Download URL | xknx-4.0.0.tar.gz |
|---|---|
| Size | 223.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
84f00ce2ced47cd010b382ff729909475734275890b2c7318a7a05a8e3cd3e99
|
|
BLAKE2b-256 checksum How to use checksums |
51bbb698ed9ad7b6b1882cbe6d7142d42ed83d3ebf50d95f16232156747078c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / xknx-4.0.0-py3-none-any.whl
| Download URL | xknx-4.0.0-py3-none-any.whl |
|---|---|
| Size | 334.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
72042588ad99afbaf564bc2d7748eb19524ffe255adf9a2fe9d89bda127a4c8b
|
|
BLAKE2b-256 checksum How to use checksums |
43671ef323896a706d20381fa8ae0fdb72168316af6ed3f2cb7e6ff0e54a0c7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency log
