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

Uploaded Source

Built Distribution

xknx-0.18.8-py3-none-any.whl (147.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.18.8.tar.gz
  • Upload date:
  • Size: 89.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.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.8.tar.gz
Algorithm Hash digest
SHA256 9de9f497a35b5c75ac6bc1a3edc2ccd247052bae906a7825a7a1b371504c8a6e
MD5 b8c698d0ef1cc454d45ae5e46ecba69a
BLAKE2b-256 a4add8ea0b89166dd734844f112114d50fa67f87413e6def1e9f05f7f0d0d657

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.18.8-py3-none-any.whl
  • Upload date:
  • Size: 147.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 386380242f3ad2afd7a260ead5ec77e118c94696676950209a5bbf48ee2c1d8a
MD5 386c1949b3194ed1e5792865196f43f5
BLAKE2b-256 7c144e768d4b7ec2926ad676a965a88d23c6b6c026de579206118875d6a8291f

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