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

Uploaded Source

Built Distribution

xknx-0.14.4-py3-none-any.whl (118.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.14.4.tar.gz
  • Upload date:
  • Size: 72.2 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.4.tar.gz
Algorithm Hash digest
SHA256 baa11b770ef9fdc606a45e21f41084e84e384527613fd9a4c407c075ab1f2f6e
MD5 39295a9af5f12b264e0fca81af62b8bd
BLAKE2b-256 4073d587c93700e41f7d971fb0f7a8080ccb38f5b7963d67c09073d329e2cfff

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.14.4-py3-none-any.whl
  • Upload date:
  • Size: 118.3 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 04b796ccd2a339e30cd3c7b4816d2e10ecb527d1fa445e563f346bd7636702d4
MD5 2fb45d098104ec6249a04ceba25bbd3b
BLAKE2b-256 2420492a2e069302662d9366f7cbdfadd87fb5363632d2210b4946a9e537c8fa

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