:orphan:

.. _device-MAX31855:

MAX31855
========

**From:** `Raspberry Pi Compatible Components <https://www.analog.com/en/products/max31855.html>`_
**Class:** :py:class:`herosdevices.hardware.raspberrypi.max318xx.max31855.MAX31855`

**Driver Quality Index:** alpha

.. admonition:: Requires the following packages 

    `RPi.GPIO <https://pypi.org/project/RPi.GPIO>`_

Class to interface with MAX31855 thermocouple-to-digital converter.

.. tab-set:: 

    .. tab-item:: Arguments

        Bold arguments are mandatory. For more information on the listed arguments refer to the class             documentation: :py:class:`herosdevices.hardware.raspberrypi.max318xx.max31855.MAX31855` If parameters appear in this             list but not in the class definition, please recursively check the linked base classes for the             definition of the parameter.

        .. list-table:: 
           :widths: 50 50 50 100
           :header-rows: 1

           * - Argument
             - Type
             - Default Value
             - Description
           * - **cs_pins**
             - **<class 'dict'>**
             - 
             - 
           * - miso_pin
             - <class 'int'>
             - 5
             - MISO GPIO pin number.
           * - clk_pin
             - <class 'int'>
             - 7
             - Clock GPIO pin number.
           * - invert_sign
             - <class 'bool'>
             - False
             - Optional, invert temperature sign.

    .. tab-item:: Example JSON for BOSS

        The following JSON strings can be used to start a HERO device representation of             :py:class:`MAX31855 <herosdevices.hardware.raspberrypi.max318xx.max31855.MAX31855>` using             `BOSS <https://boss-eb4966.gitlab.io/>`_.

        .. code-block:: json

            {
                "_id": "my_MAX31855",
                "classname": "herosdevices.hardware.raspberrypi.max318xx.max31855.MAX31855",
                "arguments": {
                    "cs_pins": "<class 'dict'>",
                    "miso_pin": 5,
                    "clk_pin": 7,
                    "invert_sign": false
                }
            }

        :sup:`generated from signature`

    .. tab-item:: Inheritance

        .. inheritance-diagram:: herosdevices.hardware.raspberrypi.max318xx.max31855.MAX31855