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

Uploaded Source

Built Distribution

xknx-2.7.0-py3-none-any.whl (219.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-2.7.0.tar.gz
Algorithm Hash digest
SHA256 448b996f4b855ef4854191949646ad622e637a08652a1a7ebcf2ab9e5f2d5c18
MD5 2950a2e0167a8aca2c7ce640cb929347
BLAKE2b-256 b1dcde640495e3004298bdc02afbf5ccbac8b82a7564d9a17ff5be1605730538

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-2.7.0-py3-none-any.whl
  • Upload date:
  • Size: 219.1 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 34f2d5ffd4a3fb3a633bca085996d4c49e868056c575c676d40343bd75eca551
MD5 b7b2d5cdb7f80ffd741ec1a3f5d030fe
BLAKE2b-256 daf9398d725f048eca007267df2220145eb78665b579f2c9368a03e59576cef7

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