diff --git a/components/sensor/images/zgm053-connection.jpg b/components/sensor/images/zgm053-connection.jpg new file mode 100644 index 000000000..c1743dccb Binary files /dev/null and b/components/sensor/images/zgm053-connection.jpg differ diff --git a/components/sensor/images/zgm053-full.jpg b/components/sensor/images/zgm053-full.jpg new file mode 100644 index 000000000..2363be324 Binary files /dev/null and b/components/sensor/images/zgm053-full.jpg differ diff --git a/components/sensor/zyaura.rst b/components/sensor/zyaura.rst new file mode 100644 index 000000000..d9750d60b --- /dev/null +++ b/components/sensor/zyaura.rst @@ -0,0 +1,84 @@ +ZyAura CO2 & Temperature & Humidity Sensor +========================================== + +.. seo:: + :description: Instructions for setting up ZyAura co2, temperature and humidity monitors. + :image: zgm053.jpg + :keywords: CO2, MT8057, MT8057S, MT8060, ZGm05, ZGm053U, ZG1683R, ZG1583RUD + +The ZyAura CO2 & Temperature & Humidity sensor allows you to use your +`ZGm05(3)(U) `__ +(`MT8057 `__, `MT8057S `__), +`ZG1683R(U) `__ (`MT8060 `__), +`ZG1583RUD `__ +monitors with ESPHome. + +.. figure:: images/zgm053-full.jpg + :align: center + :width: 80.0% + + ZyAura ZGm053U CO2 & Temperature Monitor. + +.. figure:: images/zgm053-connection.jpg + :align: center + :width: 80.0% + + ZyAura ZGm053U connection diagram (1 - empty, 2 - clock, 3 - data, 4 - GND). + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: zyaura + clock_pin: D1 + data_pin: D2 + co2: + name: "ZyAura CO2" + temperature: + name: "ZyAura Temperature" + humidity: + name: "ZyAura Humidity" + +Configuration variables: +------------------------ + +- **clock_pin** (**Required**, :ref:`config-pin`): The pin where the clock bus is connected. +- **data_pin** (**Required**, :ref:`config-pin`): The pin where the data bus is connected. +- **co2** (*Optional*): The information for the CO2 sensor. + + - **name** (**Required**, string): The name for the CO2 sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **temperature** (*Optional*): The information for the temperature 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 `. + +- **humidity** (*Optional*): The information for the humidity sensor + + - **name** (**Required**, string): The name for the humidity sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the + sensor. Defaults to ``60s``. + + +.. note:: + + ZGm05 monitor (and maybe others) needs some initial time to get correct data when powered + on. Only after this timespan will the sensor report correct values. It's not recommended to set + ``update_interval`` lower than ``20s``. + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`mhz19` +- `CO2mon-esp firmware `__ by `@anonym-tsk `__ +- `Some information about hacking MT8060 `__ +- `CO2MeterHacking project `__ +- :apiref:`zyaura/zyaura.h` +- :ghedit:`Edit` diff --git a/images/zgm053.jpg b/images/zgm053.jpg new file mode 100644 index 000000000..f68623032 Binary files /dev/null and b/images/zgm053.jpg differ diff --git a/index.rst b/index.rst index dcb633ae6..cd61b1196 100644 --- a/index.rst +++ b/index.rst @@ -138,6 +138,7 @@ Sensor Components WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg + ZyAura, components/sensor/zyaura, zgm053.jpg Custom Sensor, components/sensor/custom, language-cpp.svg Looking for a sensor that outputs its values as an analog voltage? Have a look at the