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

Uploaded Source

Built Distribution

xknx-0.19.1-py3-none-any.whl (158.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.19.1.tar.gz
  • Upload date:
  • Size: 96.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for xknx-0.19.1.tar.gz
Algorithm Hash digest
SHA256 fb7eb3ff610dcb1d7b9c106dac0550e3571c85ffc58f8800457dc0e944e147a2
MD5 5352056612efefc7cdf3fbd22d4218f3
BLAKE2b-256 c903e351cc6660e3be04f241683a46cbbadd316d696ef2d525d1835dee5f5469

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.19.1-py3-none-any.whl
  • Upload date:
  • Size: 158.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for xknx-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80ea421400a2bcd6655bd6a532457f135bdaa22ffd78d923733504fbe80c19c7
MD5 9275b12f185a0dd0403c88d9a37d3081
BLAKE2b-256 dde2cba2e7900a6103131a1e8bbb2abbbe3b67f9c86b153ff69590013278bfd3

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