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

codecov Checked with mypy Pre-commit

Documentation

See documentation at: https://xknx.io/

Help

We need your help for testing and improving XKNX. For questions, feature requests, bug reports either join the XKNX chat on Discord or write an email.

Development

You will need at least Python 3.8 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.18.10.tar.gz (90.2 kB view details)

Uploaded Source

Built Distribution

xknx-0.18.10-py3-none-any.whl (149.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.10.tar.gz
  • Upload date:
  • Size: 90.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for xknx-0.18.10.tar.gz
Algorithm Hash digest
SHA256 7237bbf290b12f15ac403ee01df2628c278b5a00775c6189283a3a6154201d67
MD5 794a23c1fc5eb8e2adaa792b3408a324
BLAKE2b-256 d131c7970c50bb3ff6353f393d01c5e3fdb89e9b9b1245692d9177202aefdc69

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.10-py3-none-any.whl
  • Upload date:
  • Size: 149.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for xknx-0.18.10-py3-none-any.whl
Algorithm Hash digest
SHA256 45b56a7bae06dbb213fc72d754a9ee7145c6476e04ff14ba542a00408f4a7b1f
MD5 b1aba9c0f5ca4c5f9609d1da4a1530b0
BLAKE2b-256 50d8715df4a204e4440c5809ab4d8710418d131f52e5bdc1bc4f4f10392662dd

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