diff --git a/components/sensor/grove_gas_mc_v2.rst b/components/sensor/grove_gas_mc_v2.rst new file mode 100644 index 000000000..1230af43b --- /dev/null +++ b/components/sensor/grove_gas_mc_v2.rst @@ -0,0 +1,85 @@ +Grove Multichannel Gas Sensor V2 +================================================ + +.. seo:: + :description: Instructions for setting up Grove Multichannel Gas Sensor V2 that + can measure Nitrogen Dioxide, Carbon Monoxide, Ethanol and Volatile Organic + Compounds. + :image: grove-gas-mc-v2.png + :keywords: Grove, gm102b, gm302b, gm502b, gm702b + +The ``grove_gas_mc_v2`` sensor platform allows you to use your `Grove Multichannel Gas +Sensor V2 `__ +with ESPHome. It exposes 4 different gas sensors for qualitatively measuring +Nitrogen Dioxide (NO2), Carbon Monoxide (CO), Ethanol (C2H5OH), and Volatile Organic +Compounds (VOCs). + +.. note:: + + The Grove Multichannel Gas Sensor V2 is a qualitative, not quantitative, sensor. + This means values reported back are raw ADC values. Values are **not** in a common unit + of measurement, such as PPM (parts per million). If you have known baseline readings + for any of the gases, :ref:`sensor-filters` could be used to calibrate the raw readings. + +.. figure:: /images/grove-gas-mc-v2.png + :align: center + :width: 50.0% + + Grove Multichannel Gas Sensor V2 + +The communication with this sensor is done via :ref:`I²C Bus `, so you need to have +an ``i2c:`` section in your config for this integration to work. + +.. code-block:: yaml + + sensor: + - platform: grove_gas_mc_v2 + no2: + name: "Nitrogen Dioxide" + ethanol: + name: "Ethanol" + carbon_monoxide: + name: "Carbon Monoxide" + tvoc: + name: "Volatile Organic Compounds" + +Configuration variables: +------------------------ + +- **no2** (**Required**): The Nitrogen Dioxide sensor data. + All options from :ref:`Sensor `. +- **ethanol** (**Required**): The Ethanol (C2H5OH) sensor data. + All options from :ref:`Sensor `. +- **carbon_monoxide** (**Required**): The Carbon Monoxide sensor data. + All options from :ref:`Sensor `. +- **tvoc** (**Required**): The Total Volatile Organic Compounds (TVOC) sensor data. + All options from :ref:`Sensor `. + +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the + sensor. Defaults to ``60s``. + +Advanced: + +- **address** (*Optional*, int): The :ref:`I²C ` address of the sensor. + Defaults to ``0x08`` + +.. _grove-gas-mc-v2-preheating: + +Preheating +-------------------- + +If the sensor is stored for a long period of time (without power) there is a recommended +minimum warm-up time required for the sensor before the readings settle down and become +more accurate. + +A recommended warm-up time of 24 hours is recommend if the sensor has been stored +less than a month, 48 hours for 1-6 months and at least 72 hours for anything longer +than 6 months. + +See Also +-------- + +- :ref:`sensor-filters` +- `Grove Multichannel V2 Library `__ +- :apiref:`grove_gas_mc_v2/grove_gas_mc_v2.h` +- :ghedit:`Edit` diff --git a/images/grove-gas-mc-v2.png b/images/grove-gas-mc-v2.png new file mode 100644 index 000000000..88a7f5a24 Binary files /dev/null and b/images/grove-gas-mc-v2.png differ diff --git a/index.rst b/index.rst index 2ba386cae..06c5b1b01 100644 --- a/index.rst +++ b/index.rst @@ -321,6 +321,7 @@ Air Quality ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality GCJA5, components/sensor/gcja5, gcja5.svg, Particulate GP2Y1010AU0F, components/sensor/gp2y1010au0f, gp2y1010au0f.png, Particulate + Grove Multichannel Gas V2, components/sensor/grove_gas_mc_v2, grove-gas-mc-v2.png, NO2 & CO & Ethanol & Volatile organics HM3301, components/sensor/hm3301, hm3301.jpg, Particulate iAQ-Core, components/sensor/iaqcore, iaqcore.jpg, CO2 & Volatile organics MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature