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

Uploaded Source

Built Distribution

xknx-0.17.0-py3-none-any.whl (156.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.17.0.tar.gz
  • Upload date:
  • Size: 98.1 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.0.tar.gz
Algorithm Hash digest
SHA256 f424b84fd123267afa41e550eb4d1a378366139ac63dc9e6eaa7f5683f632406
MD5 bf470f7e8b4ac06b2b879b3a0075d21b
BLAKE2b-256 f876e28c20d25a0ced01c3ec425495c3131fbad533281cedc63d3aaed809ce6f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 156.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c95c7621e711be7a9f3d27e54b1e0dc0077d716cb824af4ad9e84d29d8a9c47b
MD5 a3bee3e7e08123e4cb86880b52dd3738
BLAKE2b-256 75f9fcec6383fdf5d61ef62efe3c1304e4352127e8eb119ce943c1b504ce137a

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