diff --git a/components/sensor/iaqcore.rst b/components/sensor/iaqcore.rst new file mode 100644 index 000000000..1ff373805 --- /dev/null +++ b/components/sensor/iaqcore.rst @@ -0,0 +1,51 @@ +AMS iAQ-Core Indoor Air Quality Sensor +====================================== + +.. seo:: + :description: Instructions for setting up the iAQ-Core sensor. + :image: iaqcore.jpg + :keywords: co2, tvoc, i2c + +The AMS iAQ-Core sensor allows you to use your +(`datasheet `__) +sensors with ESPHome. + +.. figure:: images/iaqcore.jpg + :align: center + :width: 30.0% + + AMS iAQ-Core Indoor Air Quality Sensor. + +The iAQ-Core sensor module is used to measure VOC levels and provide CO2 equivalent and TVOC equivalent predictions. The data is available via I²C bus. + +To use the sensor, first set up an :ref:`I²C Bus ` and connect the sensor to the specified pins. + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: iaqcore + address: 0x5A + update_interval: 60s + co2: + name: "iAQ Core CO2 Sensor" + tvoc: + name: "iAQ Core TVOC Sensor" + +Configuration variables: +------------------------ + +- **i2c_id** (*Optional*, ID): The id of the I²C Bus. +- **address** (*Optional*, int): Manually specifiy the I²C address of the sensor. Defaults to ``0x5A``. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. +- **co2** (*Optional*): The configuration for the CO2 sensor. All options from + :ref:`Sensor `. +- **tvoc** (*Optional*): The configuration for the TVOC sensor. All options from + :ref:`Sensor `. + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`/components/sensor/index` +- :ghedit:`Edit` diff --git a/components/sensor/images/iaqcore.jpg b/components/sensor/images/iaqcore.jpg new file mode 100644 index 000000000..03d63a9e3 Binary files /dev/null and b/components/sensor/images/iaqcore.jpg differ diff --git a/images/iaqcore.jpg b/images/iaqcore.jpg new file mode 100644 index 000000000..03d63a9e3 Binary files /dev/null and b/images/iaqcore.jpg differ diff --git a/index.rst b/index.rst index 5ed0f62f8..d16fdcdec 100644 --- a/index.rst +++ b/index.rst @@ -203,6 +203,7 @@ Air Quality SPS30, components/sensor/sps30, sps30.jpg, Particulate T6613/15, components/sensor/t6615, t6615.jpg, CO2 ZyAura, components/sensor/zyaura, zgm053.jpg, CO2 & Temperature & Humidity + iAQ-Core, components/sensor/iaqcore, iaqcore.jpg, CO2 & Volatile organics Analogue