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

Uploaded Source

Built Distribution

xknx-1.1.0-py3-none-any.whl (195.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e56d7730a38da344fe8c7728a9c3e83962ba090d2810e10d0d4d83b757693634
MD5 9adac394af20435a76e7f44e03c6108c
BLAKE2b-256 9db88b8ab8a86b833f836ee58363f4f0968fb9bb85200fffa5616f05ec3875b1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xknx-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d47eed8006f7016bb1e0d6b6b3e14de226d631d8f5f1a975f83f75988d47d9e
MD5 c12dbfc9bd2639e719dc3a9a49b4caea
BLAKE2b-256 1071a04364dba9c180ea30fb6fd3bfab7fbc6fd6f8207d695ec5cfc02691b5dc

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