Metadata-Version: 2.1
Name: RPi.DHT
Version: 0.5.0
Summary: Python implementation for Adafruit_DHT sensor for Raspberry Pi.
Home-page: https://github.com/ricco386/RPi.DHT
Author: Richard von Kellner
Author-email: richard.kellner@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Hardware
Classifier: Topic :: Terminals
Description-Content-Type: text/x-rst
Requires-Dist: Adafruit-Python-DHT
Requires-Dist: RPi.Sensor (>=0.5.3)

RPi.DHT
#######

Python implementation for Adafruit_DHT sensor for Raspberry Pi.

RPi.DHT is using DHT sensor with Raspberry Pi GPIO.

To connect to Raspberry Pi plug DHT sensor data into `GPIO PIN 9 <https://pinout.xyz/pinout/pin21_gpio9#>`_ (Physical
pin 21) and GROUD and POWER PINs. Install and execute RPi.DHT and it should work. Alternatively you can user different
PIN and execute raspi-dht with parameter: ``raspi-dht --pin pin_number``.

.. image:: doc/RPi.DHT.png

RPi.DHT supports number of parameters and also configuration file. For more details see ``raspi-dht --help`` or sample
config.

Sensor is based on `RPi.Sensor <https://github.com/ricco386/RPi.Sensor/>`__ library, which make base for implementing
different types of sensors in Python.

There is an `Ansible role at galaxy <https://galaxy.ansible.com/ricco386/rpi-dht-ansible/>`_, which will do all the
dependencies, config creation, and creates systemd service. Otherwise follow install instructions below...


Pre-Installation requirements
-----------------------------

- Update system and install required dependencies::

    sudo apt-get update

RPi.DHT needs `Adafruit Python DHT Sensor Library <https://github.com/adafruit/Adafruit_Python_DHT>`_. Make sure your
system is able to compile Python extensions. On Raspbian or Debian/Ubuntu image you can ensure your system is ready by
executing::

    sudo apt-get install build-essential python3-dev python3-pip


Installation
------------

- Install the latest released version using pip::

    pip install https://github.com/ricco386/RPi.DHT/tarball/master/

- Alternatively install latest released version from pypi::

    pip install --upgrade RPi.DHT


Integration as a systemd service
--------------------------------

- Make sure all dependencies (listed below) are installed (done automatically when installing via pip)
- The ``raspi-dht`` command should be installed somewhere in your ``PATH`` (done automatically when installing via pip), make sure `raspi-dht.service` has corect path in `ExecStart` set to `raspi-dht` executable.
- Systemd scripts are available: https://github.com/ricco386/RPi.DHT/tree/master/init.d to install them you will need root privileges, so we execute them as sudo::

    sudo cp init.d/raspi-dht.conf /etc/tmpfiles.d/
    sudo cp init.d/raspi-dht.service /etc/systemd/system/
    sudo systemd-tmpfiles --create /etc/tmpfiles.d/raspi-dht.conf
    sudo systemctl enable raspi-dht.service  # Enable service to start at system boot
    sudo systemctl start raspi-dht.service  # Start

Systemd scripts should be run under **default Raspberry Pi user** (pi), scripts have to be able access GPIO.

**Dependencies:**

- `Adafruit_DHT <https://github.com/adafruit/Adafruit_Python_DHT>`_
- `RPi.Sensor <https://github.com/ricco386/RPi.Sensor>`_ (0.5.3+)


Usage
-----

You have to create a `.sensor.cfg` file and place into `/home/pi/.sensor.cfg` you can find example file in RPi.Sensor repo: https://github.com/ricco386/RPi.Sensor/blob/master/raspi_sensor/sensor.cfg.example and create section `[DHT]` where you can override default values.

`raspi-dht` also support multiple parameters to overwrite config parameters. For more info run::

    raspi-dht --help


License
-------

For more information see the `LICENSE <https://github.com/ricco386/RPi.DHT/blob/master/LICENSE>`_ file.


