Skip to content

Commit 1200fd1

Browse files
Add docs for Grove Multichannel Gas Sensor V2 (#2598)
Co-authored-by: Jesse Hills <[email protected]>
1 parent f5dd73d commit 1200fd1

File tree

3 files changed

+86
-0
lines changed

3 files changed

+86
-0
lines changed

components/sensor/grove_gas_mc_v2.rst

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
Grove Multichannel Gas Sensor V2
2+
================================================
3+
4+
.. seo::
5+
:description: Instructions for setting up Grove Multichannel Gas Sensor V2 that
6+
can measure Nitrogen Dioxide, Carbon Monoxide, Ethanol and Volatile Organic
7+
Compounds.
8+
:image: grove-gas-mc-v2.png
9+
:keywords: Grove, gm102b, gm302b, gm502b, gm702b
10+
11+
The ``grove_gas_mc_v2`` sensor platform allows you to use your `Grove Multichannel Gas
12+
Sensor V2 <https://wiki.seeedstudio.com/Grove-Multichannel-Gas-Sensor-V2>`__
13+
with ESPHome. It exposes 4 different gas sensors for qualitatively measuring
14+
Nitrogen Dioxide (NO2), Carbon Monoxide (CO), Ethanol (C2H5OH), and Volatile Organic
15+
Compounds (VOCs).
16+
17+
.. note::
18+
19+
The Grove Multichannel Gas Sensor V2 is a qualitative, not quantitative, sensor.
20+
This means values reported back are raw ADC values. Values are **not** in a common unit
21+
of measurement, such as PPM (parts per million). If you have known baseline readings
22+
for any of the gases, :ref:`sensor-filters` could be used to calibrate the raw readings.
23+
24+
.. figure:: /images/grove-gas-mc-v2.png
25+
:align: center
26+
:width: 50.0%
27+
28+
Grove Multichannel Gas Sensor V2
29+
30+
The communication with this sensor is done via :ref:`I²C Bus <i2c>`, so you need to have
31+
an ``i2c:`` section in your config for this integration to work.
32+
33+
.. code-block:: yaml
34+
35+
sensor:
36+
- platform: grove_gas_mc_v2
37+
no2:
38+
name: "Nitrogen Dioxide"
39+
ethanol:
40+
name: "Ethanol"
41+
carbon_monoxide:
42+
name: "Carbon Monoxide"
43+
tvoc:
44+
name: "Volatile Organic Compounds"
45+
46+
Configuration variables:
47+
------------------------
48+
49+
- **no2** (**Required**): The Nitrogen Dioxide sensor data.
50+
All options from :ref:`Sensor <config-sensor>`.
51+
- **ethanol** (**Required**): The Ethanol (C2H5OH) sensor data.
52+
All options from :ref:`Sensor <config-sensor>`.
53+
- **carbon_monoxide** (**Required**): The Carbon Monoxide sensor data.
54+
All options from :ref:`Sensor <config-sensor>`.
55+
- **tvoc** (**Required**): The Total Volatile Organic Compounds (TVOC) sensor data.
56+
All options from :ref:`Sensor <config-sensor>`.
57+
58+
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
59+
sensor. Defaults to ``60s``.
60+
61+
Advanced:
62+
63+
- **address** (*Optional*, int): The :ref:`I²C <i2c>` address of the sensor.
64+
Defaults to ``0x08``
65+
66+
.. _grove-gas-mc-v2-preheating:
67+
68+
Preheating
69+
--------------------
70+
71+
If the sensor is stored for a long period of time (without power) there is a recommended
72+
minimum warm-up time required for the sensor before the readings settle down and become
73+
more accurate.
74+
75+
A recommended warm-up time of 24 hours is recommend if the sensor has been stored
76+
less than a month, 48 hours for 1-6 months and at least 72 hours for anything longer
77+
than 6 months.
78+
79+
See Also
80+
--------
81+
82+
- :ref:`sensor-filters`
83+
- `Grove Multichannel V2 Library <https://github.com/Seeed-Studio/Seeed_Arduino_MultiGas>`__
84+
- :apiref:`grove_gas_mc_v2/grove_gas_mc_v2.h`
85+
- :ghedit:`Edit`

images/grove-gas-mc-v2.png

18.8 KB
Loading

index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@ Air Quality
321321
ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality
322322
GCJA5, components/sensor/gcja5, gcja5.svg, Particulate
323323
GP2Y1010AU0F, components/sensor/gp2y1010au0f, gp2y1010au0f.png, Particulate
324+
Grove Multichannel Gas V2, components/sensor/grove_gas_mc_v2, grove-gas-mc-v2.png, NO2 & CO & Ethanol & Volatile organics
324325
HM3301, components/sensor/hm3301, hm3301.jpg, Particulate
325326
iAQ-Core, components/sensor/iaqcore, iaqcore.jpg, CO2 & Volatile organics
326327
MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature

0 commit comments

Comments
 (0)