esphome-docs/components/sensor/am2320.rst
Teemu Mikkonen ed800a9fa0 Documentation for AM2320 component (#249)
* Added documentation for AM2320

* Added new files for AM2320

* Fixed too long row

* Update am2320.rst


Co-authored-by: Mikkonen Teemu <teemu.mikkonen@iki.fi>
Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-05-27 20:03:33 +02:00

68 lines
2.0 KiB
ReStructuredText

AM2320 Temperature+Humidity Sensor
==================================
.. seo::
:description: Instructions for setting up AM2320 temperature and humidity sensors
:image: am2320.jpg
:keywords: am2320
The ``am2320`` Temperature+Humidity sensor allows you to use your am2320
(`datasheet <https://akizukidenshi.com/download/ds/aosong/AM2320.pdf>`__) i2c-based sensor with ESPHome.
.. figure:: images/am2320-full.jpg
:align: center
:width: 50.0%
AM2320 Temperature & Humidity Sensor.
.. figure:: images/temperature-humidity.png
:align: center
:width: 80.0%
.. note::
Logs might include some warnings about receiving a NACK from the sensor.
This is due to a wake call to the sensor which the sensor never acknowledges by design.
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: am2320
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`
- :doc:`dht`
- :doc:`dht12`
- :doc:`hdc1080`
- :doc:`htu21d`
- :doc:`sht3xd`
- :apiref:`am2320/am2320.h`
- `AM2320 Library <https://github.com/EngDial/AM2320>`__ by `Aleksey <https://github.com/EngDial>`__
- :ghedit:`Edit`