VIMAR By-Me / By-Web Hub

This is a home-assistant integration for the VIMAR By-me / By-web bus system.

WARNING - BEFORE YOU UPGRADE

If you upgrade from a version earlier of May 2021 - please be aware: The integration name has changed from vimar_platform to vimar - this requires changes in your configuration and it may effect your current dashboards as well. In order to keep all dashboard layouts, automations and groups intact, you may want to follow this upgrade guide:

DO NOT update the files in your custom_components directory right away
stop home-assistant
find and backup the file: .storage/core.entity_registry within your home-assistant config directory
open that file in a proper text-editor
replace all vimar_platform occurrences to vimar (only replace with that exact notation)
save that file in it's original place
open your configuration.yaml and replace vimar_platform: with vimar: as well
remove the directory custom_components/vimar_platform/ and checkout the source under custom_components/vimar/
start up home-assistant again

Vimar requirements

Hardware:

Software:

By-me Web Server Firmware

I have only tested it with the firmware version v2.5 to v2.8 - if you plan to update the firmware of your web server, please make sure you have a full backup of your vimar database (complete db and exported xml file) ready.

home-assistant requirements

See installation guides Home-Assistant.io

installation

Use HACS !
Otherwise, download the zip from the latest release and copy vimar folder into your custom_components folder within your home-assistant installation.

You will end up with something like this:

on docker/hassio: /config/custom_components/vimar/
on hassbian/virtualenv: /home/homeassistant/.homeassistant/custom_components/vimar/

configuration

After you installed the custom component either via HACS or by extracting the release zip into your custom_components folder you should be able to select Vimar By-Me Hub from the list of integration in the Home-Assistant GUI.

From there simply follow the instructions.

Any previous setup made in your configuration.yaml will be taken over to the GUI and can be removed afterwards.

credentials

username and password are those from the local vimar webserver reachable under host. schema, port, and certificate is optional - if left out, the integration will use https calls on port 443 to the given host. The certificate can be a writeable filename. If there is no file found, the integration will download the current CA certificate from the local vimar webserver and save it under that given file name for sub sequent calls. (e.g. certificate: rootCA.VIMAR.crt). timeout will allow to tweak the timeout for connection and transmition of data to the webserver (default 6 seconds). if only some platforms should be added to home-assistant you list them in the ignore area.

The hostname or the IP has to match the settings screen on the vimar web server:

limitations

The integration can currently list and control all lights, rgb dimmers, audio devices, energie guards, covers/shades, fans, switches, climates and scenes. Other devices are not yet implemented. The python module behind the communication mimics the http calls to the webserver that are usually made through the By-me Webinterface. Generally speaking: THIS IS A BETA VERSION Use at your own risk. So far I could only test it on a single installation, which is my own. If you want to try it out, and need help, please create a "Request Support" ticket.

Command line usage

You can use the vimarlink library in the command line like this:

# install python3.9
# install some requirements
python3.9 -m pip install async_timeout homeassistant
# see examples
cd examples
# copy credentials.cfg.dist to credentials.cfg and add your credentials
# run the example script - print help
python3.9 example.py -h
# run the example script - list all lights
python3.9 example.py --platform lights
# run the example script - change a specific cover to open
python3.9 example.py --platform covers --device 721 "up/down"=0

contribution

If you want to help see some examples of how to read out data for new devies in contribution.

troubleshooting

When you install, update or uninstall the integration, you need to restart Home Assistant.

Enable more logging for vimar - add to your configuration.yaml:

logger:
  default: warning
  logs:
    custom_components.vimar: debug

have a look into your home-assistant log files - usually named home-assistant.log in the directory where your configuration.yaml is located.

  WARNING (MainThread) [homeassistant.loader] You are using a custom integration for vimar which has not been tested by Home Assistant. This component might cause stability problems, be sure to disable it if you experience issues with Home Assistant.

the Vimar platform code and the configuration was found. The warning is been shown for all custom components. This is GOOD!

  ERROR (MainThread) [custom_components.vimar] Could not connect to Vimar Webserver home-assistant

Vimar By-me Webserver was not found under the given address.

  ERROR (MainThread) [homeassistant.setup] Setup failed for vimar: Integration not found

You have put the content of this repository into the wrong directory - see above for an example.

  ERROR (SyncWorker_4) [custom_components.vimar.vimarlink] Other error occurred: SSLError(MaxRetryError('HTTPSConnectionPool(host='***', port=443): Max retries exceeded with url: /vimarbyweb/modules/system/user_login.php?sessionid=&username=***&password=***&remember=0&op=login (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])")))'))

There seems to a problem with the SSL connection. Try if it works with the config setting certificate: (empty certificate option)

  ERROR (SyncWorker_5) [custom_components.vimar.vimarlink] Error parsing XML: TypeError("a bytes-like object is required, not 'bool'")

This message paired with a web server that needs manual restarting: You may have too many devices connected to the installation.

  Some entities are listed as "not available" with a red exclamation mark in the entity list.

See the explanation and the fix in: h4de5#15 (comment)

  When you enable the integration in home-assistant you can no longer use the vimar web server gui.

Please create a separate user on your VIMAR webserver for this integration. At some point the web server does not allow to be logged in with the same user from different locations and simple drops one connection. This may have strange side effects.

thanks

thanks to everybody who was helping me developing and testing this integration. special thanks to user @felisida for his endless patience ;)

robigan/home-assistant-vimar