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

Uploaded Source

Built Distribution

xknx-0.14.3-py3-none-any.whl (118.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.14.3.tar.gz
  • Upload date:
  • Size: 72.0 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.3.tar.gz
Algorithm Hash digest
SHA256 3df85b8d6fb789212332fb7d606ec40a17cd06f3019e08bc38164227d8fb101d
MD5 e344507fa9cc54854f0100507aaa1ee9
BLAKE2b-256 5de8a37721bbd7ffae15e67972a4bffe48acb67d467779edb861b7ac48297881

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.14.3-py3-none-any.whl
  • Upload date:
  • Size: 118.0 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d93467cdea68e91b1a1cc1bf721eeb58203d0271051af64890e299c9ce162fbd
MD5 73c8335cbe49e46743dc6bcaf381311d
BLAKE2b-256 a3ee4b213cc6e6d4084257a7317d9134756c7f80b8827da81e1d556185a79f2d

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