Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-dht/badge/?version=latest
:target: https://docs.circuitpython.org/projects/dht/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_DHT/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DHT/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 support for the DHT11 and DHT22 temperature and humidity devices.
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>`_.
.. note::
This library uses the `pulseio` module in CircuitPython. As of CircuitPython 7.0.0, `pulseio` is
no longer available on the smallest CircuitPython builds,
such as the Trinket M0, Gemma M0, and Feather M0 Basic boards.
You can substitute a more modern sensor, which will work better as well.
See the guide `Modern Replacements for DHT11 and DHT22 Sensors
<https://learn.adafruit.com/modern-replacements-for-dht11-dht22-sensors>`_
for suggestions.
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-dht/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-dht
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-dht
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-dht
Usage Example
==============
Hardware Set-up
----------------
Designed specifically to work with the Adafruit DHT series sensors:
* Adafruit `DHT22 temperature-humidity sensor + extras <https://www.adafruit.com/products/385>`_
* Adafruit `DHT11 temperature-humidity sensor + extras <https://www.adafruit.com/products/386>`_
.. note::
DHT11 and DHT22 devices both need a pull-resistor on the data signal wire. This resistor is in the range of 1k to 5k
* Please check the device datasheet for the appropriate value.
* Be sure that you are running the Buster Operating System.
* Make sure that your user is part of the ``gpio`` group.
Known Issues
------------
* The library may or may not work in Linux 64-bit platforms.
* The Raspberry PI Zero does not provide reliable readings.
* Readings in FeatherS2 does not work as expected.
.. note::
Using a more modern sensor will avoid these issues.
See the guide `Modern Replacements for DHT11 and DHT22 Sensors
<https://learn.adafruit.com/modern-replacements-for-dht11-dht22-sensors>`_.
Basics
-------
Of course, you must import the library to use it:
.. code:: python
import adafruit_dht
The DHT type devices use single data wire, so import the board pin
.. code:: python
from board import <pin>
Now, to initialize the DHT11 device:
.. code:: python
dht_device = adafruit_dht.DHT11(<pin>)
OR initialize the DHT22 device:
.. code:: python
dht_device = adafruit_dht.DHT22(<pin>)
Read temperature and humidity
------------------------------
Now get the temperature and humidity values
.. code:: python
temperature = dht_device.temperature
humidity = dht_device.humidity
These properties may raise an exception if a problem occurs. You should use try/raise
logic and catch RuntimeError and then retry getting the values after at least 2 seconds.
If you try again to get a result within 2 seconds, cached values are returned.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/dht/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_DHT/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-dht",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,dht,hardware,sensors,temperature,humidity,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/7b/a5/7cb0e37ac291f457c1ca1ba501cb73f179c8ea5e543f51904d04aca148bb/adafruit-circuitpython-dht-4.0.3.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-dht/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/dht/en/latest/\n :alt: Documentation Status\n\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_DHT/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DHT/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 support for the DHT11 and DHT22 temperature and humidity devices.\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\n.. note::\n This library uses the `pulseio` module in CircuitPython. As of CircuitPython 7.0.0, `pulseio` is\n no longer available on the smallest CircuitPython builds,\n such as the Trinket M0, Gemma M0, and Feather M0 Basic boards.\n You can substitute a more modern sensor, which will work better as well.\n See the guide `Modern Replacements for DHT11 and DHT22 Sensors\n <https://learn.adafruit.com/modern-replacements-for-dht11-dht22-sensors>`_\n for suggestions.\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-dht/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-dht\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-dht\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-dht\n\nUsage Example\n==============\n\nHardware Set-up\n----------------\n\nDesigned specifically to work with the Adafruit DHT series sensors:\n\n* Adafruit `DHT22 temperature-humidity sensor + extras <https://www.adafruit.com/products/385>`_\n* Adafruit `DHT11 temperature-humidity sensor + extras <https://www.adafruit.com/products/386>`_\n\n.. note::\n DHT11 and DHT22 devices both need a pull-resistor on the data signal wire. This resistor is in the range of 1k to 5k\n\n\n* Please check the device datasheet for the appropriate value.\n* Be sure that you are running the Buster Operating System.\n* Make sure that your user is part of the ``gpio`` group.\n\n\nKnown Issues\n------------\n\n* The library may or may not work in Linux 64-bit platforms.\n* The Raspberry PI Zero does not provide reliable readings.\n* Readings in FeatherS2 does not work as expected.\n\n.. note::\n Using a more modern sensor will avoid these issues.\n See the guide `Modern Replacements for DHT11 and DHT22 Sensors\n <https://learn.adafruit.com/modern-replacements-for-dht11-dht22-sensors>`_.\n\nBasics\n-------\n\nOf course, you must import the library to use it:\n\n.. code:: python\n\n import adafruit_dht\n\nThe DHT type devices use single data wire, so import the board pin\n\n.. code:: python\n\n from board import <pin>\n\nNow, to initialize the DHT11 device:\n\n.. code:: python\n\n dht_device = adafruit_dht.DHT11(<pin>)\n\nOR initialize the DHT22 device:\n\n.. code:: python\n\n dht_device = adafruit_dht.DHT22(<pin>)\n\nRead temperature and humidity\n------------------------------\n\nNow get the temperature and humidity values\n\n.. code:: python\n\n temperature = dht_device.temperature\n humidity = dht_device.humidity\n\nThese properties may raise an exception if a problem occurs. You should use try/raise\nlogic and catch RuntimeError and then retry getting the values after at least 2 seconds.\nIf you try again to get a result within 2 seconds, cached values are returned.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/dht/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_DHT/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython support for DHT11 and DHT22 type temperature/humidity devices",
"version": "4.0.3",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DHT"
},
"split_keywords": [
"adafruit",
"dht",
"hardware",
"sensors",
"temperature",
"humidity",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e613465950797bd0a2c7e182f25911e4e785fd7b6034f1ecfcc00d4323c3f60",
"md5": "233cb00c7adda96ec96c614302d65f94",
"sha256": "fd7af7793f0fbd903a5577baae17303d90f05bb96470d16c7e1ac7cd7406d6e2"
},
"downloads": -1,
"filename": "adafruit_circuitpython_dht-4.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "233cb00c7adda96ec96c614302d65f94",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7804,
"upload_time": "2023-09-25T15:38:24",
"upload_time_iso_8601": "2023-09-25T15:38:24.400546Z",
"url": "https://files.pythonhosted.org/packages/2e/61/3465950797bd0a2c7e182f25911e4e785fd7b6034f1ecfcc00d4323c3f60/adafruit_circuitpython_dht-4.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ba57cb0e37ac291f457c1ca1ba501cb73f179c8ea5e543f51904d04aca148bb",
"md5": "95691a2d7b287dd91f121d1a38661a45",
"sha256": "351c8094d86c4398a39b79432a376d14020d272744d9f66958251f1192ae4bef"
},
"downloads": -1,
"filename": "adafruit-circuitpython-dht-4.0.3.tar.gz",
"has_sig": false,
"md5_digest": "95691a2d7b287dd91f121d1a38661a45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30521,
"upload_time": "2023-09-25T15:38:25",
"upload_time_iso_8601": "2023-09-25T15:38:25.363203Z",
"url": "https://files.pythonhosted.org/packages/7b/a5/7cb0e37ac291f457c1ca1ba501cb73f179c8ea5e543f51904d04aca148bb/adafruit-circuitpython-dht-4.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:38:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DHT",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-dht"
}
JSON
