An Asynchronous Library for the KNX protocol. Documentation: https://xknx.io/
Project description
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.9 in order to use XKNX.
Setting up your local environment:
- Install requirements:
pip install -r requirements/testing.txt - Install pre-commit hook:
pre-commit install
Testing
To run all tests, linters, formatters and type checker call tox
Running only unit tests is possible with pytest
Running specific unit tests can be invoked by: pytest -vv test/management_tests/procedures_test.py -k test_nm_individual_address_serial_number_write_fail
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')
await light.set_on()
await asyncio.sleep(2)
await light.set_off()
asyncio.run(main())
Attributions
Many thanks to Weinzierl Engineering GmbH and MDT technologies GmbH for providing us each an IP Secure Router to support testing and development of xknx.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
