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

Uploaded Source

Built Distribution

xknx-0.18.13-py3-none-any.whl (151.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.13.tar.gz
  • Upload date:
  • Size: 91.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for xknx-0.18.13.tar.gz
Algorithm Hash digest
SHA256 b476a5e7ec2b5b4072a32140a7b42c53549ceb3ef9b50dee71773386a6b453df
MD5 e342369e36e900315f28e9a52c87af6c
BLAKE2b-256 977c8835d8a004c049ef8181270f4726088a9db63f8d06a74a5419e5bc2b147f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.13-py3-none-any.whl
  • Upload date:
  • Size: 151.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for xknx-0.18.13-py3-none-any.whl
Algorithm Hash digest
SHA256 b24b0edccc6f81bb2fd5b565c25b6a736ba7323e77479c7fa2b3f85bf13529dd
MD5 079ea6b5580606ef584859d8267705a2
BLAKE2b-256 9c611af99a71f89736a2b93d85eba61cceb5bf801f93c568c47baabbe7d626f7

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