From f1df93c86f1ca918d72b1a4e82b972746f010020 Mon Sep 17 00:00:00 2001 From: Nad <15346053+valordk@users.noreply.github.com> Date: Sat, 19 Oct 2019 21:35:14 +0200 Subject: [PATCH] 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 --- components/sensor/max31855.rst | 1 - components/sensor/sts3x.rst | 48 ++++++++++++++++++++++++++++++++++ index.rst | 1 + 3 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 components/sensor/sts3x.rst diff --git a/components/sensor/max31855.rst b/components/sensor/max31855.rst index 9b5649e1d..4e2179d34 100644 --- a/components/sensor/max31855.rst +++ b/components/sensor/max31855.rst @@ -50,7 +50,6 @@ See Also - :doc:`dallas` - :doc:`dht` - :doc:`adc` -- :doc:`sht3xd` - :doc:`max6675` - `MAX31855 Library `__ by `Adafruit `__ - :apiref:`max31855/max31855.h` diff --git a/components/sensor/sts3x.rst b/components/sensor/sts3x.rst new file mode 100644 index 000000000..eba1b5f50 --- /dev/null +++ b/components/sensor/sts3x.rst @@ -0,0 +1,48 @@ +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 `__, +`Sensirion STS3x `__) sensors with +ESPHome. The :ref:`I²C Bus ` 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 `. + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`dht` +- :doc:`dht12` +- :doc:`hdc1080` +- :doc:`htu21d` +- :doc:`sht3xd` +- :apiref:`sts3x/sts3x.h` +- :ghedit:`Edit` diff --git a/index.rst b/index.rst index 38c02612d..cefadce3f 100644 --- a/index.rst +++ b/index.rst @@ -134,6 +134,7 @@ Sensor Components SCD30, components/sensor/scd30, scd30.jpg SHTCx, components/sensor/shtcx, shtc3.jpg SHT3X-D, components/sensor/sht3xd, sht3xd.jpg + STS3X, components/sensor/sts3x, sts3x.jpg SGP30, components/sensor/sgp30, sgp30.jpg TCS34725, components/sensor/tcs34725, tcs34725.jpg Template Sensor, components/sensor/template, description.svg