Micropython port of Adafruit's MAX31685 module for CircuitPython The MAX31685 component is a thermocouple amplifier using SPI to communicate with a micro-controller.
Go to file
sommersoft f7e9fb038e update code of coduct: discord moderation contact section
Signed-off-by: sommersoft <sommersoft@gmail.com>
2020-03-15 18:27:42 -05:00
.github/workflows build.yml: move pylint, black, and Sphinx installs to each repo; add description to 'actions-ci/install.sh' 2020-03-05 10:06:12 -06:00
docs PyPi setup. 2018-08-05 16:46:09 -04:00
examples renamed example; 1 learn guide needs update 2018-03-01 20:29:50 -06:00
.gitignore Moved repository from Travis to GitHub Actions 2020-01-01 15:28:37 -05:00
.pylintrc update pylintrc for black 2020-03-08 19:07:07 -05:00
.readthedocs.yml update .travis & .readthedocs.yml 2018-03-01 20:43:19 -06:00
CODE_OF_CONDUCT.md update code of coduct: discord moderation contact section 2020-03-15 18:27:42 -05:00
LICENSE Initial commit. 2017-12-01 01:38:25 -08:00
README.rst Moved repository from Travis to GitHub Actions 2020-01-01 15:28:37 -05:00
adafruit_max31865.py Merge pull request #9 from CapableRobot/low_temp_fix 2020-01-08 09:43:28 -05:00
requirements.txt PyPi setup. 2018-08-05 16:46:09 -04:00
setup.py PyPi setup. 2018-08-05 16:46:09 -04:00

README.rst

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max31865/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/max31865/en/latest/
    :alt: Documentation Status

.. image :: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MAX31865/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_MAX31865/actions/
    :alt: Build Status

CircuitPython module for the MAX31865 thermocouple amplifier.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.

Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-max31865/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-max31865

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-max31865

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-max31865


Usage Example
=============

See examples/max31865_simpletest.py for a demo of the usage.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_max31865/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.