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

Uploaded Source

Built Distribution

xknx-2.9.0-py3-none-any.whl (218.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-2.9.0.tar.gz
Algorithm Hash digest
SHA256 41d1a114ad1f70858063f91a90297dd4cce0b814f3c3d386ef99c294fcc4e0b9
MD5 182e6787b67a05b63049a8190628abfa
BLAKE2b-256 13d7c6d1636743067c51da463f46cd4cd48078d50745e12d8b685111abc67e79

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xknx-2.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c4dbfc9fd00c2ace4d16d124994b6233ac5c860b6092a1a3d44b9bfeea049d2
MD5 20cbf7588e50fd5f6089ea8c447f3097
BLAKE2b-256 04d6e987f94373ed3503bd8662f560bcda2d06b5936ef4ece7dfef065b2c684c

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