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

codecov Checked with mypy 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.8 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.18.1.tar.gz (87.0 kB view details)

Uploaded Source

Built Distribution

xknx-0.18.1-py3-none-any.whl (141.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.1.tar.gz
  • Upload date:
  • Size: 87.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for xknx-0.18.1.tar.gz
Algorithm Hash digest
SHA256 18da7550c84669993cfc9be6a1e7ccf420e886cab3058c0b0d7ce03fb3be62a8
MD5 eb60f6efacb4552dc0e62be434d35b77
BLAKE2b-256 2c16f295f6d6db2ac1e92a46e0a210c40a64d1effb6dd3875f137121d3ec1141

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.1-py3-none-any.whl
  • Upload date:
  • Size: 141.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for xknx-0.18.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eb32a53d59074ab377cbc6af8cc8a5716376fc07a9546c393f8c0cc0be13ba37
MD5 2a9a9fd298eae5324bb8f6e2fb20e26a
BLAKE2b-256 3225e1114842fa9d40c1014fe4ff3277fabd175ca158c06353f18b8516945665

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