Adafruit_MicroPython_MAX31685/README.rst

71 lines
2.2 KiB
ReStructuredText
Raw Normal View History

2017-12-01 10:38:25 +01:00
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://travis-ci.com/adafruit/Adafruit_CircuitPython_MAX31865.svg?branch=master
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MAX31865
2018-03-10 18:08:13 +01:00
:alt: Build Status
2017-12-01 10:48:26 +01:00
CircuitPython module for the MAX31865 thermocouple amplifier.
2017-12-01 10:38:25 +01:00
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
2019-09-19 23:56:43 +02:00
`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
2017-12-01 10:38:25 +01:00
Usage Example
=============
2018-03-02 03:44:15 +01:00
See examples/max31865_simpletest.py for a demo of the usage.
2017-12-01 10:38:25 +01:00
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
=============
2017-12-01 10:38:25 +01:00
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>`_.