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

Uploaded Source

Built Distribution

xknx-0.16.2-py3-none-any.whl (151.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.16.2.tar.gz
  • Upload date:
  • Size: 95.7 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.2.tar.gz
Algorithm Hash digest
SHA256 80aa23d138b53e28888dc91a12bc471302f25d9d85071c8ae0af54923be59e57
MD5 5cd86faa2b13f03adacd77fbfabf5f47
BLAKE2b-256 3c349ba8228dda7f009941d0b728a0870849865d4f19d29259a339433acb196f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.16.2-py3-none-any.whl
  • Upload date:
  • Size: 151.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 093ae8f0efaaa56762ba07567f32d5c7fe31ba8bb4d483b085b9a088ba47ec6e
MD5 884a19a4ed5b1d4477cf6f3021636acf
BLAKE2b-256 c9828a8ef7edf209279e03127fe1a55d2a26af116849a3a77aee641f954ff43e

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