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

Uploaded Source

Built Distribution

xknx-2.8.0-py3-none-any.whl (218.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-2.8.0.tar.gz
Algorithm Hash digest
SHA256 6afdfe4e9eaa0a3d2b5068b10996b4056568f6d6a858eb253f25623da9398533
MD5 62980e78b9e566129daabad574a1f6b2
BLAKE2b-256 2c204a1dd050eb0440be4315e22cb2a18c282db281bc23a91172838252006d87

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-2.8.0-py3-none-any.whl
  • Upload date:
  • Size: 218.4 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c4c19ecf2035b7c512e6ad74a95d44b247bd850831a8708a31252523d48d3930
MD5 bb8462e6c0a911f1e505e5dca2c05266
BLAKE2b-256 e7861920862dd4ee2a1e6c33847c8650fd3ecafbc1bf1b60ef340041af966c20

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