:orphan:

.. _device-MAX31865:

MAX31865
========

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

**Driver Quality Index:** alpha

.. admonition:: Requires the following packages 

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

Interface class for MAX31865 resistance temperature sensor.

.. 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.max31865.MAX31865` 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_pin
             - <class 'int'>
             - 8
             - Chip select GPIO pin.
           * - miso_pin
             - <class 'int'>
             - 9
             - MISO GPIO pin.
           * - mosi_pin
             - <class 'int'>
             - 10
             - MOSI GPIO pin.
           * - clk_pin
             - <class 'int'>
             - 11
             - Clock GPIO pin.
           * - r_0
             - <class 'float'>
             - 1000.0
             - Resistance at 0°C, default 1000 Ohms.
           * - r_ref
             - <class 'float'>
             - 400.0
             - Reference resistor value.
           * - three_wire
             - <class 'bool'>
             - False
             - True for 3-wire configuration.

    .. tab-item:: Example JSON for BOSS

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

        .. code-block:: json

            {
                "_id": "my_MAX31865",
                "classname": "herosdevices.hardware.raspberrypi.max318xx.max31865.MAX31865",
                "arguments": {
                    "cs_pin": 8,
                    "miso_pin": 9,
                    "mosi_pin": 10,
                    "clk_pin": 11,
                    "r_0": 1000.0,
                    "r_ref": 400.0,
                    "three_wire": false
                }
            }

        :sup:`generated from signature`

    .. tab-item:: Inheritance

        .. inheritance-diagram:: herosdevices.hardware.raspberrypi.max318xx.max31865.MAX31865