Skip to content

A CircuitPython driver for the MAX31856 Universal Thermocouple Amplifier

License

Notifications You must be signed in to change notification settings

adafruit/Adafruit_CircuitPython_MAX31856

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Black

A CircuitPython driver for the MAX31856 Universal Thermocouple Amplifier

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-max31856

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

sudo pip3 install adafruit-circuitpython-max31856

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-max31856

Usage Example

import board
import digitalio
import adafruit_max31856

# Create sensor object, communicating over the board's default SPI bus
spi = board.SPI()

# allocate a CS pin and set the direction
cs = digitalio.DigitalInOut(board.D5)
cs.direction = digitalio.Direction.OUTPUT

# create a thermocouple object with the above
thermocouple = adafruit_max31856.MAX31856(spi, cs)

# measure the temperature! (takes approx 160ms)
print(thermocouple.temperature)

# alternative (non-blocking) way to get temperature
thermocouple.initiate_one_shot_measurement()
# <perform other tasks>
# now wait for measurement to complete
while thermocouple.oneshot_pending:
  pass
print(thermocouple.unpack_temperature())

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.