No description
Find a file
Scott Shawcroft f78ad3af16 Automock pulseio so RTD can build the docs.
Also, fix DHTLib -> DHT
2017-10-16 16:59:34 -07:00
examples Changed the name of the .py file to adafruit_dht; update api.rst and … (#2) 2017-09-19 12:55:07 -07:00
adafruit_dht.py Changed the name of the .py file to adafruit_dht; update api.rst and … (#2) 2017-09-19 12:55:07 -07:00
api.rst Changed the name of the .py file to adafruit_dht; update api.rst and … (#2) 2017-09-19 12:55:07 -07:00
CODE_OF_CONDUCT.md initial DHT lib supports DHT11 and DHT22 devices 2017-09-14 15:34:17 -07:00
conf.py Automock pulseio so RTD can build the docs. 2017-10-16 16:59:34 -07:00
README.rst Update README for new dht name (not dhtlib) 2017-10-16 16:56:03 -07:00
readthedocs.yml initial DHT lib supports DHT11 and DHT22 devices 2017-09-14 15:34:17 -07:00
requirements.txt initial DHT lib supports DHT11 and DHT22 devices 2017-09-14 15:34:17 -07:00

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-dht/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/dht/en/latest/
    :alt: Documentation Status

.. image :: https://badges.gitter.im/adafruit/circuitpython.svg
    :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
    :alt: Gitter

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

Usage Example
=============

Hardware Set-up
---------------

The 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 your device datasheet for the 
appropriate value.

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 1/2 second.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_DHT/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

API Reference
=============

.. toctree::
   :maxdepth: 2

   api