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

Uploaded Source

Built Distribution

xknx-0.15.2-py3-none-any.whl (127.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.15.2.tar.gz
  • Upload date:
  • Size: 79.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

File hashes

Hashes for xknx-0.15.2.tar.gz
Algorithm Hash digest
SHA256 c129e18e9466d4b9b3147f4152e89de93178daef7990fff2e44cc7f8da88c1ad
MD5 b4bd3ccbe699bd738671b2406d1f934d
BLAKE2b-256 04bb7e7d9a73c43150eaa13be3fdae9844c5f46dc10b7d06369226eba4906d94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.15.2-py3-none-any.whl
  • Upload date:
  • Size: 127.8 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/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

File hashes

Hashes for xknx-0.15.2-py3-none-any.whl
Algorithm Hash digest
SHA256 becc752c13729e7331125e02bab238ec43147f1cb6bbc98cfd5186e7e7945fb3
MD5 638415007dc3427298363c08d234b0fa
BLAKE2b-256 361df6c1a473eef40fe0527f8ca8ffab04422ad3153f89c161758fbaf13d1c82

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