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

Uploaded Source

Built Distribution

xknx-0.15.5-py3-none-any.whl (128.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.15.5.tar.gz
  • Upload date:
  • Size: 80.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for xknx-0.15.5.tar.gz
Algorithm Hash digest
SHA256 48297fe074045967fdd99bc321b81b5c8fea52964a0bc1ec1df930412c64ab9f
MD5 ff8c249dd72ab8cda4d765b220d2ddae
BLAKE2b-256 a9986c19b8df7dfcf4a8305a1f21ba0646fed6f3f72931f30483cbc7fbcb4409

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.15.5-py3-none-any.whl
  • Upload date:
  • Size: 128.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for xknx-0.15.5-py3-none-any.whl
Algorithm Hash digest
SHA256 38c3e8bc50928497837c27287b812f052c4cabcb51115ce507eb962cd459e6f0
MD5 6b326afbc65577e4d7a5945432e198f7
BLAKE2b-256 7ab87dbfc8d53366e9d38e8f223e3ed461beddbd9b56fa196564b6ada68c8925

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