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

Uploaded Source

Built Distribution

xknx-0.21.5-py3-none-any.whl (186.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-0.21.5.tar.gz
Algorithm Hash digest
SHA256 13d9651510094ed4ce24029b2325118540d7d2955633eb8f7ae3f72d3ca2b75b
MD5 6fd45c937eed2334210282ca3e753507
BLAKE2b-256 9173e1962c0647e3ced4de9c4c926f45c88ed07c5958a62643500d09eeb01a68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.21.5-py3-none-any.whl
  • Upload date:
  • Size: 186.7 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.21.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0865bd25cf9ad7346b9928297d0db2e9f38b5e3a18a119b9c3e5827cc95d79a1
MD5 c139ca50e6a8fb00a217c0d3f1851457
BLAKE2b-256 f8bfe3fc9ce8599d69566bb3d15f8de393d556ba343ea2b8caf038f7fefa7dd3

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