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

Uploaded Source

Built Distribution

xknx-0.14.1-py3-none-any.whl (117.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xknx-0.14.1.tar.gz
  • Upload date:
  • Size: 71.8 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.1.tar.gz
Algorithm Hash digest
SHA256 19729fdc21ad25ac7c7e297a59798d6eb2c155d26432b9e63d4d12ccfbb2fb02
MD5 432cb5be07a16310ef55f5b018de3cee
BLAKE2b-256 6ac9628b831ed5c625b2a3c3ee7f18edf5d12d73bbc84389e9591b5be9c9a44c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xknx-0.14.1-py3-none-any.whl
  • Upload date:
  • Size: 117.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 60331fe7cbd4a81e077a103211124bb595783cf73165401478ad678f3abc951c
MD5 70cd544d50768f67efc9b2d26918fbf3
BLAKE2b-256 9ff403d0b6a5078d4f23efc1a35a098e5414f0cbf7bbaed9ce5fdeaf656f008c

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