Metadata-Version: 2.4
Name: velbus-aio
Version: 2026.4.1
Summary: Open-source home automation platform running on Python 3.
Author-email: Maikel Punie <maikel.punie@gmail.com>
License: MIT
Project-URL: Source Code, https://github.com/Cereal2nd/velbus-aio
Project-URL: Bug Reports, https://github.com/Cereal2nd/velbus-aio/issues
Keywords: home,velbus,automation
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: serialx
Requires-Dist: backoff>=1.10.0
Requires-Dist: aiofile
Requires-Dist: beautifulsoup4
Requires-Dist: lxml
Dynamic: license-file

[![main.yml](https://github.com/Cereal2nd/velbus-aio/actions/workflows/main.yml/badge.svg)](https://github.com/Cereal2nd/velbus-aio/actions?query=workflow:"main.yml")
[![License](https://img.shields.io/github/license/Cereal2nd/velbus-aio)](https://github.com/cereal2nd/velbus-aio/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/Cereal2nd/velbus-aio?include_prereleases=&sort=semver&color=blue)](https://github.com/Cereal2nd/velbus-aio/releases/)
[![PyPI version](https://badge.fury.io/py/velbus-aio.svg)](https://badge.fury.io/py/velbus-aio)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/velbus-aio.svg)](https://github.com/Cereal2nd/velbus-aio)
[![Go to Python website](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FCereal2nd%2Fvelbus-aio%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=project.requires-python&label=python&logo=python&logoColor=white)](https://python.org)

[![Contributors](https://img.shields.io/github/contributors/Cereal2nd/velbus-aio)](https://github.com/cereal2nd/velbus-aio/graphs/contributors)
[![issues - velbus-aio](https://img.shields.io/github/issues/Cereal2nd/velbus-aio)](https://github.com/Cereal2nd/velbus-aio/issues)
[![issues closed - velbus-aio](https://img.shields.io/github/issues-closed-raw/Cereal2nd/velbus-aio)](https://github.com/cereal2nd/velbus-aio/issues?q=is%3Aissue%20state%3Aclosed)
[![Forks](https://img.shields.io/github/forks/Cereal2nd/velbus-aio?style=social)](https://github.com/cereal2nd/velbus-aio/forks)

[![Downloads](https://pepy.tech/badge/velbus-aio)](https://pepy.tech/project/velbus-aio)
[![Downloads](https://pepy.tech/badge/velbus-aio/month)](https://pepy.tech/project/velbus-aio)
[![Downloads](https://pepy.tech/badge/velbus-aio/week)](https://pepy.tech/project/velbus-aio)
[![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)

> This project requires financial support, but it is free for you to use. You can join those helping to keep the lights on at:
>
> [<img src="https://raw.githubusercontent.com/Cereal2nd/hassio-velbusd/refs/heads/main/images/bmc-button.svg" width=150 height=40 style="margin: 5px"/>](https://buymeacoffee.com/cereal2nd) [<img src="https://raw.githubusercontent.com/Cereal2nd/hassio-velbusd/refs/heads/main/images/github-sponsors-button.svg" width=150 height=40 style="margin: 5px"/>](https://github.com/sponsors/Cereal2nd/)

# velbus-aio

Velbus Asyncio, a library to support the [Velbus](https://www.velbus.eu/) home automation system.

This Lib is a rewrite in python3 with asyncio of the [python-velbus](https://github.com/thomasdelaet/python-velbus/) module.
Part of the code from the above lib is reused.
Its also build on top of the [openHab velbus protocol description](https://github.com/StefCoene/moduleprotocol).

The latest version of the library is published as a python package on [pypi](https://pypi.org/project/velbus-aio/)

# Supported connections:

| Type               | Example                          | Description                                                                                                           |
| ------------------ | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| serial             | /dev/ttyACME0                    | a serial device                                                                                                       |
| (tcp://)ip:port    | 192.168.1.9:1234                 | An ip address + tcp port combination, used in combination with any velbus => tcp gateway, the tcp:// part is optional |
| tls://ip:port      | tls://192.168.1.9:12345          | A connection to [Signum](https://www.velbus.eu/products/view/?id=458140)                                              |
| tls://auth@ip:port | tls://iauthKey@192.168.1.9:12345 | A connection to [Signum](https://www.velbus.eu/products/view/?id=458140) with uthentication                           |

# Development

See the [contributing](https://github.com/Cereal2nd/velbus-aio/blob/master/CONTRIBUTING.md) guidelines.