Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython driver for the MAX31855 Thermocouple Amplifier Breakout

Dependencies

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.

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:

pip3 install adafruit-circuitpython-max31855

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

sudo pip3 install adafruit-circuitpython-max31855

To install in a virtual environment in your current project:

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:

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 digitalio import DigitalInOut
import board

spi = board.SPI()
cs = DigitalInOut(board.D5)

Next, just create the sensor object:

sensor = adafruit_max31855.MAX31855(spi, cs)

And you can start making measurements:

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.

Table of Contents

Examples

Indices and tables