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

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.

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

Uploaded Source

Built Distribution

xknx-2.6.0-py3-none-any.whl (210.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-2.6.0.tar.gz
  • Upload date:
  • Size: 136.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for xknx-2.6.0.tar.gz
Algorithm Hash digest
SHA256 c3f3da37bc99bd0d8d8b7318a77cd08de471613b0367806d8697bb6f994b3340
MD5 5f147510608bca11e6e6b81fcc4e15df
BLAKE2b-256 8ffe70649c7fe2b79061e682a8b3a8751712611a2b28471ff55a1dffa515b176

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-2.6.0-py3-none-any.whl
  • Upload date:
  • Size: 210.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for xknx-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7d500795111bce392440cb4c0e7c95ac3b895377fab8c39459564d2769d6ece6
MD5 8dc67129c8e99b4a68e65b5125104f56
BLAKE2b-256 6a36973b7d32e8c0add459542d849fa97585cc319285db9fbeedafe5fe47273a

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