Add documentation for AHT10 sensor (#466)

This commit is contained in:
Germain Masse 2020-03-21 20:17:11 +01:00 committed by GitHub
parent c95563aeea
commit daebc64aca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 63 additions and 0 deletions

View File

@ -0,0 +1,62 @@
AHT10 Temperature+Humidity Sensor
=================================
.. seo::
:description: Instructions for setting up AHT10 temperature and humidity sensors
:image: aht10.jpg
:keywords: aht10
The ``aht10`` Temperature+Humidity sensor allows you to use your aht10
(`datasheet <http://www.aosong.com/userfiles/files/media/aht10%E8%A7%84%E6%A0%BC%E4%B9%A6v1_1%EF%BC%8820191015%EF%BC%89.pdf>`__) i2c-based sensor with ESPHome.
.. figure:: images/aht10-full.jpg
:align: center
:width: 50.0%
AHT10 Temperature & Humidity Sensor.
.. figure:: images/temperature-humidity.png
:align: center
:width: 80.0%
.. note::
When configured for humidity, the log *'Components should block for at most 20-30ms in loop().'* will be generated in verbose mode. This is due to technical specs of the sensor and can not be avoided.
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: aht10
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``.
See Also
--------
- :ref:`sensor-filters`
- :apiref:`aht10/aht10.h`
- `AHT10 Library <https://github.com/Thinary/AHT10>`__ by `Thinary Electronic <https://github.com/Thinary>`__
- `Unofficial Translated AHT10 Datasheet (en) <https://wiki.liutyi.info/download/attachments/30507639/Aosong_AHT10_en_draft_0c.pdf>`__
- :ghedit:`Edit`

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

BIN
images/aht10.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

@ -92,6 +92,7 @@ Sensor Components
ADC, components/sensor/adc, flash.svg
ADE7953, components/sensor/ade7953, ade7953.svg
ADS1115, components/sensor/ads1115, ads1115.jpg
AHT10, components/sensor/aht10, aht10.jpg
AM2320, components/sensor/am2320, am2320.jpg
APDS9960, components/sensor/apds9960, apds9960.jpg
ATM90E32, components/sensor/atm90e32, atm90e32.jpg