Add documentation for SHTCx Temperature sensors (#305)

* Add documentation for STS3x Temperature sensors

* Updated formatting

* Updated index and other temperature sensors with link to STS3x sensor

* Added STS31 sensor photo

* Add documentation for SHTCx Temperature sensors

* Fixed reference to a sensor thumbnail

* Cleaned up changes leaked from STS3x feature

* Remove references on other pages

It's already getting too cluttered...

* Remove references


Co-authored-by: Otto Winter <otto@otto-winter.com>
This commit is contained in:
Nad 2019-10-19 21:32:59 +02:00 committed by Otto Winter
parent 34f6817423
commit 2552e8070e
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
6 changed files with 66 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

View File

@ -0,0 +1,65 @@
SHTCx Temperature+Humidity Sensors
==================================
.. seo::
:description: Instructions for setting up SHTC1 and SHTC3 temperature and humidity sensors
:image: shtc3.jpg
The ``shtcx`` sensor platform Temperature+Humidity sensor allows you to use your Sensiron SHTC1
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/0_Datasheets/Humidity/Sensirion_Humidity_Sensors_SHTC1_Datasheet.pdf>`__,
`Sensirion STHC1 <https://www.sensirion.com/en/environmental-sensors/humidity-sensors/digital-humidity-sensor-for-consumer-electronics-and-iot/>`__) and
the newer SHTC3
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/0_Datasheets/Humidity/Sensirion_Humidity_Sensors_SHTC3_Datasheet.pdf>`__,
`Sparkfun`_ ) sensors with
ESPHome. The :ref:`I²C Bus <i2c>` is
required to be set up in your configuration for this sensor to work.
.. _Sparkfun: https://www.sparkfun.com/products/15074
.. figure:: images/temperature-humidity.png
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: shtcx
temperature:
name: "Living Room Temperature"
humidity:
name: "Living Room Humidity"
address: 0x70
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>`.
- **address** (*Optional*, int): Manually specify the i^2c address of the sensor.
Defaults to ``0x70``.
- **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:`shtcx/shtcx.h`
- :ghedit:`Edit`

BIN
images/shtc3.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

BIN
images/sts3x.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

View File

@ -132,6 +132,7 @@ Sensor Components
SenseAir, components/sensor/senseair, senseair_s8.jpg
SDS011 Sensor, components/sensor/sds011, sds011.jpg
SCD30, components/sensor/scd30, scd30.jpg
SHTCx, components/sensor/shtcx, shtc3.jpg
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg
SGP30, components/sensor/sgp30, sgp30.jpg
TCS34725, components/sensor/tcs34725, tcs34725.jpg