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

Uploaded Source

Built Distribution

xknx-0.18.9-py3-none-any.whl (148.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.9.tar.gz
  • Upload date:
  • Size: 89.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for xknx-0.18.9.tar.gz
Algorithm Hash digest
SHA256 5748d31bf67e4a172da9e124deef08909f902e9df504c51d1af323a7691c0f62
MD5 4c65544aaf6d4fa08c5c15682b6172bf
BLAKE2b-256 77311797ae2a1a3531bc1832bd13a3bcd37e8883c02cee0f5060708a8cb5be4f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.9-py3-none-any.whl
  • Upload date:
  • Size: 148.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for xknx-0.18.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f61a89ab9d115527430781ecc55184ba066ed83d6d6a7f5bee4fe2823941e8b5
MD5 e41b8ccf546478b36624e31fefaa892b
BLAKE2b-256 f17cd284692005925246f7edc833114800703ccd907f3b865960c9541bc8fe10

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