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

Uploaded Source

Built Distribution

xknx-1.2.0-py3-none-any.whl (198.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-1.2.0.tar.gz
Algorithm Hash digest
SHA256 67bb6671d1447cf7389e79a6758df6bac9d38faff6a0953bec5d3cb4be391d80
MD5 91c9f90fa1bf8974cf41a2a578b16de1
BLAKE2b-256 d4ad0ada3ba2938f88d072bf67f510ec62780d78f60062b18192aa4d412f6347

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 198.9 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a04dbb0e4f7c2ffd67a35c0b24d6c8462eeff503a65a3e66b59a0e741e4154e1
MD5 4a700b5e2fd689a06eacdc94e572dad1
BLAKE2b-256 36371b2cdb4352a4f3e77effe8a19d1a5dc70b28569c143278a56ca45a25828f

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