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

Uploaded Source

Built Distribution

xknx-0.20.1-py3-none-any.whl (184.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-0.20.1.tar.gz
Algorithm Hash digest
SHA256 7dab9f23d40143125640b9b82ccd74c8c584112b62caeffa5a8f336aa709fd4b
MD5 94f85967a455c6c12545fcd7f8c9d952
BLAKE2b-256 5dbdb05a2045fc85e9034576ec0b6b5fb485f205e63f2a011378745826f80787

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.20.1-py3-none-any.whl
  • Upload date:
  • Size: 184.3 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.20.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04f071eb562d8f35213000e45a7ead6adfb314ce7a951c4323bfb42de28feef5
MD5 9a45f837b03747dc36910b1cf33a71a8
BLAKE2b-256 5c16977dad9095cc97d493abd67b53b91c3ee874c148aa766299350a361404d8

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