Metadata-Version: 2.1
Name: check-dht
Version: 0.1.0
Summary: Nagios Plugin for monitoring temperature and humidity from a Raspberry Pi
Home-page: https://github.com/j0hax/check-dht
License:  GPL-3.0-or-later
Keywords: nagios,monitoring
Author: Johannes Arnold
Author-email: johannes.arnold@stud.uni-hannover.de
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: nagiosplugin (>=1.3.3,<2.0.0)
Requires-Dist: pyserial (>=3.5,<4.0)
Project-URL: Repository, https://github.com/j0hax/check-dht
Description-Content-Type: text/markdown

# check-dht
Nagios Plugin for monitoring temperature and humidity from a Raspberry Pi

**Notice:** This plugin works in conjuction with the [pico-dht](https://github.com/j0hax/pico-dht) project!

## Install
This software has two dependencies:

1. [pySerial](https://pyserial.readthedocs.io/en/stable/)
2. [nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable/)

Both should be available for installation from your distribution's package manager and `pip`.

## Overview
### Example output with default parameters
```console
$ check_dht
DHT OK - 24.2 °C | error=0 humidity=34.9;40;50;0;100 temperature=24.2;30;40;-40;80
```

### Usage
```console
$ check_dht -h
usage: check_dht [-h] [-p PORT] [-b BAUD] [-w TEMP] [-c TEMP]
                 [--humidity-warning PERCENT] [--humidity-critical PERCENT]

Nagios Plugin to monitor DHT22/AM2302 data

optional arguments:
  -h, --help            show this help message and exit
  -p PORT, --port PORT  the serial file to read from
  -b BAUD, --baud BAUD  baudrate of the serial port
  -w TEMP, --warning TEMP
                        return warning if air temperature is outside TEMP
  -c TEMP, --critical TEMP
                        return critical if air temperature is outside TEMP
  --humidity-warning PERCENT
                        return warning if humidity is outside PERCENT
  --humidity-critical PERCENT
                        return critical if humidity is outside PERCENT

(c) Johannes Arnold 2023. This software is published under the terms of the
GNU GPLv3. For the companion project to this plugin, see
https://github.com/j0hax/dht22
```



