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 Plugin

XKNX contains a plugin for the Home Assistant automation platform

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())

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

Uploaded Source

Built Distribution

xknx-0.20.2-py3-none-any.whl (184.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.20.2.tar.gz
  • Upload date:
  • Size: 114.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for xknx-0.20.2.tar.gz
Algorithm Hash digest
SHA256 6fa9216e78bd654c9d7ef7a1fe7ef1b9a7245e6a604bc46ae982284da5f3c3f5
MD5 5c9b66ca9ea25be064e8268050840840
BLAKE2b-256 3a539db20c2d6b8d4a4412e71655d91a1441b16f007d5cb34866175e6f50aaf4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.20.2-py3-none-any.whl
  • Upload date:
  • Size: 184.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for xknx-0.20.2-py3-none-any.whl
Algorithm Hash digest
SHA256 495f31b25f3ff66a67fd070f6c00168524b2be08e01f83954946605b6ee9d340
MD5 571b4d3bfd6790d5f35f64b7a396665b
BLAKE2b-256 2f57d30f71fdee0548d9405b6f397c2869b08717f0b21370a434be5a34e2be9f

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