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

XKNX is the underlying library for the KNX integration in Home Assistant.

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

Uploaded Source

Built Distribution

xknx-0.22.1-py3-none-any.whl (190.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.22.1.tar.gz
  • Upload date:
  • Size: 120.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for xknx-0.22.1.tar.gz
Algorithm Hash digest
SHA256 82521701d1811e62bb6c0176dd98d9133be0d6aaeeb703963df2f6cfac6b0417
MD5 5f42cf86f4b0213ab0c3019a74fe27bb
BLAKE2b-256 16f26d5f41a546df79965caeacb1f17db67e9e0cbe2cad25c76073d49d9139b4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.22.1-py3-none-any.whl
  • Upload date:
  • Size: 190.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for xknx-0.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 71e1ed1ed8929dd54edf69096858b19cad62046f7f1596fda6fd7d96de0cc0c1
MD5 c838ec9b6a975db26a51b52a3c63de25
BLAKE2b-256 815bba83c860c5086eb24c1cd6ef5242e7b27651100213d9ed8cf1c37abe2af3

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