Blame view

RIOT/drivers/include/hih6130.h 1.89 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
  /*
   * Copyright (C) 2015 Eistec AB
   *
   * 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_hih6130 HIH6130 humidity and temperature sensor
   * @ingroup     drivers_sensors
   * @brief       Device driver for Honeywell HumidIcon Digital
   *              Humidity/Temperature Sensors: HIH-6130/6131 Series
   * @{
   *
   * @file
   * @brief       Device driver for Honeywell HumidIcon Digital
   *              Humidity/Temperature Sensors: HIH-6130/6131 Series
   *
   * @author      Joakim Nohlgård <joakim.nohlgard@eistec.se>
   */
  
  #ifndef HIH6130_H
  #define HIH6130_H
  
  #include <stdint.h>
  
  #include "periph/i2c.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Device descriptor for HIH6130/HIH6131 sensors
   */
  typedef struct {
      i2c_t i2c;              /**< I2C device the sensor is connected to */
      uint8_t addr;           /**< the slave address of the sensor on the I2C bus */
  } hih6130_t;
  
  /**
   * @brief   Initialize a sensor
   *
   * @param[out] dev          device descriptor of sensor to initialize
   * @param[in]  i2c          I2C bus the sensor is connected to
   * @param[in]  address      I2C slave address of the sensor
   */
  void hih6130_init(hih6130_t *dev, i2c_t i2c, uint8_t address);
  
  /**
   * @brief   Read humidity and temperature from sensor and convert to floating-point
   *
   * @param[in]  dev                       Sensor device descriptor
   * @param[out] relative_humidity_percent Measured relative humidity in percent
   * @param[out] temperature_celsius       Measured temperature in degrees Celsius
   *
   * @return 0 on success
   * @return -1 on error
   * @return 1 if data is stale
   */
  int hih6130_get_humidity_temperature_float(const hih6130_t *dev,
      float *relative_humidity_percent, float *temperature_celsius);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* HIH6130_H */
  /** @} */