hvac_fan
Fan.
Available device functions
The device can have all the functions listed below or some of them. E.g. if the fan direction cannot be changed, there is no need in including the hvac_direction_set function in its model description.
The device has two mandatory functions: online, on_off. All fans must have them.
| Function | Mandatory? | Description |
| hvac_air_flow_power | Fan speed | |
| hvac_direction_set | Fan direction | |
| on_off | ✔︎ | Turning the device on and off remotely |
| online | ✔︎ | Device availability: offline or online |
Fan model description example
The model shall be described in accordance with the model structure. The example describes a fan equipped with all functions except for managing the air flow direction.
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 fan",
"category": "hvac_fan",
"features": [
"hvac_air_flow_power",
"on_off",
"online"
],
"allowed_values": {
"hvac_air_flow_power": {
"type": "ENUM",
"enum_values": {
"values": [
"auto",
"high",
"low",
"medium",
"turbo"
]
}
}
}
}
User's fan description example
The device shall be describe in accordance with the device structure. The example contains no fan 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 fan",
"default_name": "Smart fan",
"nicknames": ["Controlled fan", "Manageable fan"],
"home": "My home",
"room": "Living room",
"groups": ["Climate", "Cooling"],
"model_id": "QWERTY124",
"hw_version": "3.1",
"sw_version": "5.6",
"partner_meta": {
"internal-id": 1234,
"specificity": "microchip 2A"
},
}