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

Uploaded Source

Built Distribution

xknx-0.18.4-py3-none-any.whl (144.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.4.tar.gz
  • Upload date:
  • Size: 88.4 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.0 CPython/3.9.5

File hashes

Hashes for xknx-0.18.4.tar.gz
Algorithm Hash digest
SHA256 7416a26a16ef4891fa87c7aeebac2a67bdc859b74bda1f43edcbf0762feee7e3
MD5 70fb62262668ba3db05880bd9415962e
BLAKE2b-256 6725e032d98924ef44be65fa8850e75b4fc65ce74f4921bd17a41c8b0e448545

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.4-py3-none-any.whl
  • Upload date:
  • Size: 144.3 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.0 CPython/3.9.5

File hashes

Hashes for xknx-0.18.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c24e4302aacfe7703495f4c94c19dddcd01bab6459dacc1c3f414f019b95be1e
MD5 c6c3932d18be51ac7047ae4568d5051b
BLAKE2b-256 9dfbd5f91d8668fb41621e231bd02b062310310ff25b908f7cca5d023653014d

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