https://github.com/adafruit/adafruit_circuitpython_thermistor

Driver for producing a temperature measurement from a thermistor.
https://github.com/adafruit/adafruit_circuitpython_thermistor

circuitpython hacktoberfest temperature

Last synced: 5 months ago
JSON representation

Driver for producing a temperature measurement from a thermistor.

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_thermistor
• Owner: adafruit
• License: mit
• Created: 2017-02-22T10:32:15.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2025-01-16T19:16:38.000Z (about 1 year ago)
• Last Synced: 2025-01-28T22:37:37.750Z (about 1 year ago)
• Topics: circuitpython, hacktoberfest, temperature
• Language: Python
• Size: 123 KB
• Stars: 2
• Watchers: 21
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          

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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json

    :target: https://github.com/astral-sh/ruff

    :alt: Code Style: Ruff

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 `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_.

Installing from PyPI

=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_. 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 `_.

For information on building library documentation, please check out `this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.