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

Uploaded Source

Built Distribution

xknx-0.15.3-py3-none-any.whl (128.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xknx-0.15.3.tar.gz
Algorithm Hash digest
SHA256 9084f8ebd89184cd116aef503b1799af666fa9d479d66daf34fb4161fb2771f8
MD5 72c3f4aaacbee6dee5d7320175b20bf8
BLAKE2b-256 e99257e4b3b2c75e7189236b39e7916c69b84c9792b574435f37d10b6ecbdd79

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xknx-0.15.3-py3-none-any.whl
Algorithm Hash digest
SHA256 43d33b116b396276051dff5c274aadbf7e319de79d1c4e00dc409bf68c4d905f
MD5 7eff2979bd12a08440d9c027f1c36f81
BLAKE2b-256 d5a49d1cfb42f2e178c165503516c0a8e400fcb5b19048cc401d88e58d798b5f

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