2018-08-22 22:05:28 +02:00
|
|
|
MH-Z19 CO_2 and Temperature Sensor
|
|
|
|
==================================
|
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
.. seo::
|
|
|
|
:description: Instructions for setting up MH-Z19 CO2 and temperature sensors
|
|
|
|
:image: mhz19.jpg
|
|
|
|
:keywords: mh-z19
|
|
|
|
|
2018-08-22 22:05:28 +02:00
|
|
|
The ``mhz19`` sensor platform allows you to use MH-Z19 CO_2 and temperature sensors
|
2019-02-16 23:25:23 +01:00
|
|
|
(`refspace`_) with ESPHome.
|
2018-08-22 22:05:28 +02:00
|
|
|
|
|
|
|
.. figure:: images/mhz19-full.jpg
|
|
|
|
:align: center
|
|
|
|
:width: 50.0%
|
|
|
|
|
|
|
|
MH-Z19 CO_2 and Temperature Sensor.
|
|
|
|
|
|
|
|
.. _refspace: https://revspace.nl/MHZ19
|
|
|
|
|
|
|
|
As the communication with the MH-Z19 is done using UART, you need
|
|
|
|
to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the TX pin of the
|
|
|
|
MH-Z19 and the ``tx_pin`` connected to the RX Pin of the MH-Z19 (it's switched because the
|
|
|
|
TX/RX labels are from the perspective of the MH-Z19). Additionally, you need to set the baud rate to 9600.
|
|
|
|
|
2018-11-19 18:32:16 +01:00
|
|
|
.. code-block:: yaml
|
2018-08-22 22:05:28 +02:00
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
uart:
|
|
|
|
rx_pin: D0
|
|
|
|
tx_pin: D1
|
|
|
|
baud_rate: 9600
|
2018-08-24 22:44:01 +02:00
|
|
|
|
2018-08-22 22:05:28 +02:00
|
|
|
sensor:
|
|
|
|
- platform: mhz19
|
|
|
|
co2:
|
|
|
|
name: "MH-Z19 CO2 Value"
|
|
|
|
temperature:
|
|
|
|
name: "MH-Z19 Temperature"
|
2019-01-06 18:56:14 +01:00
|
|
|
update_interval: 60s
|
2018-08-22 22:05:28 +02:00
|
|
|
|
|
|
|
Configuration variables:
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
|
|
- **co2** (**Required**): The CO_2 data from the sensor in parts per million (ppm).
|
|
|
|
|
|
|
|
- **name** (**Required**, string): The name for the CO_2 sensor.
|
|
|
|
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
2019-02-17 12:28:17 +01:00
|
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
2018-08-22 22:05:28 +02:00
|
|
|
|
|
|
|
- **temperature** (**Required**): The information for the temperature sensor. Please note that this is
|
|
|
|
not officially documented in the datasheet and seems to be quite inaccurate.
|
|
|
|
|
|
|
|
- **name** (**Required**, string): The name for the temperature sensor.
|
|
|
|
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
2019-02-17 12:28:17 +01:00
|
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
2018-08-22 22:05:28 +02:00
|
|
|
|
|
|
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
2019-01-06 18:56:14 +01:00
|
|
|
sensor. Defaults to ``60s``.
|
2018-08-22 22:05:28 +02:00
|
|
|
|
|
|
|
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component <uart>` if you want
|
|
|
|
to use multiple UART buses.
|
|
|
|
|
|
|
|
.. figure:: images/mhz19-pins.jpg
|
|
|
|
:align: center
|
|
|
|
:width: 80.0%
|
|
|
|
|
|
|
|
Pins on the MH-Z19. Only the ones marked with a red circle need to be connected.
|
|
|
|
|
|
|
|
See Also
|
|
|
|
--------
|
|
|
|
|
|
|
|
- :ref:`sensor-filters`
|
2018-08-24 22:44:01 +02:00
|
|
|
- `MH-Z19 library <https://github.com/nara256/mhz19_uart>`__ by `@nara356 <https://github.com/nara256>`__
|
2019-02-07 13:54:45 +01:00
|
|
|
- :apiref:`sensor/mhz19_component.h`
|
|
|
|
- :ghedit:`Edit`
|