1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
---
layout: default
title: Asynchronous Python Library for KNX
nav_exclude: true
---
# [](#header-1)Asynchronous Python Library for KNX
XKNX is an Asynchronous Python library for reading and writing [KNX](<https://en.wikipedia.org/wiki/KNX_(standard)>)/IP packets.
[](https://coveralls.io/github/XKNX/xknx?branch=main)
## [](#header-2)Overview
XKNX...
- ... does [cooperative multitasking via asyncio](https://github.com/XKNX/xknx/blob/main/examples/example_light_state.py) and is 100% thread safe.
- ... provides support for KNX/IP [routing](https://github.com/XKNX/xknx/blob/main/xknx/io/routing.py) _and_ [tunneling](https://github.com/XKNX/xknx/blob/main/xknx/io/tunnel.py) devices.
- ... supports KNX IP Secure - via tunneling or routing.
- ... supports KNX Data Secure group communication.
- ... has strong coverage with [unit tests](https://github.com/XKNX/xknx/tree/main/test).
- ... automatically updates and synchronizes all devices in the background periodically.
- ... listens for all updates of all devices on the KNX bus and updates the corresponding internal objects.
- ... has a clear abstraction of data/network/logic-layer.
- ... does clean [connect](https://github.com/XKNX/xknx/blob/main/xknx/io/connect.py) and [disconnect](https://github.com/XKNX/xknx/blob/main/xknx/io/disconnect.py) requests to the tunneling device and reconnects if KNX/IP connection failed.
- ... ships with [Home Assistant](https://home-assistant.io/).
## [](#header-2)Installation
XKNX depends on Python >= 3.10
You can install XKNX as Python package via pip:
```bash
pip install xknx
```
## [](#header-2)Hello World
```python
import asyncio
from xknx import XKNX
from xknx.tools import group_value_write
async def main():
async with XKNX() as xknx:
# send a binary Telegram
group_value_write(xknx, "1/2/3", True)
# send a generic 1-byte Telegram
group_value_write(xknx, "1/2/4", [0x80])
# send a Telegram with an encoded value
group_value_write(xknx, "1/2/4", 50, value_type="percent")
asyncio.run(main())
```
For more examples please check out the [examples page](https://github.com/XKNX/xknx/tree/main/examples)
# [](#header-1)Getting Help
For questions, feature requests, bugreports either join the [XKNX chat on Discord](https://discord.gg/EuAQDXU), open an issue at [GitHub](https://github.com/XKNX/xknx) or write an [email](mailto:xknx@xknx.io).
# [](#header-1)Attributions
Many thanks to [MDT technologies GmbH](https://www.mdt.de) and [Weinzierl Engineering GmbH](https://weinzierl.de) for providing us each an IP Secure Router to support testing and development of xknx.
|
