Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-thermistor/badge/?version=latest
:target: https://docs.circuitpython.org/projects/thermistor/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_Thermistor/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Thermistor/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
Thermistors are resistors that predictably change resistance with temperature.
This driver uses an analog reading and math to determine the temperature. They
are commonly used as a low cost way to measure temperature.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
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-thermistor/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-thermistor
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-thermistor
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-thermistor
Usage Example
=============
The hardest part of using the driver is its initialization. Here is an example
for the thermistor on the Circuit Playground and Circuit Playground Express. Its
a 10k series resistor, 10k nominal resistance, 25 celsius nominal temperature and
3950 B coefficient.
.. code-block : python
import adafruit_thermistor
import board
thermistor = adafruit_thermistor.Thermistor(board.TEMPERATURE, 10000, 10000, 25, 3950)
print(thermistor.temperature)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/thermistor/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_thermistor/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-thermistor",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, thermal, resistor, temperature, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/33/62/8b9e7d4f2bed61e01a447cab3800d5869fa5640d50b869537e148ccee51b/adafruit_circuitpython_thermistor-3.4.11.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-thermistor/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/thermistor/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_Thermistor/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Thermistor/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\nThermistors are resistors that predictably change resistance with temperature.\nThis driver uses an analog reading and math to determine the temperature. They\nare commonly used as a low cost way to measure temperature.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-thermistor/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-thermistor\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-thermistor\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-thermistor\n\nUsage Example\n=============\n\nThe hardest part of using the driver is its initialization. Here is an example\nfor the thermistor on the Circuit Playground and Circuit Playground Express. Its\na 10k series resistor, 10k nominal resistance, 25 celsius nominal temperature and\n3950 B coefficient.\n\n.. code-block : python\n\n import adafruit_thermistor\n import board\n thermistor = adafruit_thermistor.Thermistor(board.TEMPERATURE, 10000, 10000, 25, 3950)\n print(thermistor.temperature)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/thermistor/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_thermistor/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for Thermistor thermal resistor temperature sensor.",
"version": "3.4.11",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Thermistor"
},
"split_keywords": [
"adafruit",
" thermal",
" resistor",
" temperature",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23f3cbe439abbd019063db9105fe55bccac0db5c4f456ae5b1fa74641fb523bf",
"md5": "743af2339feea917a918241f785cffb8",
"sha256": "695015ebf4534f5c0aac4b1afb4e99b7bc73c9a53af7f9600b6f19d2517f8fb2"
},
"downloads": -1,
"filename": "adafruit_circuitpython_thermistor-3.4.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "743af2339feea917a918241f785cffb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5388,
"upload_time": "2024-04-22T16:54:35",
"upload_time_iso_8601": "2024-04-22T16:54:35.752515Z",
"url": "https://files.pythonhosted.org/packages/23/f3/cbe439abbd019063db9105fe55bccac0db5c4f456ae5b1fa74641fb523bf/adafruit_circuitpython_thermistor-3.4.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33628b9e7d4f2bed61e01a447cab3800d5869fa5640d50b869537e148ccee51b",
"md5": "ad95d1f79539c4b0b4ee4ac132a99f28",
"sha256": "a33c463cdf4c9cca8e233befff8eee6a37dbb51a88658e2d5cb176130d669b7c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_thermistor-3.4.11.tar.gz",
"has_sig": false,
"md5_digest": "ad95d1f79539c4b0b4ee4ac132a99f28",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26218,
"upload_time": "2024-04-22T16:54:38",
"upload_time_iso_8601": "2024-04-22T16:54:38.700843Z",
"url": "https://files.pythonhosted.org/packages/33/62/8b9e7d4f2bed61e01a447cab3800d5869fa5640d50b869537e148ccee51b/adafruit_circuitpython_thermistor-3.4.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 16:54:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Thermistor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-thermistor"
}
JSON
