From 81cfdec0ce022b37754542c92431407b8d442f14 Mon Sep 17 00:00:00 2001 From: Evgeny Date: Fri, 12 Jun 2020 04:17:48 +0200 Subject: [PATCH] AQI calculator for HM3301 (#535) * AQI calculator for HM3301 * Update components/sensor/hm3301.rst Co-authored-by: Guillermo Ruffino * Update hm3301.rst * pm1.0 not required * format to look consistent with dht11 Co-authored-by: Guillermo Ruffino --- components/sensor/hm3301.rst | 49 +++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git a/components/sensor/hm3301.rst b/components/sensor/hm3301.rst index a77b36f78..01710a02f 100644 --- a/components/sensor/hm3301.rst +++ b/components/sensor/hm3301.rst @@ -24,16 +24,59 @@ The sensor communicate with board by ``I2C`` protocol, and requires 3.3v. name: "PM2.5" pm_10_0: name: "PM10.0" + aqi: + name: "AQI" + type: "CAQI" Configuration variables: ------------------------ - **pm_1_0** (*Optional*): Use the concentration of particulates of size less than 1.0µm in µg per cubic meter. - All options from :ref:`Sensor `. + + - **name** (**Required**, string): The name for the temperature sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + - **pm_2_5** (*Optional*): Use the concentration of particulates of size less than 2.5µm in µg per cubic meter. - All options from :ref:`Sensor `. + + - **name** (**Required**, string): The name for the temperature sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + - **pm_10_0** (*Optional*): Use the concentration of particulates of size less than 10.0µm in µg per cubic meter. - All options from :ref:`Sensor `. + + - **name** (**Required**, string): The name for the temperature sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **aqi** (*Optional*): AQI sensor. Requires the ``pm_2_5`` and ``pm_10_0`` sensors defined. See below. + + - **type** (**Required**): One of: ``AQI`` or ``CAQI``. + - **name** (**Required**, string): The name for the temperature sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +Air Quality Sensor: +------------------- + +There is a sensor which calculates quality of air based on PM 2.5 and PM 10.0 values. +There are two implementations: + +- AQI: USA air quality standard +- CAQI: Europe air quality standard + +.. code-block:: yaml + + sensor: + - platform: hm3301 + pm_2_5: + name: "PM2.5" + pm_10_0: + name: "PM10.0" + aqi: + name: "AQI" + type: "CAQI" + See Also --------