https://github.com/adafruit/adafruit_circuitpython_max31855

CircuitPython driver for MAX31855 Thermocouple Amplifier
https://github.com/adafruit/adafruit_circuitpython_max31855

circuitpython hacktoberfest

Last synced: 4 months ago
JSON representation

CircuitPython driver for MAX31855 Thermocouple Amplifier

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_max31855
• Owner: adafruit
• License: mit
• Created: 2017-02-03T17:21:04.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T17:27:35.000Z (about 1 year ago)
• Last Synced: 2024-04-26T07:45:34.088Z (9 months ago)
• Topics: circuitpython, hacktoberfest
• Language: Python
• Size: 126 KB
• Stars: 9
• Watchers: 23
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

=============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max31855/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/max31855/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MAX31855/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_MAX31855/actions/

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

CircuitPython driver for the `MAX31855 Thermocouple Amplifier Breakout `_

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

* `Bus Device `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_.

Installing from PyPI

====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-max31855

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-max31855

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .venv/bin/activate

    pip3 install adafruit-circuitpython-max31855

Usage Example

==============

Of course, you must import the library to use it:

.. code:: python3

    import adafruit_max31855

You also need to create an SPI interface object, and a pin object for the

chip select pin. You can use any pin for the CS, but we use D5 here:

.. code:: python3

    from digitalio import DigitalInOut

    import board

    spi = board.SPI()

    cs = DigitalInOut(board.D5)

Next, just create the sensor object:

.. code:: python3

    sensor = adafruit_max31855.MAX31855(spi, cs)

And you can start making measurements:

.. code:: python3

    print(sensor.temperature)

The temperature is read in degrees Celsius (°C). You have to convert it to

other units yourself, if you need it.

Documentation

=============

API documentation for this library can be found on `Read the Docs `_.

For information on building library documentation, please check out `this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.