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

Uploaded Source

Built Distribution

xknx-2.11.0-py3-none-any.whl (220.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-2.11.0.tar.gz
  • Upload date:
  • Size: 144.8 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.0.tar.gz
Algorithm Hash digest
SHA256 b0225a96d766d3dd5022021ba0fc9f120a2af38b065840f79554fecc48ecd192
MD5 9b710e6698acac9f82e92488b0c2604b
BLAKE2b-256 59c87defa53a49734433415d41059f1f518662beb69dbf0650d1dc02c56db8bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-2.11.0-py3-none-any.whl
  • Upload date:
  • Size: 220.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8ee54a7a58107910cbe9e368e28d8d4592637486b85cfb4eebb1a988a07a522
MD5 5ca78d6a6d1672f095847372c6ea2da1
BLAKE2b-256 ff9001a5a1f3964ab0e21a0892a08667fd11e2e48b5a029bd3af8db8a69f7337

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