Skip to content

Services

There are custom services for almost every functionality of the myVAILLANT app:

Name Description Target Fields
Set quick veto Sets quick veto temperature with optional duration climate Temperature, Duration
Set manual mode setpoint Sets temperature for manual mode climate Temperature, Type
Cancel quick veto Cancels quick veto temperature and returns to normal schedule / manual setpoint climate
Set holiday Set holiday / away mode with start / end or duration climate Start Date, End Date, Duration, Setpoint
Cancel Holiday Cancel holiday / away mode climate
Set Time Program Updates the time program for a zone or room climate Type, Time Program
Set Zone Time Program (deprecated) Deprecated, use "Set Time Program" instead climate Type, Time Program
Set Zone Operating mode Same as setting HVAC mode, but allows setting heating or cooling climate Operating Mode, Operating Type
Set Water Heater Time Program Updates the time program for a water heater water_heater Time Program
Set Water Heater Circulation Time Program Updates the time program for the circulation pump of a water heater water_heater Time Program
Export Data Exports data from the mypyllant library Data, Data Resolution, Start Date, End Date
Generate Test Data Generates test data for the mypyllant library and returns it as YAML
Export Yearly Energy Reports Exports energy reports in CSV format per year Year

Additionally, there are home assistant's built in services for climate controls, water heaters, and switches.

Search for "myvaillant" in Developer Tools Services in your Home Assistant instance to get the full list plus an interactive UI.

Services Screenshot

Open your Home Assistant instance and show your service developer tools with a specific service selected.

Exporting Data

Setting a Time Program

The following services can be used to set time programs:

You can look up your current time programs in the developer states view under attributes for your zones and water heater.

Times in the time program are given in minutes since midnight in UTC.

You can also use the calendar UI to change time programs.

Disabling a time window

You can delete all time windows on a day by sending an empty list, for example monday: [].

service: mypyllant.set_time_program
data:
  program_type: heating
  time_program:
    monday:
      - start_time: 420
        end_time: 1290
        setpoint: 20
    tuesday:
      - start_time: 420
        end_time: 1290
        setpoint: 20
    wednesday:
      - start_time: 420
        end_time: 1290
        setpoint: 20
    thursday:
      - start_time: 420
        end_time: 1290
        setpoint: 20
    friday:
      - start_time: 420
        end_time: 1290
        setpoint: 20
    saturday:
      - start_time: 420
        end_time: 1290
        setpoint: 20
    sunday:
      - start_time: 420
        end_time: 1290
        setpoint: 20
target:
  entity_id: climate.home_zone_1_circuit_0_climate
service: mypyllant.set_time_program
data:
  time_program:
    monday:
      - startTime: 0
        temperatureSetpoint: 20
      - startTime: 360
        temperatureSetpoint: 19
      - startTime: 1260
        temperatureSetpoint: 20
    tuesday:
      - startTime: 0
        temperatureSetpoint: 20
      - startTime: 360
        temperatureSetpoint: 19
      - startTime: 1260
        temperatureSetpoint: 20
    wednesday:
      - startTime: 0
        temperatureSetpoint: 20
      - startTime: 360
        temperatureSetpoint: 19
      - startTime: 1260
        temperatureSetpoint: 20
    thursday:
      - startTime: 0
        temperatureSetpoint: 20
      - startTime: 360
        temperatureSetpoint: 19
      - startTime: 1260
        temperatureSetpoint: 20
    friday:
      - startTime: 0
        temperatureSetpoint: 20
      - startTime: 360
        temperatureSetpoint: 19
      - startTime: 1260
        temperatureSetpoint: 20
    saturday:
      - startTime: 0
        temperatureSetpoint: 20
      - startTime: 360
        temperatureSetpoint: 19
      - startTime: 1260
        temperatureSetpoint: 20
    sunday:
      - startTime: 0
        temperatureSetpoint: 20
      - startTime: 360
        temperatureSetpoint: 19
      - startTime: 1260
        temperatureSetpoint: 20
target:
  entity_id: climate.home_room_1_climate
service: mypyllant.set_dhw_time_program
data:
  time_program:
    monday:
      - start_time: 420
        end_time: 1290
    tuesday:
      - start_time: 420
        end_time: 1290
    wednesday:
      - start_time: 420
        end_time: 1290
    thursday:
      - start_time: 420
        end_time: 1290
    friday:
      - start_time: 420
        end_time: 1290
    saturday:
      - start_time: 420
        end_time: 1290
    sunday:
      - start_time: 420
        end_time: 1290
target:
  entity_id: water_heater.home_domestic_hot_water_0
service: mypyllant.set_dhw_circulation_time_program
data:
  time_program:
    monday:
      - start_time: 420
        end_time: 1290
    tuesday:
      - start_time: 420
        end_time: 1290
    wednesday:
      - start_time: 420
        end_time: 1290
    thursday:
      - start_time: 420
        end_time: 1290
    friday:
      - start_time: 420
        end_time: 1290
    saturday:
      - start_time: 420
        end_time: 1290
    sunday:
      - start_time: 420
        end_time: 1290
target:
  entity_id: water_heater.home_domestic_hot_water_0