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

Uploaded Source

Built Distribution

xknx-0.16.1-py3-none-any.whl (151.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.16.1.tar.gz
  • Upload date:
  • Size: 95.7 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.56.0 CPython/3.9.1

File hashes

Hashes for xknx-0.16.1.tar.gz
Algorithm Hash digest
SHA256 47b74561ef37fc2a13cff89a72c5cba54b22bd9e152d384f7ab66e665df7034a
MD5 29d73a0091d76093a3d4110c6965428c
BLAKE2b-256 ebea8e26e24789450269098562603297d964bf31d78c329e652a7930dc5ed575

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.16.1-py3-none-any.whl
  • Upload date:
  • Size: 151.1 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.56.0 CPython/3.9.1

File hashes

Hashes for xknx-0.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 01a1b45f399f1d59ba341339c4d84faf966265ec6824d7c71fecc387b1c4a416
MD5 da1a0137670123cbc18957eefd612f82
BLAKE2b-256 eeec8363fd8a2e05778b7ea7644fd87d88aee7ec8b900418a29e17f43dea38b7

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