This library was created to support Domintell protocol in home assisstant. It is based on python-velbus library by Thomas Delaet.

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

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

API documentation is not yet available.

The library currently only supports a UDP communicatin via DETH02 Domintell module, it can be easily modified to support RS-232 intiarface (domintell light protocol). In order to use the library, you need to first initialize the controller and can then send and receive messages on the Domintell.

import time
import logging
import sys
import domintell
import credentials
import os, sys

def _on_message(message):
    print('received message')
    print(message)

logging.basicConfig(stream=sys.stdout, level=logging.INFO)

# UDP, Serial (or USB over serial) connection to Domintell controller
host = '192.168.0.1:17481'

controller = domintell.Controller(host) 
controller.subscribe(_on_message)

logging.info('LOGIN')
controller.login(credentials.host['SECRET'])

time.sleep(10)
logging.info('Starting scan')
controller.scan(None)

logging.info('Going to sleep')
time.sleep(100)
logging.info('Exiting ...')
controller.stop()

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

The following Domitell modules are currently supported by this library:

The Domintell 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:

• Look up the protocol documentation of the module you want to include at the Domintell website.
• 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.
• Implement constructor method for each new message
• Implement the populate and data_to_binary methods for each new message
• Add new messages to the init.py file in the messages folder
• Test and iterate
• Update the Supported modules section of the README.md file
• Submit a pull request on Github

The library currently offers only the lowest level of functionality: sending and receiving messages to modules:

• Modeling modules and their supported functions as entities
• Only allowing to send supported messages to modules
• [*] Auto-discovery of modules
• Exposing the velbus controller as an external API so it can be shared between different consumers