Documentation Status Discord Build Status

CircuitPython driver for the MAX31855 Thermocouple Amplifier Breakout


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

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

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:

from busio import SPI
from digitalio import DigitalInOut
import board

spi = SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)
cs = DigitalInOut(board.D5)

Next, just create the sensor object:

sensor = adafruit_max31855.MAX31855(spi, cs)

And you can start making measurements:


The temperature is read in degrees Celsius (°C). You have to convert it to other units yourself, if you need it.


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max31855 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

Indices and tables