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

Uploaded Source

Built Distribution

xknx-0.20.0-py3-none-any.whl (179.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.20.0.tar.gz
  • Upload date:
  • Size: 110.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for xknx-0.20.0.tar.gz
Algorithm Hash digest
SHA256 265bb34db00267ed2d05867f83e4115ef4b01e3d240ffae31587a39bb6323eab
MD5 f770d5797552e56f40796300112b1824
BLAKE2b-256 bc4db06443b502c9c1b94aa82246c3564fd9e0bcdfe88ee5cf6357a8ed8bd99e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.20.0-py3-none-any.whl
  • Upload date:
  • Size: 179.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for xknx-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e12dfe0bffaaf75d5a163d9129053b9114afa868a805d52205853341bafd8ad
MD5 de5d120b3ae1e34f83539b4398bbc41a
BLAKE2b-256 33fb940d905d02b69a089b26a7786a4aedae31a83ab167015061a44e73d94a5c

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