esphome-docs/components/sensor/max31855.rst
igg d738a58a60
Docs for CS Optional (#644)
* Docs for CS Optional

* rst fix

Co-authored-by: Ilya Goldberg <iggie@mac.com>
Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
2020-06-10 17:02:51 -03:00

58 lines
2.2 KiB
ReStructuredText

MAX31855 K-Type Thermocouple Temperature Sensor
===============================================
.. seo::
:description: Instructions for setting up MAX31855 Thermocouple temperature sensors.
:image: max31855.jpg
The ``max31855`` temperature sensor allows you to use your max31855 thermocouple
temperature sensor (`datasheet <https://datasheets.maximintegrated.com/en/ds/MAX31855.pdf>`__) with ESPHome
As the communication with the MAX31855 is done using SPI, you need
to have an :ref:`spi bus <spi>` in your configuration with the **miso_pin** set (mosi is not required).
Connect ``GND`` to ``GND``, ``VCC`` to ``3.3V`` and the other three ``MISO`` (or ``SO`` for short),
``CS`` and ``CLOCK`` (or ``CLK``) to free GPIO pins.
.. figure:: images/temperature.png
:align: center
:width: 80.0%
.. code:: yaml
# Example configuration entry
spi:
miso_pin: D0
clk_pin: D1
sensor:
- platform: max31855
name: "Living Room Temperature"
cs_pin: D2
update_interval: 60s
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the temperature sensor.
- **cs_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that that the CS line is connected to.
The CS line can be connected to GND if this is the only device on the SPI bus.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
- **reference_temperature** (*Optional*, :ref:`Sensor <config-sensor>`): Access the internal temperature sensor of the MAX31855. Requires a **name** and/or **id**.
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want to use multiple SPI buses.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
See Also
--------
- :ref:`sensor-filters`
- :doc:`dallas`
- :doc:`dht`
- :doc:`adc`
- :doc:`max6675`
- :doc:`max31865`
- `MAX31855 Library <https://github.com/adafruit/Adafruit-MAX31855-library>`__ by `Adafruit <https://www.adafruit.com/>`__
- :apiref:`max31855/max31855.h`
- :ghedit:`Edit`