esphome-docs/components/sensor/hdc1080.rst

72 lines
2.2 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
HDC1080 Temperature+Humidity Sensor
===================================
2018-11-14 22:12:27 +01:00
.. seo::
:description: Instructions for setting up HDC1080 temperature and humidity sensors.
:image: hdc1080.jpg
:keywords: HDC1080
2018-05-13 11:37:02 +02:00
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
2019-02-16 23:25:23 +01:00
ESPHome. The :ref:`I²C Bus <i2c>` is
2018-05-13 11:37:02 +02:00
required to be set up in your configuration for this sensor to work.
2018-06-01 18:10:00 +02:00
.. figure:: images/hdc1080-full.jpg
:align: center
:target: `Adafruit`_
:width: 50.0%
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
HDC1080 Temperature & Humidity Sensor. Image by `Adafruit`_.
2018-05-13 11:37:02 +02:00
.. _Adafruit: https://www.adafruit.com/product/2635
2018-06-01 18:10:00 +02:00
.. figure:: images/temperature-humidity.png
:align: center
:width: 80.0%
2018-05-13 11:37:02 +02:00
.. code-block:: yaml
2018-05-13 11:37:02 +02:00
# Example configuration entry
sensor:
- platform: hdc1080
temperature:
name: "Living Room Temperature"
humidity:
2019-09-18 19:07:58 +02:00
name: "Living Room Humidity"
2019-01-06 18:56:14 +01:00
update_interval: 60s
2018-05-13 11:37:02 +02:00
Configuration variables:
2018-08-24 22:44:01 +02:00
------------------------
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
- **temperature** (**Required**): The information for the temperature sensor.
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Sensor <config-sensor>`.
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
- **humidity** (**Required**): The information for the humidity sensor
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
- **name** (**Required**, string): The name for the humidity sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Sensor <config-sensor>`.
2018-05-13 11:37:02 +02:00
2019-01-06 18:56:14 +01:00
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
2018-05-13 11:37:02 +02:00
2018-10-20 15:10:26 +02:00
Currently, the platform doesn't support activating the built-in heater,
2018-05-13 11:37:02 +02:00
as it seems to only be rarely of use. If you need it, please open an
issue.
2018-06-01 18:10:00 +02:00
See Also
2018-08-24 22:44:01 +02:00
--------
2018-06-01 18:10:00 +02:00
- :ref:`sensor-filters`
- :doc:`dht`
- :doc:`dht12`
- :doc:`htu21d`
- :doc:`sht3xd`
2019-05-12 22:44:59 +02:00
- :apiref:`hdc1080/hdc1080.h`
2018-08-24 22:44:01 +02:00
- `HDC1080 Library <https://github.com/closedcube/ClosedCube_HDC1080_Arduino>`__ by `ClosedCube <https://www.tindie.com/stores/closedcube/>`__
- :ghedit:`Edit`