esphome-docs/components/sensor/sts3x.rst
Nad f1df93c86f Add documentation for STS3x Temperature sensors (#300)
* Add documentation for STS3x Temperature sensors

* Updated formatting

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

* Added STS31 sensor photo

* Updated documentation with flattened config.

* Remove from some pages

Those sensors aren't really similar to this one, so removing them

* Remove references

Same, plus I don't want to fix all the merge conflicts


Co-authored-by: Otto Winter <otto@otto-winter.com>
2019-10-19 21:35:14 +02:00

49 lines
1.5 KiB
ReStructuredText

STS3X Temperature Sensor
========================
.. seo::
:description: Instructions for setting up STS3x-DIS temperature sensors
:image: sts3x.jpg
The ``sts3x`` sensor platform Temperature sensor allows you to use your Sensiron STS30-DIS, STS31-DIS or STS35-DIS
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/0_Datasheets/Temperature/Sensirion_Temperature_Sensors_STS3x_Datasheet.pdf>`__,
`Sensirion STS3x <https://https://www.sensirion.com/sts3x/>`__) 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/temperature.png
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: sts3x
name: "Living Room Temperature"
address: 0x4A
update_interval: 60s
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the temperature sensor.
- **address** (*Optional*, int): Manually specify the i^2c address of the sensor.
Defaults to ``0x4A``.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
See Also
--------
- :ref:`sensor-filters`
- :doc:`dht`
- :doc:`dht12`
- :doc:`hdc1080`
- :doc:`htu21d`
- :doc:`sht3xd`
- :apiref:`sts3x/sts3x.h`
- :ghedit:`Edit`