Important changes in the Viessmann API IoT features

[MichaelHanna]

We have an important update regarding the Viessmann API, specifically concerning a change to some of our IoT features. 

Starting from 2024-09-15, we will be changing the IoT features for several device types and migrating to the new naming nomenclature. This change will require you to update your existing API integration to ensure uninterrupted access to the relevant data.

These are the changes for each device type

Buffer storage tank:

• heating.buffer.charging.level.bottom → heating.bufferCylinder.charging.level.bottom
• heating.buffer.charging.level.middle → heating.bufferCylinder.charging.level.middle
• heating.buffer.charging.level.top → heating.bufferCylinder.charging.level.top
• heating.buffer.charging.level.total → heating.bufferCylinder.charging.level.total
• heating.buffer.sensors.temperature.main → heating.bufferCylinder.sensors.temperature.main
• heating.buffer.sensors.temperature.top → heating.bufferCylinder.sensors.temperature.top

Heating:

• heating.circuits.N.operating.programs.summerEco → heating.circuits.N.operating.programs.reducedEnergySaving
• heating.co2.saving → heating.co2.saving.raw

Domestic hot water (DHW):

• heating.dhw.comfort → heating.dhw.operating.modes.active
• heating.dhw.sensors.temperature.hotWaterStorage.bottom → heating.dhw.sensors.temperature.dhwCylinder.bottom
• heating.dhw.sensors.temperature.hotWaterStorage.midBottom → heating.dhw.sensors.temperature.dhwCylinder.midBottom
• heating.dhw.sensors.temperature.hotWaterStorage.middle → heating.dhw.sensors.temperature.dhwCylinder.middle
• heating.dhw.sensors.temperature.hotWaterStorage.top → heating.dhw.sensors.temperature.dhwCylinder.top
• heating.dhw.sensors.temperature.hotWaterStorage → heating.dhw.sensors.temperature.dhwCylinder

Fuel cell:

• heating.fuelCell.operating.modes.active → fuelCell.operating.modes.active
• heating.fuelCell.operating.modes.chimneySweeperMode → fuelCell.operating.modes.chimneySweeperMode
• heating.fuelCell.operating.modes.ecological → fuelCell.operating.modes.ecological
• heating.fuelCell.operating.modes.economical → fuelCell.operating.modes.economical
• heating.fuelCell.operating.modes.energyControlled → fuelCell.operating.modes.energyControlled
• heating.fuelCell.operating.modes.heatControlled → fuelCell.operating.modes.heatControlled
• heating.fuelCell.operating.modes.holidayWithFuelCellOff → fuelCell.operating.modes.holidayWithFuelCellOff
• heating.fuelCell.operating.modes.holidayWithFuelCellOn → fuelCell.operating.modes.holidayWithFuelCellOn
• heating.fuelCell.operating.modes.maintenance → fuelCell.operating.modes.maintenance
• heating.fuelCell.operating.modes.party → fuelCell.operating.modes.party
• heating.fuelCell.operating.modes.standby → fuelCell.operating.modes.standby
• heating.fuelCell.operating.phase → fuelCell.operating.phase
• heating.fuelCell.power.production → fuelCell.power.production
• heating.fuelCell.sensors.temperature.return → fuelCell.sensors.temperature.return
• heating.fuelCell.sensors.temperature.supply → fuelCell.sensors.temperature.supply
• heating.fuelCell.statistics → fuelCell.statistics

Heat pump:

• heating.scop.dhw → heating.spf.dhw
• heating.scop.heating → heating.spf.heating
• heating.scop.total → heating.spf.total

Ventilation:

• ventilation.operating.programs.comfort → ventilation.quickmodes.comfort
• ventilation.operating.programs.eco → ventilation.quickmodes.eco
• ventilation.operating.programs.forcedLevelFour → ventilation.quickmodes.forcedLevelFour
• ventilation.operating.programs.holiday → ventilation.quickmodes.holiday
• ventilation.operating.programs.levelFour → ventilation.levels.levelFour
• ventilation.operating.programs.levelOne → ventilation.levels.levelOne
• ventilation.operating.programs.levelThree → ventilation.levels.levelThree
• ventilation.operating.programs.levelTwo → ventilation.levels.levelTwo
• ventilation.operating.programs.silent → ventilation.quickmodes.silent

Migration Date

• Starting 2024-09-15: You must update your integration to utilize the new endpoints.

Action Required

To ensure, you will not get any problems in your applications, please check and if necessary update your code and integrate the new IoT features before 2024-09-15. The renamed IoT features are already available via API.

Our support team will be happy to help you with any problems during the migration process.

Thank you for your understanding towards the changes and have fun and success with our updated API.