Home Assistant component that interfaces with the myVAILLANT API (and branded versions of it, such as the MiGo Link app from Saunier Duval & Bulex).
- Vaillant aroTHERM plus heatpump + sensoCOMFORT VRC 720 + sensoNET VR 921
- Vaillant ECOTEC PLUS boiler + VR940F + sensoCOMFORT
- Vaillant ECOTEC PLUS boiler + VRT380f + sensoNET
- Saunier Duval DUOMAX F30 90 + MISET Radio + MiLink V3
- More are documented here
Not affiliated with Vaillant, the developers take no responsibility for anything that happens to your devices because of this library.
- Supports climate & hot water controls, as well as sensor information
- Control operating modes, target temperature, and presets such as holiday more or quick veto
- Set the schedule for climate zones, water heaters, and circulation pumps with a custom service
- Track sensor information of devices, such as temperature, humidity, operating mode, energy usage, or energy efficiency
- See diagnostic information, such as the current heating curve, flow temperature, firmware versions, or water pressure
- Custom services to set holiday mode or quick veto temperature overrides, and their duration
- Install HACS
- Search for the myVAILLANT integration in HACS and install it
- Restart Home Assistant
- Add myVaillant integration
- Sign in with the email & password you used in the myVAILLANT app (or MiGo app for Saunier Duval)
- Download the latest release
- Extract the
custom_componentsfolder to your Home Assistant's config folder, the resulting folder structure should beconfig/custom_components/mypyllant - Restart Home Assistant
- Add myVaillant integration, or go to Settings > Integrations and add myVAILLANT
- Sign in with the email & password you used in the myVAILLANT app (or MiGo app for Saunier Duval & Bulex)
Wait interval between updating (most) sensors. Don't set this too low, for example 10 leads to quota exceeded errors and a temporary ban.
The energy data and efficiency sensors have a fixed hourly interval.
How long to wait between making a request (i.e. setting target temperature) and refreshing data. The Vaillant takes some time to return the updated values.
When setting the temperature with the climate controls, the integration uses the "quick veto" feature of the myVAILLANT app.
With this option you can set for how long the temperature should stay set, before returning to the default value.
When raising or lowering the desired temperature in the myVAILLANT app, it sets a quick veto mode for a limited time with that new temperature, if the zone is in time controlled mode. If you want to permanently change the desired temperature, you need to update the time schedule.
By default, this integration has the same behavior. But when enabling this option, the Home Assistant climate controls instead overwrite the temperatures set in the time schedule with the new value (unless quick veto is already active).
The country you registered your myVAILLANT account in. The list of options is limited to known supported countries.
If a country is missing, please open an issue.
Brand of your HVAC equipment and app, pick Saunier Duval if you use the MiGo Link app.
Your HVAC system might differ from the ones in Tested on above.
If you don't see any entities, or get an error during setup, please check Debugging below and create an issue.
With debugging enabled, there's a chance to find the culprit in the data returned by the myVAILLANT API and fix it.
You can expect these entities, although names may vary based on your installed devices (in this example "aroTHERM plus" and "Hydraulic Station") or the naming of your heating zones (in this case "Zone 1"):
| Entity | Unit | Class | Sample |
|---|---|---|---|
| Outdoor Temperature | °C | temperature | 16.7 |
| System Water Pressure | bar | pressure | 1.0 |
| My Home VR 921 | 0357.40.30 | ||
| Desired Temperature in Zone 1 | °C | temperature | 5.0 |
| Current Temperature in Zone 1 | °C | temperature | 20.9 |
| Humidity in Zone 1 | % | humidity | 60.0 |
| Heating Operating Mode in Zone 1 | Off | ||
| Heating State in Zone 1 | Idle | ||
| Current Special Function in Zone 1 | None | ||
| State in Circuit 0 | STANDBY | ||
| Current Flow Temperature in Circuit 0 | °C | temperature | 35.5 |
| Heating Curve in Circuit 0 | 0.68 | ||
| Tank Temperature Domestic Hot Water 255 | °C | temperature | 48.5 |
| Setpoint Domestic Hot Water 255 | °C | temperature | 50.0 |
| Operation Mode Domestic Hot Water 255 | Time Controlled | ||
| Current Special Function Domestic Hot Water 255 | Regular | ||
| Heating Energy Efficiency | 3.0 | ||
| aroTHERM plus Consumed Electrical Energy Domestic Hot Water | Wh | energy | 2000.0 |
| aroTHERM plus Consumed Electrical Energy Heating | Wh | energy | 1000.0 |
| aroTHERM plus Earned Environment Energy Domestic Hot Water | Wh | energy | 6000.0 |
| aroTHERM plus Earned Environment Energy Heating | Wh | energy | 0.0 |
| aroTHERM plus Heat Generated Heating | Wh | energy | 1000.0 |
| aroTHERM plus Heat Generated Domestic Hot Water | Wh | energy | 8000.0 |
| hydraulic station Consumed Electrical Energy Domestic Hot Water | Wh | energy | 0.0 |
| hydraulic station Consumed Electrical Energy Heating | Wh | energy | 0.0 |
| Domestic Hot Water 0 | Time Controlled | ||
| Zone 1 | off | ||
| Trouble Codes on aroTHERM plus | problem | off | |
| Online Status aroTHERM plus | connectivity | on | |
| Firmware Update Required My Home VR 921 | update | off | |
| Firmware Update Enabled My Home VR 921 | on | ||
| Cooling Allowed in Circuit 0 | off |
There are custom services to control holiday mode and quick veto temperatures for each climate zone. Search for "myvaillant" in Developer Tools > Services in your Home Assistant instance to get the full list plus an interactive UI.
When debugging or reporting issues, turn on debug logging by adding this to your configuration.yaml
and restarting Home Assistant:
logger:
default: warning
logs:
custom_components.mypyllant: debug
myPyllant: debug