diff --git a/components/sensor/images/sfa30.jpg b/components/sensor/images/sfa30.jpg new file mode 100644 index 000000000..aff6f6c3d Binary files /dev/null and b/components/sensor/images/sfa30.jpg differ diff --git a/components/sensor/sfa30.rst b/components/sensor/sfa30.rst new file mode 100644 index 000000000..57c9315c3 --- /dev/null +++ b/components/sensor/sfa30.rst @@ -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 `__) sensors with ESPHome. +The :ref:`I²C Bus ` 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 `. + +- **temperature** (*Optional*): The information for the Temperature sensor. + All options from :ref:`Sensor `. + + +- **humidity** (*Optional*): The information for the Humidity sensor. + All options from :ref:`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` diff --git a/images/sfa30.jpg b/images/sfa30.jpg new file mode 100644 index 000000000..131460393 Binary files /dev/null and b/images/sfa30.jpg differ diff --git a/index.rst b/index.rst index 014c77d79..6d1621ff3 100644 --- a/index.rst +++ b/index.rst @@ -196,6 +196,7 @@ Air Quality SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2 SCD30, components/sensor/scd30, scd30.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 SGP4x, components/sensor/sgp4x, sgp40.jpg, Volatile organics and NOx SM300D2, components/sensor/sm300d2, sm300d2.jpg, Air quality @@ -327,6 +328,7 @@ Environmental SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity 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 SHT4X, components/sensor/sht4x, sht4x.jpg, Temperature & Humidity SHTCx, components/sensor/shtcx, shtc3.jpg, Temperature & Humidity