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

Uploaded Source

Built Distribution

xknx-0.17.3-py3-none-any.whl (157.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.17.3.tar.gz
  • Upload date:
  • Size: 98.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for xknx-0.17.3.tar.gz
Algorithm Hash digest
SHA256 76e8d981a6fd177d98e5346e246f1b88956cb5b52ef75db785cf13d8ed54e716
MD5 ba0034e3bfb6063750ce6487bd3240b2
BLAKE2b-256 f932cf42908854ae047bd6130f1f7b120f6a78128d1fa837be2a776ee5d911a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.17.3-py3-none-any.whl
  • Upload date:
  • Size: 157.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for xknx-0.17.3-py3-none-any.whl
Algorithm Hash digest
SHA256 044ecc9e00149ae5c934daff8bfe4d950915a36530f7a469860617ba7a454bb1
MD5 07b78a563276015465c24f80288f338b
BLAKE2b-256 a3445b2810dc8c91502b3aeb80b05aab133f0268866850b75d8a620826a146c7

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