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

Uploaded Source

Built Distribution

xknx-0.15.1-py3-none-any.whl (120.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.15.1.tar.gz
  • Upload date:
  • Size: 73.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5

File hashes

Hashes for xknx-0.15.1.tar.gz
Algorithm Hash digest
SHA256 bc3ee2838f09f4675becbbc5dd33f47550fe88463d467f25846a2f41bd6d2e3c
MD5 820c41c3b13518c70d36370486ff681f
BLAKE2b-256 ce8f5dba2408e172dc8f70ca2129ac2cb2fd9de78fc71836b85ff4950528c395

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.15.1-py3-none-any.whl
  • Upload date:
  • Size: 120.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5

File hashes

Hashes for xknx-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7bf28eb0a900857391ad6f6e57fd3b18c81a5e17957f75134af074dd6b728e21
MD5 8a211bc2fed8a7a423c3f881cc8681e7
BLAKE2b-256 8cc76e0eb64ecdcdd9a3cf7c0da6179c2db52d2f40ec852062bf42cdbd516fa4

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