* sgp40 document

* Updated per PR comments

* Added compensation example
This commit is contained in:
SenexCrenshaw 2021-04-08 21:40:51 -04:00 committed by GitHub
parent 91e097d3d8
commit 1b0e4fbdcf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 67 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.6 KiB

View File

@ -0,0 +1,65 @@
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 Sensiron 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 infortmation 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_temp
temperature_source: dht1_hum
See Also
--------
- :ref:`sensor-filters`
- :doc:`dht`
- :doc:`dht12`
- :doc:`hdc1080`
- :doc:`htu21d`
- :doc:`sht3xd`
- :apiref:`sgp40/sgp40.h`
- :ghedit:`Edit`

View File

@ -53,6 +53,7 @@ See Also
- :doc:`/components/sensor/pmsx003`
- :doc:`/components/sensor/mhz19`
- :doc:`/components/sensor/sgp30`
- :doc:`/components/sensor/sgp40`
- :doc:`/components/sensor/tsl2561`
- :doc:`/components/binary_sensor/gpio`
- :doc:`/components/sensor/template`

BIN
images/sgp40.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.6 KiB

View File

@ -162,6 +162,7 @@ Sensor Components
SPS30, components/sensor/sps30, sps30.jpg
STS3X, components/sensor/sts3x, sts3x.jpg
SGP30, components/sensor/sgp30, sgp30.jpg
SGP40, components/sensor/sgp40, sgp40.jpg
TCS34725, components/sensor/tcs34725, tcs34725.jpg
Teleinfo, components/sensor/teleinfo, teleinfo.jpg
Template Sensor, components/sensor/template, description.svg