Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for Grove Multichannel Gas Sensor V2 #2598

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions components/sensor/grove_gas_mc_v2.rst
Original file line number Diff line number Diff line change
@@ -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 <https://wiki.seeedstudio.com/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 <i2c>`, 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 <config-sensor>`.
- **ethanol** (**Required**): The Ethanol (C2H5OH) sensor data.
All options from :ref:`Sensor <config-sensor>`.
- **carbon_monoxide** (**Required**): The Carbon Monoxide sensor data.
All options from :ref:`Sensor <config-sensor>`.
- **tvoc** (**Required**): The Total Volatile Organic Compounds (TVOC) sensor data.
All options from :ref:`Sensor <config-sensor>`.

- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.

Advanced:

- **address** (*Optional*, int): The :ref:`I²C <i2c>` 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 <https://github.com/Seeed-Studio/Seeed_Arduino_MultiGas>`__
- :apiref:`grove_gas_mc_v2/grove_gas_mc_v2.h`
- :ghedit:`Edit`
Binary file added images/grove-gas-mc-v2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down