Skip to main content

An Asynchronous Library for the KNX protocol. Documentation: https://xknx.io/

Project description

XKNX - An asynchronous KNX library written in Python

PyPI - Python Version codecov Checked with mypy Pre-commit HA integration usage Discord

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:

  1. Install requirements: pip install -r requirements/testing.txt
  2. Install pre-commit hook: pre-commit install

Home-Assistant Plugin

XKNX contains a plugin for the Home Assistant automation platform

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())

Project details


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.

Source Distribution

xknx-0.21.1.tar.gz (115.2 kB view details)

Uploaded Source

Built Distribution

xknx-0.21.1-py3-none-any.whl (183.7 kB view details)

Uploaded Python 3

File details

Details for the file xknx-0.21.1.tar.gz.

File metadata

  • Download URL: xknx-0.21.1.tar.gz
  • Upload date:
  • Size: 115.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for xknx-0.21.1.tar.gz
Algorithm Hash digest
SHA256 198fec59683c8cbb0a88ee8bb0a5614f4e8b019b67b57c77a40d88dad78e61a4
MD5 d12140c5ec395fecb6b6398444f9f0a7
BLAKE2b-256 71f50e3da75ad798c3a09ff23e7fbb0e7a0dcca2e72c078a425735e2d7088e91

See more details on using hashes here.

File details

Details for the file xknx-0.21.1-py3-none-any.whl.

File metadata

  • Download URL: xknx-0.21.1-py3-none-any.whl
  • Upload date:
  • Size: 183.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for xknx-0.21.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e4577fd642bb310282b0370a729bc7be0be04071bfcdfa0d9b0e7cbc3939df4
MD5 b3ff1da68995f2fd38a3ea3519c1b3e9
BLAKE2b-256 d79a23e01ad2054f00eca36f5e19db3e8eac1e8ee288dfb73544a6c95c082d82

See more details on using hashes here.

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