myPyllant 0.1.6

A Python library to interact with the API behind the myVAILLANT app

myPyllant

A Python library to interact with the API behind the myVAILLANT app, needs at least Python 3.10.

Not affiliated with Vaillant, the developers take no responsibility for anything that happens to your Vaillant devices because of this library.

Install and Test

Warning

You need at least Python 3.10

pip install myPyllant
python3 -m myPyllant.export user password country
# See python3 -m myPyllant.export -h for more options and a list of countries

The --data argument exports historical data of the devices in your system. Without this keyword, information about your system will be exported as JSON.

Usage

import argparse
import asyncio
from datetime import datetime, timedelta

from custom_components.mypyllant.const import COUNTRIES

from myPyllant.api import MyPyllantAPI

parser = argparse.ArgumentParser(description="Export data from myVaillant API   .")
parser.add_argument("user", help="Username (email address) for the myVaillant app")
parser.add_argument("password", help="Password for the myVaillant app")
parser.add_argument(
    "country",
    help="Country your account is registered in, i.e. 'germany'",
    choices=COUNTRIES.keys(),
)


async def main(user, password, country):
    async with MyPyllantAPI(user, password, country) as api:
        async for system in api.get_systems():
            print(await api.set_holiday(system, datetime.now()))
            print(
                await (
                    await api.set_holiday(
                        system, datetime.now(), datetime.now() + timedelta(days=1)
                    )
                ).json()
            )
            print(await api.cancel_holiday(system))
            print(await api.boost_domestic_hot_water(system.domestic_hot_water[0]))
            print(await api.cancel_hot_water_boost(system.domestic_hot_water[0]))
            print(
                await api.set_domestic_hot_water_temperature(
                    system.domestic_hot_water[0], 46
                )
            )
            print(await api.set_set_back_temperature(system.zones[0], 15.5))
            print(await api.quick_veto_zone_temperature(system.zones[0], 21, 5))
            print(await api.cancel_quick_veto_zone_temperature(system.zones[0]))


if __name__ == "__main__":
    args = parser.parse_args()
    asyncio.run(main(args.user, args.password, args.country))

Tested Configurations

• Vaillant aroTHERM plus heatpump, sensoCOMFORT VRC 720, sensoNET VR 921
• VMW 23CS/1-5 C (N-ES) ecoTEC plus

Contributing

Warning

You need at least Python 3.10

I'm happy to accept PRs, if you run the pre-commit checks and test your changes:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
pre-commit install
pytest

Supporting new Countries

The myVAILLANT app uses Keycloak and OIDC for authentication, with a realm for each country. There is a script to check which countries are supported:

python3 tests/find_countries.py

Copy the resulting dictionary into src/myPyllant/const.py

Contributing Test Data

Because the myVAILLANT API isn't documented, you can help the development of this library by contributing test data:

python3 tests/generate_test_data.py username password country

Create a fork of this repository and create a PR with the newly created folder in test/json.

Notes

• Auth is loosely based on https://github.com/TA2k/ioBroker.vaillant
• Most API endpoints are reverse-engineered from the myVaillant app, using https://github.com/mitmproxy/mitmproxy
• Setting weekly time tables for heating and domestic hot water is still missing
• There is a home assistant component based on this library here: https://github.com/signalkraft/mypyllant-component

Logo based on Hase Icons erstellt von Freepik - Flaticon & Ouroboros Icons erstellt von Freepik - Flaticon.