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

Uploaded Source

Built Distribution

xknx-0.18.7-py3-none-any.whl (147.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.7.tar.gz
  • Upload date:
  • Size: 89.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for xknx-0.18.7.tar.gz
Algorithm Hash digest
SHA256 f63612a1f9816738d226804b2dd1e64b17fc579bed0326e989324568e8b9eb18
MD5 61368de8cf788bbe2edbd10f4fa3990c
BLAKE2b-256 878fc49cf3c139daac769ccbef1dc81696a49fc94e14e410069d7881f35fefd7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.7-py3-none-any.whl
  • Upload date:
  • Size: 147.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for xknx-0.18.7-py3-none-any.whl
Algorithm Hash digest
SHA256 6a3b9977603f2893a4078f36bfb0e01cd57b079d061c6d79d009cea31b2aa77e
MD5 692d8e38c5cbc079d1510dfcf144ef30
BLAKE2b-256 a8731906e13bc391b1e4de4ff02244aa205380037d0b9b835a473bfc17dd4485

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