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

Build Status Coverage Status 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.7 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.17.2.tar.gz (98.5 kB view details)

Uploaded Source

Built Distribution

xknx-0.17.2-py3-none-any.whl (157.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.17.2.tar.gz
  • Upload date:
  • Size: 98.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for xknx-0.17.2.tar.gz
Algorithm Hash digest
SHA256 63647d2718eaeef5cd4fe8cb672ebe5fcb3dc82e74e982a12bc2540781b728e0
MD5 384bb586faf22b5e61ae3a08d1ac7519
BLAKE2b-256 0a2ee4b63454d2b3de7cc9ec43ff0ccf96554835927ee6bbe88026a42d86c7c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.17.2-py3-none-any.whl
  • Upload date:
  • Size: 157.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for xknx-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6ef5ed2595964648a78cc21e1a469eef18def705b72efecba3926db76f6e4bad
MD5 d392c10db4877b3e6273a506f063ab70
BLAKE2b-256 1eb21aa95d0c45b028e5f9f4560d90b8d829c2f827792741a9d128aff8ba6d57

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