esphome-docs/components/sensor/hdc1080.rst
DAVe3283 3e74757ce9
Add absolute humidity component (#2723)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
2023-03-08 10:21:36 +13:00

91 lines
2.7 KiB
ReStructuredText

HDC1080 Temperature+Humidity Sensor
===================================
.. seo::
:description: Instructions for setting up HDC1080 temperature and humidity sensors.
:image: hdc1080.jpg
:keywords: HDC1080
The HDC1080 Temperature+Humidity sensor allows you to use your HDC1080
(`datasheet <http://www.ti.com/lit/ds/symlink/hdc1080.pdf>`__,
`Adafruit <https://www.adafruit.com/product/2635>`__) sensors with
ESPHome. The :ref:`I²C Bus <i2c>` is
required to be set up in your configuration for this sensor to work.
.. figure:: images/hdc1080-full.jpg
:align: center
:target: `Adafruit`_
:width: 50.0%
HDC1080 Temperature & Humidity Sensor. Image by `Adafruit`_.
.. _Adafruit: https://www.adafruit.com/product/2635
.. figure:: images/temperature-humidity.png
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: hdc1080
temperature:
name: "Living Room Temperature"
humidity:
name: "Living Room Humidity"
update_interval: 60s
Configuration variables:
------------------------
- **temperature** (**Required**): The information for the temperature sensor.
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (**Required**): The information for the humidity sensor
- **name** (**Required**, string): The name for the humidity sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
Currently, the platform doesn't support activating the built-in heater,
as it seems to only be rarely of use. If you need it, please open an
issue.
Notes
--------
This library also appears to the compatible with the `DFRobot CHT8305 I2C Temperature and Humidity Sensor <https://wiki.dfrobot.com/SKU_SEN0546_I2C_Temperature_and_Humidity_Sensor_Stainless_Steel_Shell>`__) on address 0x40.
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: hdc1080
temperature:
name: "Outside Temperature"
humidity:
name: "Outside Humidity"
address: 0x40
update_interval: 60s
See Also
--------
- :ref:`sensor-filters`
- :doc:`absolute_humidity`
- :doc:`dht`
- :doc:`dht12`
- :doc:`htu21d`
- :doc:`sht3xd`
- :apiref:`hdc1080/hdc1080.h`
- `HDC1080 Library <https://github.com/closedcube/ClosedCube_HDC1080_Arduino>`__ by `ClosedCube <https://www.tindie.com/stores/closedcube/>`__
- :ghedit:`Edit`