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

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

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.4.tar.gz (117.6 kB view details)

Uploaded Source

Built Distribution

xknx-0.21.4-py3-none-any.whl (186.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-0.21.4.tar.gz
Algorithm Hash digest
SHA256 87bfb67d72120cbf96eebcd7334450b129a9f885506b7ae8b32d64218b1d69a9
MD5 ad67d14d29059fd92c7e9baed19cd4aa
BLAKE2b-256 ef1fbfc8c22bb4bfebc78117353086437ceedaea75007af095f57ca62e80c05c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xknx-0.21.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1fafefef432f5de41efbd646061be9dcb6b9df36b5721bc10f1c7e8fb0620f36
MD5 d7654071fc303f0841488a486e9c1b21
BLAKE2b-256 12b2659b9c1cd68df45fbb873cbee2931f8a8d43acdbae435a6eafa2cd0953d6

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