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

Build Status Coverage Status 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.7 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.16.3.tar.gz (96.1 kB view details)

Uploaded Source

Built Distribution

xknx-0.16.3-py3-none-any.whl (151.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.16.3.tar.gz
  • Upload date:
  • Size: 96.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for xknx-0.16.3.tar.gz
Algorithm Hash digest
SHA256 c1937a81af187847760caefc20be6730cb0f95751544d25dc59418135bcadcda
MD5 7bc911c9ae573556bb594b6769107325
BLAKE2b-256 fb328259a72807f1e5faad566695181960d5f8012bea2c52d00caeeb75e0c8c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.16.3-py3-none-any.whl
  • Upload date:
  • Size: 151.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for xknx-0.16.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c1bfca0d0f06d32835ea8ba0a7821aef4b6f2b39be79a4476d676646dc70bdb3
MD5 ba6cd148fdb4b5a5f4d61d6b097b667b
BLAKE2b-256 50d53399bad505884e4e09f8c2cfa2de759b6d3e1c65654f6277eecda50bc0c0

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