Viessmann ViCare


The ViCare integration lets you control Viessmann devices via the Viessmann ViCare (REST) API. Most recent network-connected Viessmann heating devices (e.g., gas boilers) should be supported.

There is currently support for the following device types within Home Assistant:

Configuration

To set it up, add the following information to your configuration.yaml file:

vicare:
  username: VICARE_EMAIL
  password: VICARE_PASSWORD
  client_id: VICARE_CLIENT_ID

The above-required configuration parameters can be obtained as follows:

  1. Register and login in the Viessmann Developer Portal.
  2. In the menu navigate to API Keys.
  3. Create a new OAuth client using the following data:
Name: PyViCare
Google reCAPTCHA: Disabled
Redirect URIs: vicare://oauth-callback/everest
  1. Copy the Client ID to the configuration, e.g., client_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX".
  2. Set usernameand password to your Viessmann Developer Portal login credentials.

Configuration Variables

username string Required

Your username for the Viessmann developer portal

password string Required

Your password for the Viessmann developer portal

client_id string Required

Your API key from the Viessmann developer portal

name string (Optional, default: ViCare)

The friendly_name of the device (will be appended with Heating or Water)

heating_type string (Optional, default: auto)

One of auto, gas, oil, pellets, heatpump or fuelcell. Specifying the heating_type provides additional attributes and sensors specific for the heating system.

scan_interval integer (Optional, default: 60)

The update frequency of this component in seconds. See Viessmann API limits

Multiple device instances might be generated depending on the number of burners and/or circuits of your installation. If there is more than a single instance all devices are suffixed with the circuit or burner ID.

Viessmann API limits

The Viessmann API is rate-limited. If you exceed one of the limits below you will be banned for 24 hours:

  • Limit 1: 120 calls for a time window of 10 minutes
  • Limit 2: 1450 calls for a time window of 24 hours

The default scan_interval of 60 seconds will work within these limits. Note however that any additional requests to the API, e.g., by setting the temperature via the integration but also by interacting with the ViCare app also counts into those limits. It is therefore advised to adjust the scan_interval to your usage scenario.

Climate

A note about the current temperature attribute: Viessmann devices with room temperature sensing will show the current room temperature via current_temperature. All other devices will show the current supply temperature of the heating circuit.

Supported services climate.vicare_heating

The following services of the Climate component are provided by the ViCare integration: set_temperature, set_hvac_mode, set_preset_mode

Service set_temperature

Sets the target temperature to the given temperature.

Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_id’s of climate devices to control. To target all entities, use all keyword instead of entity_id.
temperature no Desired target temperature

Note that set_temperature will always affect the current normal temperature or, if a preset is set, the temperature of the preset (i.e., Viessman program like eco or comfort).

Service climate.set_hvac_mode

Set HVAC mode for the climate device. The following modes are supported:

The climate.vicare_heating component has the following mapping of HVAC modes to Viessmann operation modes:

HVAC mode Viessmann mode Description
off ForcedReduced Permanently set heating to reduced temperature. Note: This will also deactivate domestic hot water
heat ForcedNormal Permanently set heating to normal temperature.
auto DHWandHeating Switches between reduced and normal temperature as by the heating schedule programmed in your device
Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_id’s of climate devices to control. To target all entities, use all keyword instead of entity_id.
hvac_mode no New value of HVAC mode

Service climate.set_vicare_mode

Set the mode for the climate device as defined by Viessmann (see set_hvac_mode for a mapping to Home Assistant Climate modes. This allows more-fine grained control of the heating modes.

Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_id’s of climate devices to control. To target all entities, use all keyword instead of entity_id.
vicare_mode no New value of ViCare mode. For supported values see the vicare_modes attribute of the climate entity.

Service set_preset_mode

Sets the preset mode. Supported preset modes are eco and comfort. These are identical to the respective Viessmann programs and are only active temporarily for 8 hours. Eco mode reduces the target temperature by 3°C, whereas Comfort mode sets the target temperature to a configurable value. Please consult your heating device manual for more information.

Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_id’s of climate devices to control. To target all entities, use all keyword instead of entity_id.
preset_mode no New value of preset mode.

Water Heater

It is not possible to turn on/off water heating via the Water Heater component since this would conflict with the operation modes of the heating component. Therefore the operation mode of that component is just available as an attribute and cannot be modified.

Supported services water_heater.vicare_water

The following services of the Water Heater component are provided by the ViCare integration: set_temperature

Service set_temperature

Sets the target temperature of domestic hot water to the given temperature.

Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_id’s of climate devices to control.
temperature no New target temperature for water heater

Sensor

Additional data from ViCare is available as separate sensors. The sensors are automatically created based on the configured heating_type.