Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max31856/badge/?version=latest
:target: https://docs.circuitpython.org/projects/max31856/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_MAX31856/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MAX31856/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
A CircuitPython driver for the MAX31856 Universal 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://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-max31856/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-max31856
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-max31856
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-max31856
Usage Example
=============
.. code:: python3
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 <https://docs.circuitpython.org/projects/max31856/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/siddacious/Adafruit_CircuitPython_MAX31856/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-max31856",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, max31856, universal, thermocouple, amplifierhardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/1e/42/247446e67aa18f0a9f82f4ec734094620360a661417f53da06839e6d962c/adafruit_circuitpython_max31856-0.12.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-max31856/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/max31856/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_MAX31856/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MAX31856/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\nA CircuitPython driver for the MAX31856 Universal Thermocouple Amplifier\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-max31856/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-max31856\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-max31856\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-max31856\n\nUsage Example\n=============\n\n.. code:: python3\n\n import board\n import digitalio\n import adafruit_max31856\n\n # Create sensor object, communicating over the board's default SPI bus\n spi = board.SPI()\n\n # allocate a CS pin and set the direction\n cs = digitalio.DigitalInOut(board.D5)\n cs.direction = digitalio.Direction.OUTPUT\n\n # create a thermocouple object with the above\n thermocouple = adafruit_max31856.MAX31856(spi, cs)\n\n # measure the temperature! (takes approx 160ms)\n print(thermocouple.temperature)\n\n # alternative (non-blocking) way to get temperature\n thermocouple.initiate_one_shot_measurement()\n # <perform other tasks>\n # now wait for measurement to complete\n while thermocouple.oneshot_pending:\n pass\n print(thermocouple.unpack_temperature())\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/max31856/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/siddacious/Adafruit_CircuitPython_MAX31856/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for the MAX31856 Universal Thermocouple Amplifier.",
"version": "0.12.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MAX31856"
},
"split_keywords": [
"adafruit",
" max31856",
" universal",
" thermocouple",
" amplifierhardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77847c7ea6bc07f8d2e1868ebaa35a71fa6e97f971600710b8889949c4404d6b",
"md5": "02bd33e37446ff78464e2639a86d1df5",
"sha256": "d0fa35aaa1b8ab519075bafb664b7d19ae2a62038a5958b4e54a2514f5b6eab4"
},
"downloads": -1,
"filename": "adafruit_circuitpython_max31856-0.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "02bd33e37446ff78464e2639a86d1df5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8507,
"upload_time": "2024-10-07T22:10:43",
"upload_time_iso_8601": "2024-10-07T22:10:43.640017Z",
"url": "https://files.pythonhosted.org/packages/77/84/7c7ea6bc07f8d2e1868ebaa35a71fa6e97f971600710b8889949c4404d6b/adafruit_circuitpython_max31856-0.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e42247446e67aa18f0a9f82f4ec734094620360a661417f53da06839e6d962c",
"md5": "cc708c1f9d323dead860b2ba8f5d56a9",
"sha256": "f3135e29508ecd8f6d264ddb795f587ddc056e9ac720b17b471f35f0f8e164a6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_max31856-0.12.1.tar.gz",
"has_sig": false,
"md5_digest": "cc708c1f9d323dead860b2ba8f5d56a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29885,
"upload_time": "2024-10-07T22:10:45",
"upload_time_iso_8601": "2024-10-07T22:10:45.751038Z",
"url": "https://files.pythonhosted.org/packages/1e/42/247446e67aa18f0a9f82f4ec734094620360a661417f53da06839e6d962c/adafruit_circuitpython_max31856-0.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:10:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MAX31856",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-max31856"
}
JSON
