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

Build Status Coverage Status 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.7 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.17.1.tar.gz (98.3 kB view details)

Uploaded Source

Built Distribution

xknx-0.17.1-py3-none-any.whl (157.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.17.1.tar.gz
  • Upload date:
  • Size: 98.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.1

File hashes

Hashes for xknx-0.17.1.tar.gz
Algorithm Hash digest
SHA256 675ff8286ff22bb411461a2cd37dca4155fa6645d4866628c9df83abdd2a8752
MD5 7d12ed399d48d7d6c3760ef6d8fa62c6
BLAKE2b-256 dc638ddef0eaef9ef01807e4515211091f27668fe8f5b80cabf9ec632908acf9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.17.1-py3-none-any.whl
  • Upload date:
  • Size: 157.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.1

File hashes

Hashes for xknx-0.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 463ff62a41d564f8876c3e85da780f5ad99f0a81a8d8a0756e1d6b73b56a5dbb
MD5 4ff7664b7aac420f6dca0bfcd50f36ff
BLAKE2b-256 7caf29ea3871b39275b7bcd5e6da6e21a183cbf2da5567030878d9ef67193994

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