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

Uploaded Source

Built Distribution

xknx-2.11.2-py3-none-any.whl (220.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-2.11.2.tar.gz
Algorithm Hash digest
SHA256 75fb656d6d0cda879193882f51c70d78cff0e50f3333cadaacbafc9c3957a280
MD5 c2930e7f9e4ef528efa07f36fd89134f
BLAKE2b-256 67937ab8e4810ef038e16dcfef489166a3f6d73df6a136dbe001fd79743ecfb8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xknx-2.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6b9ea24c0ea540734dd596330839ebf2cc964114a6e44532d04a5e5ede6760bc
MD5 55048791734825ff7ee92063c7cd3e5a
BLAKE2b-256 bdb383e7025bc3a70a68be4d35c47f9cb39404164965e116c38d477b95e6f188

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