{"id":46479724,"url":"https://github.com/h4de5/home-assistant-vimar","last_synced_at":"2026-03-06T08:01:49.608Z","repository":{"id":41090971,"uuid":"269205129","full_name":"h4de5/home-assistant-vimar","owner":"h4de5","description":"VIMAR by-me integration into home-assistant.io","archived":false,"fork":false,"pushed_at":"2026-01-24T16:39:41.000Z","size":507,"stargazers_count":51,"open_issues_count":23,"forks_count":9,"subscribers_count":14,"default_branch":"master","last_synced_at":"2026-01-25T05:54:25.848Z","etag":null,"topics":["home-assistant","home-automation","homeassistant","homeassistant-integration","vimar","vimar-platform"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/h4de5.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-06-03T22:11:31.000Z","updated_at":"2026-01-24T17:04:34.000Z","dependencies_parsed_at":"2024-04-07T21:25:03.475Z","dependency_job_id":"2b27b1eb-e0e8-40ac-be19-16ad1fcecc57","html_url":"https://github.com/h4de5/home-assistant-vimar","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/h4de5/home-assistant-vimar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h4de5%2Fhome-assistant-vimar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h4de5%2Fhome-assistant-vimar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h4de5%2Fhome-assistant-vimar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h4de5%2Fhome-assistant-vimar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/h4de5","download_url":"https://codeload.github.com/h4de5/home-assistant-vimar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h4de5%2Fhome-assistant-vimar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30166859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T07:56:45.623Z","status":"ssl_error","status_checked_at":"2026-03-06T07:55:55.621Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["home-assistant","home-automation","homeassistant","homeassistant-integration","vimar","vimar-platform"],"created_at":"2026-03-06T08:01:49.144Z","updated_at":"2026-03-06T08:01:49.591Z","avatar_url":"https://github.com/h4de5.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![HACS Validate](https://github.com/h4de5/home-assistant-vimar/actions/workflows/validate.yml/badge.svg)](https://github.com/h4de5/home-assistant-vimar/actions/workflows/validate.yml)\n[![hassfest Validate](https://github.com/h4de5/home-assistant-vimar/actions/workflows/hassfest.yml/badge.svg)](https://github.com/h4de5/home-assistant-vimar/actions/workflows/hassfest.yml)\n[![Github Release](https://img.shields.io/github/release/h4de5/home-assistant-vimar.svg)](https://github.com/h4de5/home-assistant-vimar/releases)\n[![Github Commit since](https://img.shields.io/github/commits-since/h4de5/home-assistant-vimar/latest?sort=semver)](https://github.com/h4de5/home-assistant-vimar/releases)\n[![Github Open Issues](https://img.shields.io/github/issues/h4de5/home-assistant-vimar.svg)](https://github.com/h4de5/home-assistant-vimar/issues)\n[![Github Open Pull Requests](https://img.shields.io/github/issues-pr/h4de5/home-assistant-vimar.svg)](https://github.com/h4de5/home-assistant-vimar/pulls)\n\n# VIMAR By-Me / By-Web Hub\n\nThis is a home-assistant integration for the VIMAR By-me / By-web bus system.\n\n\u003cimg title=\"Lights, climates, covers\" src=\"https://user-images.githubusercontent.com/6115324/84840393-b091e100-b03f-11ea-84b1-c77cbeb83fb8.png\" width=\"900\"\u003e\n\u003cimg title=\"Energy guards\" src=\"https://user-images.githubusercontent.com/51525150/89122026-3a005400-d4c4-11ea-98cd-c4b340cfb4c2.jpg\" width=\"600\"\u003e\n\u003cimg title=\"Audio player\" src=\"https://user-images.githubusercontent.com/51525150/89122129-36b99800-d4c5-11ea-8089-18c2dcab0938.jpg\" width=\"300\"\u003e\n\n## WARNING - BEFORE YOU UPGRADE\n\nIf you upgrade from a version earlier of May 2021 - please be aware:\nThe integration name has changed from `vimar_platform` to `vimar` - this requires changes in your configuration and it may effect your current dashboards as well.\nIn order to keep all dashboard layouts, automations and groups intact, you may want to follow this upgrade guide:\n\n- DO NOT update the files in your `custom_components` directory right away\n- stop home-assistant\n- find and backup the file: `.storage/core.entity_registry` within your home-assistant config directory\n- open that file in a proper text-editor\n- replace all `vimar_platform` occurrences to `vimar` (only replace with that exact notation)\n- save that file in it's original place\n- open your configuration.yaml and replace `vimar_platform:` with `vimar:` as well\n- remove the directory `custom_components/vimar_platform/` and checkout the source under `custom_components/vimar/`\n- start up home-assistant again\n\n## Vimar requirements\n\nHardware:\n\n- [Vimar - 01945 - Web server By-me](https://www.vimar.com/de/int/catalog/obsolete/index/code/R01945)\n  or\n- [Vimar - 01946 - Web server Light By-me](https://www.vimar.com/en/int/catalog/product/index/code/R01946)\n\nSoftware:\n\n- [By-me Web Server Firmware](https://www.vimar.com/de/int/catalog/product/index/code/R01945)\n\n  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.\n\n## home-assistant requirements\n\nSee installation guides [Home-Assistant.io](http://home-assistant.io/)\n\n### installation\n\n- Use [HACS](https://hacs.xyz/) !\n- ![image](https://user-images.githubusercontent.com/6115324/121959380-ff627b80-cd64-11eb-812f-252dcbddc530.png)\n- Otherwise, download the zip from the latest release and copy `vimar` folder into your custom_components folder within your home-assistant installation.\n\nYou will end up with something like this:\n\n- on docker/hassio: `/config/custom_components/vimar/`\n\n- on hassbian/virtualenv: `/home/homeassistant/.homeassistant/custom_components/vimar/`\n\n### configuration\n\nAfter 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.\n\nFrom there simply follow the instructions.\n\nAny previous setup made in your configuration.yaml will be taken over to the GUI and can be removed afterwards.\n\n#### credentials\n\n`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.\n\nThe hostname or the IP has to match the settings screen on the vimar web server:\n\n![image](https://user-images.githubusercontent.com/6115324/83895464-04a0e980-a753-11ea-8c6c-a55dffba5b83.png)\n\n## limitations\n\nThe 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.\n\n## Command line usage\n\nYou can use the vimarlink library standalone (without Home Assistant) to test connectivity and control devices:\n\n```bash\n# Create and activate Python 3.13 virtual environment\ncd /path/to/home-assistant-vimar\npython3.13 -m venv .venv\nsource .venv/bin/activate\n\n# Install minimal dependencies (NO Home Assistant required)\npip install requests\n\n# Setup credentials\ncd examples\ncp credentials.cfg.dist credentials.cfg\n# Edit credentials.cfg with your VIMAR server details:\n#   host=\u003cyour-vimar-server-ip\u003e\n#   username=\u003cyour-username\u003e\n#   password=\u003cyour-password\u003e\n#   certificate=  (leave empty to skip SSL verification for expired certs)\n\n# Set PYTHONPATH and run\nexport PYTHONPATH=../custom_components/vimar\n\n# List all available platforms and device counts\npython example.py\n\n# List all devices for a specific platform\n# Valid platforms: light, cover, switch, climate, media_player, scene, sensor\npython example.py --platform light\npython example.py --platform cover\npython example.py --platform climate\n\n# Show help\npython example.py -h\n\n# Control a device (example: set cover position)\npython example.py --platform cover --device 721 \"up/down=0\"\n\n# Change a specific status on a device\npython example.py --platform light --device 123 --status on/off --value 1\n```\n\n## contribution\n\nIf you want to help see some examples of how to read out data for new devies in [contribution](CONTRIBUTING.md).\n\n## troubleshooting\n\n**When you install, update or uninstall the integration, you need to restart Home Assistant.**\n\nEnable more logging for vimar - add to your `configuration.yaml`:\n\n    logger:\n      default: warning\n      logs:\n        custom_components.vimar: debug\n\nhave a look into your home-assistant log files - usually named `home-assistant.log` in the directory where your `configuration.yaml` is located.\n\n      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.\n\n\u003e the Vimar platform code and the configuration was found. The warning is been shown for all custom components. This is GOOD!\n\n      ERROR (MainThread) [custom_components.vimar] Could not connect to Vimar Webserver home-assistant\n\n\u003e Vimar By-me Webserver was not found under the given address.\n\n      ERROR (MainThread) [homeassistant.setup] Setup failed for vimar: Integration not found\n\n\u003e You have put the content of this repository into the wrong directory - see above for an example.\n\n      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=\u0026username=***\u0026password=***\u0026remember=0\u0026op=login (Caused by SSLError(SSLError(\"bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])\")))'))\n\n\u003e There seems to a problem with the SSL connection. Try if it works with the config setting `certificate: ` (empty certificate option)\n\n      ERROR (SyncWorker_5) [custom_components.vimar.vimarlink] Error parsing XML: TypeError(\"a bytes-like object is required, not 'bool'\")\n\n\u003e This message paired with a web server that needs manual restarting: You may have too many devices connected to the installation.\n\n      Some entities are listed as \"not available\" with a red exclamation mark in the entity list.\n\n\u003e See the explanation and the fix in: https://github.com/h4de5/home-assistant-vimar/issues/15#issuecomment-665635305\n\n      When you enable the integration in home-assistant you can no longer use the vimar web server gui.\n\n\u003e 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.\n\n## thanks\n\nthanks to everybody who was helping me developing and testing this integration. special thanks to user @felisida for his endless patience ;)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fh4de5%2Fhome-assistant-vimar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fh4de5%2Fhome-assistant-vimar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fh4de5%2Fhome-assistant-vimar/lists"}