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

Uploaded Source

Built Distribution

xknx-0.15.0-py3-none-any.whl (120.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.15.0.tar.gz
  • Upload date:
  • Size: 73.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for xknx-0.15.0.tar.gz
Algorithm Hash digest
SHA256 620fb30ec54e984540ccd58c5c5914016e483426e9609fab57a6e0751ef27e0c
MD5 89a7e195d2edde3f25aca19a48e9871e
BLAKE2b-256 d653984a3ae2e29ad42c5c96709449c26e8441511f0cfb697c92fb68f2950f3e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 120.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for xknx-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41874f215b772d5400540f6f572257d67df328b09546e04a75e428480a8c3e55
MD5 99358984fca6afaa7f136aff37ecd846
BLAKE2b-256 9923cdde767db2dbab7e3efc9d2b78f7b1e9153c67e117ac27d3bc69ea7def9c

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