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

Uploaded Source

Built Distribution

xknx-0.18.5-py3-none-any.whl (144.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.5.tar.gz
  • Upload date:
  • Size: 88.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for xknx-0.18.5.tar.gz
Algorithm Hash digest
SHA256 7b1754bb8d6bb3ba3defcff5edd1be0ff6d0a5a9b94b0a9d29c39d572f411ca3
MD5 7db0242db27b12042bc746346f311ecb
BLAKE2b-256 77c5fd4c019ef5a4a13f58a99c9fccf3dd5506b294f7916aede1625fe0423560

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.5-py3-none-any.whl
  • Upload date:
  • Size: 144.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for xknx-0.18.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fe557991476ce77705dfedd3a84307c19bf8c8d8d95edd96749b0afac8062a99
MD5 04213158f0d4675f7ba4efccb3f7ed67
BLAKE2b-256 c382420a3ea58d45dea4bb6e36c1a5354541f2fcaae185e0d1ae72c399aa1b61

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