Documentation for SFA30 component (#3260)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
parent
a5c1b8e417
commit
cc0d1d8194
Binary file not shown.
After Width: | Height: | Size: 47 KiB |
|
@ -0,0 +1,57 @@
|
||||||
|
SFA30 Formaldehyde Sensor
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. seo::
|
||||||
|
:description: Instructions for setting up SFA30 Formaldehyde Sensor
|
||||||
|
:image: sfa30.jpg
|
||||||
|
|
||||||
|
The ``sfa30`` sensor platform allows you to use your Sensirion SFA30 Formaldehyde
|
||||||
|
(`datasheet <https://sensirion.com/media/documents/DEB1C6D6/63D92360/Sensirion_formaldehyde_sensors_datasheet_SFA30.pdf>`__) sensors with ESPHome.
|
||||||
|
The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for this sensor to work.
|
||||||
|
This sensor supports both UART and I²C communication. However, at the moment only I²C communication is implemented.
|
||||||
|
|
||||||
|
.. figure:: images/sfa30.jpg
|
||||||
|
:align: center
|
||||||
|
:width: 80.0%
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
# Example configuration entry
|
||||||
|
sensor:
|
||||||
|
- platform: sfa30
|
||||||
|
formaldehyde:
|
||||||
|
name: "Formaldehyde"
|
||||||
|
temperature:
|
||||||
|
name: "Temperature"
|
||||||
|
humidity:
|
||||||
|
name: "Humidity"
|
||||||
|
|
||||||
|
|
||||||
|
Configuration variables:
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
- **formaldehyde** (*Optional*): The information for the Formaldehyde sensor.
|
||||||
|
All options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
|
- **temperature** (*Optional*): The information for the Temperature sensor.
|
||||||
|
All options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
|
|
||||||
|
- **humidity** (*Optional*): The information for the Humidity sensor.
|
||||||
|
All options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
|
|
||||||
|
- **address** (*Optional*, int): Manually specify the I²C address of the sensor.
|
||||||
|
Defaults to ``0x5D``.
|
||||||
|
|
||||||
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||||
|
sensor. Defaults to ``60s``.
|
||||||
|
|
||||||
|
|
||||||
|
See Also
|
||||||
|
--------
|
||||||
|
|
||||||
|
- :ref:`sensor-filters`
|
||||||
|
- :doc:`absolute_humidity`
|
||||||
|
- :apiref:`sfa30/sfa30.h`
|
||||||
|
- :ghedit:`Edit`
|
Binary file not shown.
After Width: | Height: | Size: 21 KiB |
|
@ -196,6 +196,7 @@ Air Quality
|
||||||
SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2
|
SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2
|
||||||
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
|
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
|
||||||
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
|
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
|
||||||
|
SFA30, components/sensor/sfa30, sfa30.jpg, Formaldehyde
|
||||||
SGP30, components/sensor/sgp30, sgp30.jpg, CO2 & Volatile organics
|
SGP30, components/sensor/sgp30, sgp30.jpg, CO2 & Volatile organics
|
||||||
SGP4x, components/sensor/sgp4x, sgp40.jpg, Volatile organics and NOx
|
SGP4x, components/sensor/sgp4x, sgp40.jpg, Volatile organics and NOx
|
||||||
SM300D2, components/sensor/sm300d2, sm300d2.jpg, Air quality
|
SM300D2, components/sensor/sm300d2, sm300d2.jpg, Air quality
|
||||||
|
@ -327,6 +328,7 @@ Environmental
|
||||||
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
|
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
|
||||||
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
|
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
|
||||||
SDP3x / SDP800 Series, components/sensor/sdp3x, sdp31.jpg, Pressure
|
SDP3x / SDP800 Series, components/sensor/sdp3x, sdp31.jpg, Pressure
|
||||||
|
SFA30, components/sensor/sfa30, sfa30.jpg, Formaldehyde
|
||||||
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg, Temperature & Humidity
|
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg, Temperature & Humidity
|
||||||
SHT4X, components/sensor/sht4x, sht4x.jpg, Temperature & Humidity
|
SHT4X, components/sensor/sht4x, sht4x.jpg, Temperature & Humidity
|
||||||
SHTCx, components/sensor/shtcx, shtc3.jpg, Temperature & Humidity
|
SHTCx, components/sensor/shtcx, shtc3.jpg, Temperature & Humidity
|
||||||
|
|
Loading…
Reference in New Issue