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

Uploaded Source

Built Distribution

xknx-0.18.12-py3-none-any.whl (151.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.12.tar.gz
  • Upload date:
  • Size: 91.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for xknx-0.18.12.tar.gz
Algorithm Hash digest
SHA256 a212cb69629d45bbf15fdabf9a867738e2650a5adb65920ef5686adbb192b1fe
MD5 1f49ac5f3913705c4d69847820d7f09b
BLAKE2b-256 508786df964e477184055f511551621417d1324c182835aa672dfe9880f21899

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.12-py3-none-any.whl
  • Upload date:
  • Size: 151.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for xknx-0.18.12-py3-none-any.whl
Algorithm Hash digest
SHA256 359d4503150aba4f6ff73d9803736e1a162d4c1736084f49668dda842eaaa04d
MD5 1125326b60aaf6fbeb0dbcc0fc0e5e53
BLAKE2b-256 65cb858c721aae3c006095480681b978743b106db5bdff2884a2c4bbba4a5e72

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