Introduction
=============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max31855/badge/?version=latest
:target: https://docs.circuitpython.org/projects/max31855/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MAX31855/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MAX31855/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython driver for the `MAX31855 Thermocouple Amplifier Breakout <https://www.adafruit.com/product/269>`_
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-max31855/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-max31855
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-max31855
To install in a virtual environment in your current project:
.. code-block:: shell
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:
.. code:: python3
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:
.. code:: python3
from digitalio import DigitalInOut
import board
spi = board.SPI()
cs = DigitalInOut(board.D5)
Next, just create the sensor object:
.. code:: python3
sensor = adafruit_max31855.MAX31855(spi, cs)
And you can start making measurements:
.. code:: python3
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 <https://docs.circuitpython.org/projects/max31855/en/latest/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_MAX21855/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-max31855",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, max31855, thermocouple, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/b1/93/5e5a541ac38a0e91ab59b734dc038cdae8e0d362882ec1b4a48c784040fc/adafruit_circuitpython_max31855-3.2.22.tar.gz",
"platform": null,
"description": "Introduction\n=============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max31855/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/max31855/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MAX31855/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MAX31855/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython driver for the `MAX31855 Thermocouple Amplifier Breakout <https://www.adafruit.com/product/269>`_\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-max31855/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-max31855\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-max31855\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-max31855\n\nUsage Example\n==============\n\nOf course, you must import the library to use it:\n\n.. code:: python3\n\n import adafruit_max31855\n\nYou also need to create an SPI interface object, and a pin object for the\nchip select pin. You can use any pin for the CS, but we use D5 here:\n\n\n.. code:: python3\n\n from digitalio import DigitalInOut\n import board\n\n spi = board.SPI()\n cs = DigitalInOut(board.D5)\n\nNext, just create the sensor object:\n\n.. code:: python3\n\n sensor = adafruit_max31855.MAX31855(spi, cs)\n\nAnd you can start making measurements:\n\n.. code:: python3\n\n print(sensor.temperature)\n\nThe temperature is read in degrees Celsius (\u00b0C). You have to convert it to\nother units yourself, if you need it.\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/max31855/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_MAX21855/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for controlling a MAX31855 Thermocouple sensor chip.",
"version": "3.2.22",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MAX31855"
},
"split_keywords": [
"adafruit",
" max31855",
" thermocouple",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73ffb472d49ca61c2ed44cd9be16c73afcedddcc0153bec82af8ffb68681f51a",
"md5": "6ae40c939dac84cd5ddc4be97090bdd6",
"sha256": "ab23c75b6b2ed13c1721be0ee99f7c283dc5b285812bbe94d3c2bbaf31dd5827"
},
"downloads": -1,
"filename": "adafruit_circuitpython_max31855-3.2.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ae40c939dac84cd5ddc4be97090bdd6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6104,
"upload_time": "2024-10-07T22:07:09",
"upload_time_iso_8601": "2024-10-07T22:07:09.996716Z",
"url": "https://files.pythonhosted.org/packages/73/ff/b472d49ca61c2ed44cd9be16c73afcedddcc0153bec82af8ffb68681f51a/adafruit_circuitpython_max31855-3.2.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1935e5a541ac38a0e91ab59b734dc038cdae8e0d362882ec1b4a48c784040fc",
"md5": "1c124511d5f3f1f2ac95d234e4064975",
"sha256": "31302e6126789e2f50db5eb554a276b74a85418223fee23d51095bbb4e8ae1c2"
},
"downloads": -1,
"filename": "adafruit_circuitpython_max31855-3.2.22.tar.gz",
"has_sig": false,
"md5_digest": "1c124511d5f3f1f2ac95d234e4064975",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26834,
"upload_time": "2024-10-07T22:07:11",
"upload_time_iso_8601": "2024-10-07T22:07:11.065226Z",
"url": "https://files.pythonhosted.org/packages/b1/93/5e5a541ac38a0e91ab59b734dc038cdae8e0d362882ec1b4a48c784040fc/adafruit_circuitpython_max31855-3.2.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:07:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MAX31855",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-max31855"
}
JSON
