myPyllant 0.0.16

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

pip install myPyllant
python3 -m myPyllant.export user password
# See python3 -m myPyllant.export -h for more options

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 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")


async def main(user, password):
    async with MyPyllantAPI(user, password) as api:
        async for system in api.get_systems():
            print(await api.set_holiday(system, datetime.now()))
            print(
                await api.set_holiday(
                    system, datetime.now(), datetime.now() + timedelta(days=1)
                )
            )
            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))

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
• Tested on a Vaillant aroTHERM plus heatpump with sensoCOMFORT VRC 720 and sensoNET VR 921
• I'm happy to accept PRs, if you can test them yourself
• Setting weekly time tables for heating and domestic hot water is still missing

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

Running Tests

Replace username and password with your myVAILLANT login credentials. This is necessary to generate test data for running integration tests.

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
python3 tests/generate_test_data.py username password
pytest