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

Requirements: Python > 3.5

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."""
    xknx = XKNX()
    await xknx.start()
    light = Light(xknx,
                  name='TestLight',
                  group_address_switch='1/0/9')
    await light.set_on()
    await asyncio.sleep(2)
    await light.set_off()
    await xknx.stop()


# pylint: disable=invalid-name
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.close()

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

Uploaded Source

Built Distribution

xknx-0.14.2-py3-none-any.whl (117.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.14.2.tar.gz
  • Upload date:
  • Size: 71.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.49.0 CPython/3.8.5

File hashes

Hashes for xknx-0.14.2.tar.gz
Algorithm Hash digest
SHA256 4d2a30171459f81f33ba669cb63641f6ade5880d1c1d21e383dfb08c073507be
MD5 261e78ee1f283d1e44349e419049e628
BLAKE2b-256 af9da9f5cdf4a5a63ed3aa841744cc38ab68a7ae280ff1dd398b2fb1af2cd22a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.14.2-py3-none-any.whl
  • Upload date:
  • Size: 117.8 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.49.0 CPython/3.8.5

File hashes

Hashes for xknx-0.14.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9b3f0aecc4e236a41ed47c2c57d1d559d1283a378ea11ab5e58a1afe727ab5aa
MD5 a23c089631bb75eaae6407cb46bf526e
BLAKE2b-256 aa080b29dc34554605362f374e4acffb39a47ce0553881be8d034d68c6d914a6

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