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

codecov Checked with mypy Pre-commit

Documentation

See documentation at: https://xknx.io/

Help

We need your help for testing and improving XKNX. For questions, feature requests, bug reports either join the XKNX chat on Discord or write an email.

Development

You will need at least Python 3.8 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.18.6.tar.gz (88.8 kB view details)

Uploaded Source

Built Distribution

xknx-0.18.6-py3-none-any.whl (145.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.6.tar.gz
  • Upload date:
  • Size: 88.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for xknx-0.18.6.tar.gz
Algorithm Hash digest
SHA256 2c811cb82c3bd303c3f97ee8ae4c93a995963f1803ade793b54565679f44ef4a
MD5 28d8923221e3aa9daa089cf14361a620
BLAKE2b-256 e90eab24cf99720c8604ce1cc013c2348347b8540497b461a7780982ba4a91ac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.6-py3-none-any.whl
  • Upload date:
  • Size: 145.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for xknx-0.18.6-py3-none-any.whl
Algorithm Hash digest
SHA256 15746487be2a75cf10ba46fd0cc984d54fc5674a6064d60c21131abacdf70a2a
MD5 0443358c6fc7c5ad5103e1ce88141888
BLAKE2b-256 9842f1a6d33bc94e694f661e4044f289cd52f0f047f8881373c756f39e487bd1

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