hvac_air_purifier
Air cleaner.
Available device functions
The device can have all the functions listed below or some of them. E.g. if an air purifier cannot aromatize the air in the room, there is no need in including the hvac_aromatization
function in its model description.
The device has two mandatory functions: online
, on_off
. All air purifiers must have them.
Function | Mandatory? | Description |
hvac_air_flow_power | Fan speed | |
hvac_aromatization | Air aroma mode | |
hvac_decontaminate | Air sanitation mode | |
hvac_ionization | Ionization mode | |
hvac_night_mode | Night mode | |
hvac_replace_filter | Need to replace filter | |
hvac_replace_ionizator | Need to replace ionizer | |
on_off | ✔︎ | Turning the device on and off remotely |
online | ✔︎ | Device availability: offline or online |
Air purifier model description example
The model shall be described in accordance with the model structure. The example describes an air purifier equipped with all functions except for the decontamination mode.
Besides, allowed values for the hvac_air_flow_power
function (fan speed) of the model are changed: the quiet
mode 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 Air Purifier",
"category": "hvac_air_purifier",
"features": [
"hvac_air_flow_power",
"hvac_aromatization",
"hvac_ionization",
"hvac_night_mode",
"hvac_replace_filter",
"hvac_replace_ionizator",
"on_off",
"online"
],
"allowed_values": {
"hvac_air_flow_power": {
"type": "ENUM",
"enum_values": {
"values": [
"auto",
"high",
"low",
"medium",
"turbo"
]
}
}
}
}
User's air purifier description example
The device shall be describe in accordance with the device structure. The example contains no air purifier 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 air purifier",
"default_name": "Smart air purifier",
"nicknames": ["Smart air cleaner", "Manageable air purifier"],
"home": "My home",
"room": "Living room",
"groups": ["Climate", "Cleaning"],
"model_id": "QWERTY124",
"hw_version": "3.1",
"sw_version": "5.6",
"partner_meta": {
"internal-id": 1234,
"specificity": "microchip 2A"
},
}