diff --git a/.gitignore b/.gitignore index 64d1a59eb..2f8165bd6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ _build +.DS_Store .python-version __pycache__/ diff --git a/components/sensor/images/as3935.jpg b/components/sensor/images/as3935.jpg index ca24c1900..195b58801 100644 Binary files a/components/sensor/images/as3935.jpg and b/components/sensor/images/as3935.jpg differ diff --git a/components/sensor/images/max31856-full.jpg b/components/sensor/images/max31856-full.jpg new file mode 100644 index 000000000..70ad37841 Binary files /dev/null and b/components/sensor/images/max31856-full.jpg differ diff --git a/components/sensor/images/max31865-full.jpg b/components/sensor/images/max31865-full.jpg index f260e2b8c..214e42df1 100644 Binary files a/components/sensor/images/max31865-full.jpg and b/components/sensor/images/max31865-full.jpg differ diff --git a/components/sensor/images/mpu6050-full.jpg b/components/sensor/images/mpu6050-full.jpg index 789a69dd0..d8e61cb2e 100644 Binary files a/components/sensor/images/mpu6050-full.jpg and b/components/sensor/images/mpu6050-full.jpg differ diff --git a/components/sensor/max31856.rst b/components/sensor/max31856.rst new file mode 100644 index 000000000..75eb50d31 --- /dev/null +++ b/components/sensor/max31856.rst @@ -0,0 +1,69 @@ +MAX31856 Thermocouple Temperature Sensor +======================================== + +.. seo:: + :description: Instructions for setting up MAX31856 Thermocouple temperature sensors. + :image: max31865.png + +The ``MAX31856`` temperature sensor allows you to use your MAX31856 Thermocouple +temperature sensor (`datasheet `__) with ESPHome + +.. figure:: images/max31865-full.jpg + :align: center + :width: 50.0% + + MAX31856 Sensor. Image by `Adafruit`_ + +.. _Adafruit: https://www.adafruit.com/product/3263 + +As the communication with the MAX31856 is done using SPI, you need +to have an :ref:`spi bus ` in your configuration with both **miso_pin** and **mosi_pin** set. + +- ``VIN`` connects to 5V (``3V3`` will output 3.3V), or directly connect ``3V3`` to 3.3V +- ``3Vo`` is not used by ESPHome +- ``GND`` connects to ground +- ``CLK`` connects to the SPI **clk_pin** +- ``SDO`` connects to the SPI **miso_pin** +- ``SDI`` connects to the SPI **mosi_pin** +- ``CS`` connects to a free GPIO pin +- ``FLT`` is not used by ESPHome +- ``DRDY`` is not used by ESPHome + +.. code:: yaml + + # Example configuration entry + spi: + clk_pin: GPIO18 + miso_pin: GPIO19 + mosi_pin: GPIO23 + + sensor: + - platform: MAX31856 + name: "BBQ Temperature" + icon: "mdi:hamburger" + cs_pin: GPIO17 + +Configuration variables: +------------------------ + +- **name** (**Required**, string): The name for the temperature sensor. +- **cs_pin** (**Required**, :ref:`Pin Schema `): The Chip Select pin of the SPI interface. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. +- **mains_filter** (*Optional*, string): The mains power frequency to reject (``50 Hz`` or ``60 Hz``). Defaults to ``60 Hz``. +- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component ` 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 `. + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`dallas` +- :doc:`dht` +- :doc:`adc` +- :doc:`max6675` +- :doc:`max31855` +- :doc:`max31865` +- `MAX31856 Library `__ by `Adafruit `__ +- :apiref:`MAX31856/MAX31856.h` +- :ghedit:`Edit` diff --git a/components/sensor/max31865.rst b/components/sensor/max31865.rst index 0e89b5105..aff4da4da 100644 --- a/components/sensor/max31865.rst +++ b/components/sensor/max31865.rst @@ -20,6 +20,7 @@ As the communication with the MAX31865 is done using SPI, you need to have an :ref:`spi bus ` in your configuration with both **miso_pin** and **mosi_pin** set. - ``VIN`` connects to 5V (``3V3`` will output 3.3V), or directly connect ``3V3`` to 3.3V +- ``3Vo`` is not used by ESPHome - ``GND`` connects to ground - ``CLK`` connects to the SPI **clk_pin** - ``SDO`` connects to the SPI **miso_pin** @@ -65,6 +66,7 @@ See Also - :doc:`adc` - :doc:`max6675` - :doc:`max31855` +- :doc:`max31856` - `MAX31865 Library `__ by `Adafruit `__ - :apiref:`max31865/max31865.h` - :ghedit:`Edit` diff --git a/images/max31856.jpg b/images/max31856.jpg new file mode 100644 index 000000000..c3690221e Binary files /dev/null and b/images/max31856.jpg differ diff --git a/index.rst b/index.rst index 58cb6cc39..a96736e14 100644 --- a/index.rst +++ b/index.rst @@ -125,6 +125,7 @@ Sensor Components HTU21D, components/sensor/htu21d, htu21d.jpg HM3301, components/sensor/hm3301, hm3301.jpg MAX31855, components/sensor/max31855, max31855.jpg + MAX31856, components/sensor/max31856, max31856.jpg MAX31865, components/sensor/max31865, max31865.jpg MAX6675, components/sensor/max6675, max6675.jpg MH-Z19, components/sensor/mhz19, mhz19.jpg