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

Uploaded Source

Built Distribution

xknx-0.18.15-py3-none-any.whl (152.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.15.tar.gz
  • Upload date:
  • Size: 92.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for xknx-0.18.15.tar.gz
Algorithm Hash digest
SHA256 243557f9b8dcf184319b9692d7f6ac7eec6db67f4a3d3596fb4ed0cfacd512e2
MD5 e5e527fae75fe0e9a141b7faa645632e
BLAKE2b-256 2224fa9a196316785da605aea2626809e930ec0d132eac13f13d91d8555fc586

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.15-py3-none-any.whl
  • Upload date:
  • Size: 152.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for xknx-0.18.15-py3-none-any.whl
Algorithm Hash digest
SHA256 80bb310c3246fa1a566460044e1f54f0df13fb7e1493edf86bf2373a083ee4d5
MD5 6462089e011111aa38f5ca3240343493
BLAKE2b-256 c0dea0dd177d16eec4e2c26959518414426a92ec190c9c7d4b1786278c1c0ac5

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