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

Uploaded Source

Built Distribution

xknx-0.14.0-py3-none-any.whl (117.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.14.0.tar.gz
  • Upload date:
  • Size: 71.9 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.0.tar.gz
Algorithm Hash digest
SHA256 b5013924375d78a52aabf887ed778bbdc4aa316bb9007953568df34f93a72424
MD5 69be50423ba3e562daf1cb3fbe265342
BLAKE2b-256 67d36f27f7930def899f3e49657958bd9b8c6c71fa8491bd17305233b6f0947d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 117.9 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46fdfe97c7494113a975e13394b0695122e77a0f614395409c81ce3afde52644
MD5 9b0b8d542df55c14474084f8f51bebb2
BLAKE2b-256 66d25d849aa6f92628bf5f13ae7670dc7fd5713dfd36519adf1efedbb9b987ec

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