Skip to main content

Python Library for the Velbus protocol

Project description

python-velbus: A python library to control the Velbus home automation system

This library was created to support the Velbus protocol in my home automation efforts.

It is currently being used by the Velbus component in home assisstant but can also be used indepenently.

The latest version of the library is published as a python package on pypi

I would like to extend this module to support all Velbus modules, so feel free to submit pull requests or log issues through github for functionality you like to have included.

API documentation is available here

Port format

There are 3 possible port formats:

  • /dev/ttyACME0 = A direct connection to a serial device (for vmbusb for example)
  • ip:port = A connection to a TCP/IP port
  • tls://signum ip:27015 = A connection to a signum ip

Installation

You can install the library with pip (pip install python-velbus) or by checking out the github repository and running python setup.py install at the root of the repository.

Supported modules

The following Velbus modules are currently supported by this library:

Module name Description Comments
VMB1BL 1 channel blind module All messages are supported
VMB1BLS 1 channel blind module All messages are supported
VMB1LED 1 channel LED dimmer module All messages are supported
VMB1RS Serial interface All messages are supported
VMB1RY 1 channel relay module All messages are supported
VMB1RYS 1 channel relay module All messages are supported
VMB1RYNO 1 channel relay module All messages are supported
VMB1RYNOS 1 channel relay module All messages are supported
VMB1TS 1 channel temperatue sensor Temperature supported
VMB1USB USB configuration module All messages are supported
VMB2BL 2 channel blind module All messages are supported
VMB2BLE 2 channel blind module All messages are supported
VMB2PBN 2 channel input module All messages are supported
VMB4DC 4 channel 0-10 dimmer module All messages are supported
VMB4RY 4 channel relay module All messages are supported
VMB4RYLD 4 channel relay module All messages are supported
VMB4RYNO 4 channel relay module All messages are supported
VMB6IN 6 channel input module All messages are supported
VMB6PBN 6 channel input module All messages are supported
VMB7IN 7 channel input module All messages are supported
VMB8PBU 8 channel input module All messages are supported
VMBDME 1 channel dimmer module All messages are supported
VMBDMI 1 channel dimmer module All messages are supported
VMBDMI-R 1 channel dimmer module All messages are supported
VMBGP1 1 channel glass panel Input and Temperature supported
VMBGP1-2 1 channel glass panel Input and Temperature supported
VMBGP2 2 channel glass panel Input and Temperature supported
VMBGP2-2 2 channel glass panel Input and Temperature supported
VMBGP4 4 channel glass panel Input and Temperature supported
VMBGP4-2 4 channel glass panel Input and Temperature supported
VMBGPO 72 channel glass panel with oled Input and Temperature supported
VMBGPOD 72 channel glass panel with oled and thermostat Input and Temperature supported
VMBMETEO meteo modules Temperature, wind, rain and light sensor supported
VMBRSUSB Configuration module with USB and RS-232 interface All messages are supported
VMBEL1 1 channel glass panel Edge Lit Input and Temperature supported
VMBEL2 2 channel glass panel Edge Lit Input and Temperature supported
VMBEL2 2 channel glass panel Edge Lit Input and Temperature supported
VMBEL4 4 channel glass panel Edge Lit Input and Temperature supported
VMBELO 72 channel glass panel Edge Lit with thermostat and oled screen Input and Temperature supported

Adding support for other modules

The velbus website contains an overview of the different available modules and their protocol documentation. In order to add support for an additional module, read through the protocol documemntation and add support for missing messages (many messages are shared between modules so make sure to check if a message already exists or not)

Steps to add support for an additional module:

  • <input type="checkbox" disabled="" /> Look up the protocol documentation of the module you want to include at the velbus website: Select the module, go to Downloads and search for the info sheet with protocol information.
  • <input type="checkbox" disabled="" /> Go through the messages directory and look for messages in the protocol information sheet that are not yet supported. Create a new file in the messages folder for each unsupported message. Every new message should inherit from the Message object and reuse common functionality.
  • <input type="checkbox" disabled="" /> Implement constructor method for each new message
  • <input type="checkbox" disabled="" /> Implement the populate and data_to_binary methods for each new message
  • <input type="checkbox" disabled="" /> If the message has other than low priority or no RTR set (which are defaults), then re-implement set_defaults method
  • <input type="checkbox" disabled="" /> Add new messages to the init.py file in the messages folder
  • <input type="checkbox" disabled="" /> Test and iterate
  • <input type="checkbox" disabled="" /> Update the Supported modules section of the README.md file
  • <input type="checkbox" disabled="" /> Submit a pull request on Github

Further development

The library currently offers only the lowest level of functionality: sending and receiving messages to modules. I plan to extend this library with more higher-level functionality such as:

  • <input type="checkbox" checked="" disabled="" /> Modeling modules and their supported functions as entities
  • <input type="checkbox" disabled="" /> Only allowing to send supported messages to modules
  • <input type="checkbox" checked="" disabled="" /> Auto-discovery of modules
  • <input type="checkbox" disabled="" /> Exposing the velbus controller as an external API so it can be shared between different consumers

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-velbus, version 2.1.4
Filename, size File type Python version Upload date Hashes
Filename, size python_velbus-2.1.4-py3-none-any.whl (80.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size python-velbus-2.1.4.tar.gz (33.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page