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

Uploaded Source

Built Distribution

xknx-0.22.0-py3-none-any.whl (190.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.22.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9ce1ab65288454e3fcea9a90fabfd2f0f705d5cbb187569b7f98722e0892ae35
MD5 a52314b3fc26029161ac2b23ac915ae3
BLAKE2b-256 319ff20223f945b03bf52bacae8d93aec3c6aab772d1adf83c3183b9dbdb9760

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.22.0-py3-none-any.whl
  • Upload date:
  • Size: 190.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0b85bac58382e5fef529a88e012ca317215e8ec5afcfeb2ead2ddd4a72d2b68
MD5 40d0a574d08b8e143fc08578aa9bbe2f
BLAKE2b-256 9d58d4118fc35d669337f9e761c7b54301a1815fa182c1a82ff86d17fd3d6680

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