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

Uploaded Source

Built Distribution

xknx-0.18.14-py3-none-any.whl (152.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.14.tar.gz
  • Upload date:
  • Size: 92.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for xknx-0.18.14.tar.gz
Algorithm Hash digest
SHA256 19dfa5414f2cc21b38343ced7d324c95041fe26ea781665b95cd7c7640f17ebb
MD5 a8503249fd110b13df8f62c2cd0db01e
BLAKE2b-256 efe0a89c0d7c798ae95a600523000f1464e7e860ece2646feb9e6f2d467becc9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.14-py3-none-any.whl
  • Upload date:
  • Size: 152.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for xknx-0.18.14-py3-none-any.whl
Algorithm Hash digest
SHA256 a214ab563b304b00245fe471d1492067dfb0a4ec7f031b2a4f776ca4aacd45a3
MD5 64d9e6406fc9abc9b4491fde8c949142
BLAKE2b-256 e302cbdc6087c9e81e84d568b2b061cd66b7bee145dfa6c6ec1f989021acc30a

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