Add docs for TMP117 sensor (#505)

* Add docs for TMP117 sensor
This commit is contained in:
Nicholas Peters 2020-03-12 17:24:48 -04:00 committed by GitHub
parent cac2d84b10
commit c95563aeea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 59 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -0,0 +1,58 @@
TMP117 Temperature Sensor
=========================
.. seo::
:description: Instructions for setting up the TMP117 Temperature sensor.
:image: tmp117.jpg
:keywords: TMP117
The TMP117 Temperature+Humidity sensor allows you to use your TMP117
(`datasheet <https://www.ti.com/lit/ds/symlink/tmp117.pdf>`__,
`sparkfun <https://www.sparkfun.com/products/15805>`__)
sensors with ESPHome.
.. figure:: images/tmp117.jpg
:align: center
:width: 30.0%
TMP117 Temperature Sensor.
(Credit: `Sparkfun <https://www.sparkfun.com/products/15805>`__, image cropped and compressed)
.. _Sparkfun: https://www.sparkfun.com/products/15805
The TMP117 is a high precision temperature sensor that communicates over I2C. Each sensor is tested on a NIST tracable test setup during Texas Instruments' production process. Accuracy should be at worst 0.1C across the -20C to +50C temperature range.
To use the sensor, first set up an :ref:`I²C Bus <i2c>` and connect the sensor to the specified pins.
If accuracy is a must, see section 8.2.2.2 of the `datasheet <https://www.ti.com/lit/ds/symlink/tmp117.pdf>`__.
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: tmp117
name: "Living Room Temperature"
update_interval: 60s
Configuration variables
-----------------------
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for lambdas/multiple sensors.
- **address** (*Optional*, int): The I²C address of the sensor.
See :ref:`I²C Addresses <tmp117_i2c_addresses>` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. The sensor component sets the maximum possible averaging in the sensor based on this.
.. _tmp117_i2c_addresses:
I²C Addresses
-------------
In order to allow multiple sensors to be connected to the same I²C bus,
the creators of this sensor hardware have included some options to
change the i²c address.
- If the address pin is pulled to GND, the address is ``0x48`` (Default).
- If the address pin is pulled to VCC, the address is ``0x49``.
- If the address pin is tied to SDA, the address is ``0x4A``.
- If the address pin is tied to SCL, the address is ``0x4B``.

BIN
images/tmp117.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -149,6 +149,7 @@ Sensor Components
SGP30, components/sensor/sgp30, sgp30.jpg
TCS34725, components/sensor/tcs34725, tcs34725.jpg
Template Sensor, components/sensor/template, description.svg
TMP117, components/sensor/tmp117, tmp117.jpg
Total Daily Energy, components/sensor/total_daily_energy, sigma.svg
TSL2561, components/sensor/tsl2561, tsl2561.jpg
Tx20, components/sensor/tx20, tx20.jpg