README.md

Unofficial Home Assistant custom component for Viessmann ViCare API

⚠️This project is archived - Please use the official integration in Home Assistant

The vicare component is a Home Assistant custom component for monitoring and controlling Viessmann devices through their cloud-based ViCare API.

⚠️ This custom component contains some experimental commits. Use at your own risk

Please check out the Official Home Assistant ViCare integration before installing this custom component.

Why an unofficial integration?

⚠️ I stopped maintaining the official integration due to lack of time.

Nevertheless I decided to publish my work as a custom integration since it supports a few things which the official integration doesn't (e.g. support for more than a single device) and it comes with end-to-end tests.

Please refer to the Changelog to see what changed compared to the Official Home Assistant ViCare integration.

Installation

Install with HACS (recommended)

1. Ensure that HACS is installed.
2. Add this repository to HACS
3. Search for and install the "ViCare" integration.
4. Configure the vicare integration.
5. Restart Home Assistant.

Install manually

1. Download the latest release.
2. Unpack the release and copy the custom_components/vicare directory into the <config dir>/custom_components directory of your Home Assistant installation.
3. Configure the vicare sensor.
4. Restart Home Assistant.

Configuration

User interface

Open the Configuration of your Home-Assistant instance and select Integrations. Add a new integration, search and select vicare. A dialog appears to enter your ViCare API credentials. Please see the documentation of the official Home Assistant ViCare integration for further details.

Development

See DEVELOPMENT.md for how to set up a development environment and contribute.

Links/Credits:

• Original feature request in HA community
• PyViCare Python API for accessing the ViCare API used by this project