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

Uploaded Source

Built Distribution

xknx-0.18.11-py3-none-any.whl (150.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.11.tar.gz
  • Upload date:
  • Size: 91.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for xknx-0.18.11.tar.gz
Algorithm Hash digest
SHA256 84917aa5123fb50a6c711d8906275293987f9fca00a0b66a96c741bcdfe61373
MD5 be44561a150a97adc3f06ddbaa1bd80b
BLAKE2b-256 b339ce4df9184147337fcf30f35c0a3c630e50ac8e731b38af5d8fc46af6200c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.11-py3-none-any.whl
  • Upload date:
  • Size: 150.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for xknx-0.18.11-py3-none-any.whl
Algorithm Hash digest
SHA256 106dea083086019519b5c9bfd26e0abb3e9471edd4fc5608665b895c3f2943b0
MD5 467d82d8a7a8cb380a611877ab962864
BLAKE2b-256 3b8f02a6e3560e9f71df2038fa73a0a6b9819c145bb41292537d1a392d930b6c

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