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

PyPI - Python Version codecov Checked with mypy Pre-commit HA integration usage Discord

Documentation

See documentation at: https://xknx.io/

Help

We need your help for testing and improving XKNX. For questions, feature requests, bug reports either open an issue, join the XKNX chat on Discord or write an email.

Development

You will need at least Python 3.9 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

XKNX is the underlying library for the KNX integration in Home Assistant.

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

Uploaded Source

Built Distribution

xknx-1.0.0-py3-none-any.whl (190.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-1.0.0.tar.gz
  • Upload date:
  • Size: 120.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for xknx-1.0.0.tar.gz
Algorithm Hash digest
SHA256 7065a65b4216e2fa538a3125055c223112eec2e835054edf2d394213f9fbf414
MD5 f3a30a7d6e14a13c698f7255f6a7310c
BLAKE2b-256 96d17fd860078d154f476be13f59a08da93a5cacd6dc8d7430e5c6cfadb86d38

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 190.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for xknx-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1600c3210c9855dc6343e702b0de04fa074c1b288f16ddde6b0c3add2ca28e5
MD5 56b9218d07fdfb11c129db8d62863b5b
BLAKE2b-256 57bd3d2e990e6291a7ae43342a8ce033805a5c6fe4b78d8edd04b917d1f7ea40

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