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

Uploaded Source

Built Distribution

xknx-0.15.4-py3-none-any.whl (128.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.15.4.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.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.4.tar.gz
Algorithm Hash digest
SHA256 c08e65a1473b76861de177b9f178b285aaba9d7cfe7f6236d9c7ef6e4f1d2349
MD5 d51bd5c4e76368a81f2df162ef0f7dae
BLAKE2b-256 d47cf5268379dd6b401fa675bb84d027a3cbe27ca8774ff70526371c5b3d2d79

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.15.4-py3-none-any.whl
  • Upload date:
  • Size: 128.2 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4503e85d53e2126909f7a717d8675f76e8ae5bd495c052f2b9bb7aa9063ba80d
MD5 c87cacb86e758179878b513f1a7414b5
BLAKE2b-256 1c99111b09b6d28272ce01bbf604547de721647c5e78bcae7922b8c3ad648f71

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