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

Uploaded Source

Built Distribution

xknx-0.15.6-py3-none-any.whl (128.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.15.6.tar.gz
  • Upload date:
  • Size: 80.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for xknx-0.15.6.tar.gz
Algorithm Hash digest
SHA256 187b20fd72e0d1d7d57ef153eb6810403246e36d42f6d4b0696129006c34a08f
MD5 a3605060c6062b6ad38788530cca44e6
BLAKE2b-256 68c7392ad555904637fb42a0ecbf7a25496c7763c2b59b0c1432acac23993718

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.15.6-py3-none-any.whl
  • Upload date:
  • Size: 128.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for xknx-0.15.6-py3-none-any.whl
Algorithm Hash digest
SHA256 cdf5dee2f161a05172379dda419dd982ddd680dac4d15c6a0920bad574dd8bca
MD5 6a7c4c354f13ccb1bb0c5dd4318e887e
BLAKE2b-256 fd18494e60607d56451f324e4eb58147790b360cbd398e8f31dc07a97868b2b4

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