hvac_humidifier

Last updated on May 25, 2023

Air humudifier.

Available device functions

The device can have all the functions listed below or some of them. E.g. if the air humidifier cannot track the water level in the water tank in liters, there is no need in including the hvac_water_level function in its model description.

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

Function	Mandatory?	Description
humidity		Current humidity
hvac_air_flow_power		Fan speed
hvac_humidity_set		Desired air humidity
hvac_ionization		Ionization mode
hvac_night_mode		Night mode
hvac_replace_filter		Need to replace filter
hvac_replace_ionizator		Need to replace ionizer
hvac_water_level		Tank water amount, in liters
hvac_water_low_level		Whether the water tank has run out of water
hvac_water_percentage		Tank water amount, in percent
on_off	✔︎	Turning the device on and off remotely
online	✔︎	Device availability: offline or online

Air humidifier model description example

The model shall be described in accordance with the model structure. The example describes an air humidifier equipped with all functions except for tracking the water level in the water tank in liters.

Besides, 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 air humidifier",
   "category": "hvac_humidifier",
   "features": [
      "humidity",
      "hvac_air_flow_power",
      "hvac_humidity_set",
      "hvac_ionization",
      "hvac_night_mode",
      "hvac_replace_filter",
      "hvac_replace_ionizator",
      "hvac_water_low_level",
      "hvac_water_percentage",
      "on_off",
      "online"
   ],
   "allowed_values": {
      "hvac_air_flow_power": {
         "type": "ENUM",
         "enum_values": {
            "values": [
               "auto",
               "high",
               "low",
               "medium",
               "turbo"
            ]
         }
      }
   }
}

User's air humidifier description example

The device shall be describe in accordance with the device structure. The example contains no air humidifier 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 humidifier",
   "default_name": "Smart air humidifier",
   "nicknames": ["Clever air humidifier", "Manageable air humidifier"],
   "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"
    },
}