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

PyPI - Python Version codecov Checked with mypy Pre-commit HA integration usage Discord

Documentation

See documentation at: https://xknx.io/

Help

We need your help for testing and improving XKNX. For questions, feature requests, bug reports either open an issue, join the XKNX chat on Discord or write an email.

Development

You will need at least Python 3.9 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.21.0.tar.gz (115.2 kB view details)

Uploaded Source

Built Distribution

xknx-0.21.0-py3-none-any.whl (183.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.21.0.tar.gz
  • Upload date:
  • Size: 115.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for xknx-0.21.0.tar.gz
Algorithm Hash digest
SHA256 bbc7a417668e0224c9a19d686db611e6fb94a1be2dcff916a67c03ec5c1ed7a0
MD5 3c84647ed9403217ff4ae3d5395e301d
BLAKE2b-256 432420744d5e1c5faafafdbdde157c29f663a95a2c25009bd1906ddf98cb9444

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.21.0-py3-none-any.whl
  • Upload date:
  • Size: 183.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for xknx-0.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64544e69f6851e34f140fc23132be8cf953dd0c9c09149b8d8bf0f610db8052f
MD5 0d692d0a30780da3d0298a757edf4477
BLAKE2b-256 bc1a47e24b220b44800d5f5f33ff923e928048520080593a1a35df2c8809e22b

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