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

Uploaded Source

Built Distribution

xknx-0.18.0-py3-none-any.whl (140.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.0.tar.gz
  • Upload date:
  • Size: 86.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for xknx-0.18.0.tar.gz
Algorithm Hash digest
SHA256 03d7b59ff74b0bfa156876633792e32c4d3ecf36c9fb12bbef9501732ccd7b7f
MD5 bb92476be64dd9e318204f1dbcb94eb9
BLAKE2b-256 291b5fb7bafb3222a729026eb72952df4ba2aca6a18ce76411238ede01b1db8d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.0-py3-none-any.whl
  • Upload date:
  • Size: 140.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for xknx-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4abbe8e79462b901e9f158e9a1f65c8798c69afc46b61ef77d11c1230d041419
MD5 a9f36eb833d4a692145b97fe6907cba7
BLAKE2b-256 51bf2a950e9f4056e74b848be9246b12a7ca747a6117414628a7b72c37c489d3

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