Blame view

RIOT/drivers/include/dht.h 2.92 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
  /*
   * Copyright 2015 Ludwig Knüpfer,
   *           2015 Christian Mehlis
   *           2016-2017 Freie Universität Berlin
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    drivers_dht DHT Family of Humidity and Temperature Sensors
   * @ingroup     drivers_sensors
   * @brief       Device driver for the DHT Family of humidity
   *              and temperature sensors
   *
   * @{
   *
   * @file
   * @brief       Device driver interface for the DHT family of humidity
   *              and temperature sensors
   *
   * @author      Ludwig Knüpfer <ludwig.knuepfer@fu-berlin.de
   * @author      Christian Mehlis <mehlis@inf.fu-berlin.de>
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   */
  
  #ifndef DHT_H
  #define DHT_H
  
  #include <stdint.h>
  
  #include "periph/gpio.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Possible return codes
   */
  enum {
      DHT_OK      =  0,       /**< all good */
      DHT_NOCSUM  = -1,       /**< checksum error */
      DHT_NODEV   = -2        /**< device type not defined */
  };
  
  /**
   * @brief   Data type for storing DHT sensor readings
   */
  typedef struct {
      uint16_t humidity;      /**< relative deca-humidity */
      uint16_t temperature;   /**< temperature in deca-Celsius */
  } dht_data_t;
  
  /**
   * @brief   Device type of the DHT device
   */
  typedef enum {
      DHT11,                  /**< DHT11 device identifier */
      DHT22,                  /**< DHT22 device identifier */
      DHT21 = DHT22           /**< DHT21 device identifier */
  } dht_type_t;
  
  /**
   * @brief   Device descriptor for DHT sensor devices
   */
  typedef struct {
      gpio_t pin;             /**< GPIO pin of the device's data pin */
      dht_type_t type;        /**< type of the DHT device */
      gpio_mode_t in_mode;    /**< input pin configuration, with or without pull
                               *   resistor */
  } dht_t;
  
  /**
   * @brief   Configuration parameters for DHT devices
   */
  typedef dht_t dht_params_t;
  
  /**
   * @brief   Initialize a new DHT device
   *
   * @param[out] dev      device descriptor of a DHT device
   * @param[in]  params   configuration parameters
   *
   * @return              0 on success
   * @return              -1 on error
   */
  int dht_init(dht_t *dev, const dht_params_t *params);
  
  /**
   * @brief   get a new temperature and humidity value from the device
   *
   * @note    if reading fails or checksum is invalid, no new values will be
   *          written into the result values
   *
   * @param[in]  dev      device descriptor of a DHT device
   * @param[out] temp     temperature value [in °C * 10^-1]
   * @param[out] hum      relative humidity value [in percent * 10^-1]
   *
   * @return              0 on success
   * @return              -1 on checksum error
   * @return              -2 on parsing error
   */
  int dht_read(const dht_t *dev, int16_t *temp, int16_t *hum);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* DHT_H */
  /** @} */