ym88659208ym87991671
Device hvac_heater | Documentation for developers
Skip to main content

hvac_heater

Last updated on August 26, 2022

Heater.

Available device functions

The device can have all the functions listed below or some of them. E.g. if the heater cannot manage the fan speed, there is no need in including the hvac_air_flow_power function in its model description.

The device has two mandatory functions: online, on_off. All heaters must have them.

FunctionMandatory?Description
hvac_air_flow_powerFan speed
hvac_temp_setDesired temperature
hvac_thermostat_modeThermostat operation mode
on_off✔︎Turning the device on and off remotely
online✔︎Device availability: offline or online
temperatureCurrent temperature

Heater model description example

The model shall be described in accordance with the model structure. The example describes a heater equipped with all functions.

Allowed values for the hvac_air_flow_power function (fan speed) of the model are changed: the quiet mode speed is not supported by the model and therefore deleted.

{
"id": "QWERTY124",
"manufacturer": "Xiaqara",
"model": "SM1123456789",
"hw_version": "3.1",
"sw_version": "5.6",
"description": "Xiaqara smart heater",
"category": "hvac_heater",
"features": [
"hvac_air_flow_power",
"hvac_temp_set",
"hvac_thermostat_mode",
"on_off",
"online",
"temperature"
],
"allowed_values": {
"hvac_air_flow_power": {
"type": "ENUM",
"enum_values": {
"values": [
"auto",
"high",
"low",
"medium",
"turbo"
]
}
}
}
}

User's heater description example

The device shall be describe in accordance with the device structure. The example contains no heater model description as we believe that models are described independently and the model ID will be enough (in this case, QWERTY124).

{
"id": "ABCD_004",
"name": "My heater",
"default_name": "Smart heater",
"nicknames": ["Air heater", "Manageable heater"],
"home": "My home",
"room": "Living room",
"groups": ["Climate", "Heating"],
"model_id": "QWERTY124",
"hw_version": "3.1",
"sw_version": "5.6"
}