mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-05 09:20:08 +01:00
8a26a30a7f
The example configuration, on the conpensation part, lists temperature and humidity, the example has them inverted
65 lines
2.1 KiB
ReStructuredText
65 lines
2.1 KiB
ReStructuredText
SGP40 Volatile Organic Compound Sensor
|
|
======================================
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up SGP40 Volatile Organic Compound sensor
|
|
:image: sgp40.jpg
|
|
|
|
The ``sgp40`` sensor platform allows you to use your Sensirion SGP40 VOC sensor
|
|
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9_Gas_Sensors/Sensirion_Gas_Sensors_SGP40_Datasheet.pdf>`__) with ESPHome.
|
|
The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for this sensor to work.
|
|
|
|
.. figure:: images/sgp40.jpg
|
|
:align: center
|
|
:width: 80.0%
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
sensor:
|
|
- platform: sgp40
|
|
name: "Workshop VOC"
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **name** (**Required**, string): The name for the CO₂eq sensor.
|
|
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``
|
|
- **store_baseline** (*Optional*, boolean ): Stores and retrieves the baseline information for quicker startups. Defaults to ``true``
|
|
|
|
- **compensation** (*Optional*): The block containing sensors used for compensation. If not set defaults will be used.
|
|
|
|
- **temperature_source** (*Optional*, :ref:`config-id`): Give an external temperature sensor ID
|
|
here. This can improve the sensor's internal calculations. Defaults to ``25``
|
|
|
|
- **humidity_source** (*Optional*, :ref:`config-id`): Give an external humidity sensor ID
|
|
here. This can improve the sensor's internal calculations. Defaults to ``50``
|
|
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
|
|
|
Example With Compensation
|
|
-------------------------
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
sensor:
|
|
- platform: sgp40
|
|
name: "Workshop VOC"
|
|
update_interval: 5s
|
|
compensation:
|
|
humidity_source: dht1_hum
|
|
temperature_source: dht1_temp
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :ref:`sensor-filters`
|
|
- :doc:`dht`
|
|
- :doc:`dht12`
|
|
- :doc:`hdc1080`
|
|
- :doc:`htu21d`
|
|
- :doc:`sht3xd`
|
|
- :apiref:`sgp40/sgp40.h`
|
|
- :ghedit:`Edit`
|