sensor_air

Last updated on June 23, 2026

Air quality sensor.

Available device functions

The device can have all the functions listed below or some of them. E.g. if the sensor cannot report the battery charge level, there is no need in including the battery_percentage function in its model description.

The sensor has a mandatory online function. Besides, at least one of the listed functions must be described: temperature, humidity, co2, pm1_0, pm2_5, pm10, tvoc_float, hcho_float.

Function	Mandatory?	Description
battery_low_power		Battery low or not
battery_percentage		Batter charge level
online	✔︎	Device availability: offline or online
signal_strength		Signal strength
temp_unit_view		Temperature scale displayed on the sensor screen: C or F. Use it only for sensors with a screen, capable of displaying temperature according to several temperature scales
temperature	✔︎*	Current temperature
humidity	✔︎*	Current humidity
co2	✔︎*	Current CO2 level
pm1_0	✔︎*	Current concentration of the particles PM1.0
pm2_5	✔︎*	Current concentration of the particles PM2.5
pm10	✔︎*	Current concentration of the particles PM10
tvoc_float	✔︎*	Current concentration of all volatile organic compounds (TVOC)
hcho_float	✔︎*	Current formaldehyde concentration (HCHO)

Air quality sensor model description example

The model shall be described in accordance with the model structure. The example describes an air quality sensor that can report temperature, humidity, CO₂ level, concentration of particles PM1.0, PM2.5, PM10, total concentration of volatile organic compounds and formaldehyde concentration. The sensor also reports signal strength, battery charge level and whether the battery is low.

{
   "id": "QWERTY124",
   "manufacturer": "Xiaqara",
   "model": "SM1123456789",
   "hw_version": "3.1",
   "sw_version": "5.6",
   "description": "Xiaqara smart air quality sensor",
   "category": "sensor_air",
   "features": [
      "battery_low_power",
      "battery_percentage",
      "online",
      "signal_strength",
      "co2",
      "humidity",
      "temp_unit_view",
      "temperature",
      "pm1_0",
      "pm2_5",
      "pm10",
      "hcho_float",
      "tvoc_float"
   ]
}

Air quality sensor description example

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

For the sensor, parent_id is indicated – a hub ID through which the sensor is connected to the Smart Home.

{
    "id": "ABCD_004",
    "parent_id": "A_002",
    "name": "My air quality sensor",
    "default_name": "Smart air quality sensor",
    "home": "My home",
    "room": "Bedroom",
    "model_id": "QWERTY124",
    "hw_version": "3.1",
    "sw_version": "5.6",
    "partner_meta": {
        "internal-id": 1234,
        "specificity": "microchip 2A"
    },
}