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

Uploaded Source

Built Distribution

xknx-0.16.0-py3-none-any.whl (154.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-0.16.0.tar.gz
Algorithm Hash digest
SHA256 7becbd3a7ddeba133a1733477b91b9806377d6f09616bbc4069979f185f9a87b
MD5 64302c6ee8c2738a78bc25b756bbb64f
BLAKE2b-256 0e3f94a3c0368de1772c77a2332b8191759a71c7b77165f59a25c0d03377b17e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xknx-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8095fe0003d7a6850496bc97b86df282a829e66313a884ec7672acbf7b2ef0b5
MD5 4293ff201a8110eaf522117860dee83b
BLAKE2b-256 0a0091058d4e3a8a7dcca77caffcf772d4a771f49f9d052ef78c82fa4986052d

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