Add docs for SHT4X (#1002)

This commit is contained in:
Stephen Tierney 2021-04-28 18:22:53 +10:00 committed by GitHub
parent d45572c5e4
commit aa2292062a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 63 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 153 KiB

View File

@ -0,0 +1,62 @@
SHT4X Temperature and Humidity Sensor
==================================================
.. seo::
:description: Instructions for setting up SHT4X temperature and humidity sensor
:image: images/sht4x-full.jpg
The ``sht4x`` sensor platform allows you to use your SHT4X temperature and humidity sensor
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/2_Humidity_Sensors/Datasheets/Sensirion_Humidity_Sensors_SHT4x_Datasheet.pdf>`__, `Adafruit`_) with ESPHome.
The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for this sensor to work.
.. figure:: images/sht4x-full.jpg
:align: center
:width: 80.0%
.. _Adafruit: https://www.adafruit.com/product/4885
.. code-block:: yaml
sensor:
- platform: sht4x
temperature:
name: "Temperature"
humidity:
name: "Relative Humidity"
Configuration variables:
------------------------
- **temperature** (**Optional**): Temperature. All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (**Optional**): Relative Humidity. All other options from :ref:`Sensor <config-sensor>`.
- **precision** (**Optional**, string): The measurement precision, either ``"High"``, ``"Med"`` or ``"Low"``. Default is ``"High"``.
- **heater_max_duty** (**Optional**, float): The maximum duty cycle of the heater (limited to ``0.05``). Default is ``0.0`` i.e. heater off.
- **heater_power** (**Optional**, string): The heater power, either ``"High"``, ``"Med"`` or ``"Low"``. Default is ``"High"``.
- **heater_time** (**Optional**, string): The length of time to run the heater, either ``"Long"`` (``1000ms``) or ``"Short"`` (``100ms``). Default is ``"Long"``.
- **address** (**Optional**, int): Manually specify the I²C address of the sensor. Default is ``0x44``.
- **update_interval** (**Optional**, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
Heater Configuration:
---------------------
The SHT4X includes an on-chip heater which is intended to remove condensation from the sensor that
has been sprayed onto the sensor or in high humidity environments. This can help
maintain accurate humidity measurements.
The heater can be enabled by setting ``heater_max_duty`` up to a maximum duty cycle
of ``5%`` (``0.05``). This runs the heater on a regular interval. While the heater
is in operation the sensor disables measurements so no updates will be published.
See the (`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/2_Humidity_Sensors/Datasheets/Sensirion_Humidity_Sensors_SHT4x_Datasheet.pdf>`__)
for more information about heater operation.
See Also
--------
- :doc:`/components/sensor/sht3xd`
- :doc:`/components/sensor/shtcx`
- :ref:`sensor-filters`
- :apiref:`sht4x/sht4x.h`
- :ghedit:`Edit`

BIN
images/sht4x.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -158,6 +158,7 @@ Sensor Components
SCD30, components/sensor/scd30, scd30.jpg
SHTCx, components/sensor/shtcx, shtc3.jpg
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg
SHT4X, components/sensor/sht4x, sht4x.jpg
SM300D2, components/sensor/sm300d2, sm300d2.jpg
SPS30, components/sensor/sps30, sps30.jpg
STS3X, components/sensor/sts3x, sts3x.jpg