Blame view

RIOT/drivers/include/lps331ap.h 3.17 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
113
114
115
116
117
118
119
120
121
  /*
   * Copyright (C) 2014 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_lps331ap LPS331AP Pressure Sensor Driver
   * @ingroup     drivers_sensors
   * @brief       Device driver for the LPS331AP pressure sensor
   * @{
   *
   * @file
   * @brief       Device driver interface for the LPS331AP pressure sensor
   *
   * @note This driver uses the sensors I2C interface
   *
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   */
  
  #ifndef LPS331AP_H
  #define LPS331AP_H
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  #include <stdint.h>
  #include "periph/i2c.h"
  
   /**
    * @brief   The sensors default I2C address
    */
  #define LPS331AP_DEFAULT_ADDRESS        (0x5c)
  
  /**
   * @brief   Device descriptor for LPS331AP sensors
   */
  typedef struct {
      i2c_t i2c;                  /**< I2C device the sensor is connected to */
      uint8_t address;            /**< I2C bus address of the sensor */
  } lps331ap_t;
  
  /**
   * @brief   Possible sampling rates for LPS331AP sensors
   */
  typedef enum {
      LPS331AP_RATE_1HZ = 1,      /**< sample with 1Hz */
      LPS331AP_RATE_7HZ = 5,      /**< sample with 7Hz */
      LPS331AP_RATE_12HZ5 = 6,    /**< sample with 12.5Hz */
      LPS331AP_RATE_25HZ = 7      /**< sample with 25Hz */
  } lps331ap_rate_t;
  
  /**
   * @brief   Struct holding all parameters needed for device initialization
   */
  typedef struct {
      i2c_t i2c;                  /**< I2C bus the sensor is connected to */
      uint8_t addr;               /**< the devices address on the bus */
      lps331ap_rate_t rate;       /**< tell sensor to sample with this rate */
  } lps331ap_params_t;
  
  /**
   * @brief   Initialize a given LPS331AP pressure sensor
   *
   * @param[out] dev      device descriptor of the sensor
   * @param[in]  i2c      I2C bus the sensor is connected to
   * @param[in]  address  the sensor's address on the I2C bus
   * @param[in]  rate     internal sampling rate of the sensor
   *
   * @return              0 on success
   * @return              -1 on error
   */
  int lps331ap_init(lps331ap_t *dev, i2c_t i2c, uint8_t address, lps331ap_rate_t rate);
  
  /**
   * @brief   Read a temperature value from the given sensor, returned in m°C
   *
   * @param[in] dev       device descriptor of sensor to read from
   *
   * @return              temperature value in m°C
   */
  int lps331ap_read_temp(const lps331ap_t *dev);
  
  /**
   * @brief   Read a pressure value from the given sensor, returned in mbar
   *
   * @param[in] dev       device descriptor of sensor to read from
   *
   * @return              pressure value in mbar
   */
  int lps331ap_read_pres(const lps331ap_t *dev);
  
  /**
   * @brief   Enable the given sensor
   *
   * @param[in] dev       device descriptor of sensor to enable
   *
   * @return              0 on success
   * @return              -1 on error
   */
  int lps331ap_enable(const lps331ap_t *dev);
  
  /**
   * @brief   Disable the given sensor
   *
   * @param[in] dev       device descriptor of sensor to disable
   *
   * @return              0 on success
   * @return              -1 on error
   */
  int lps331ap_disable(const lps331ap_t *dev);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* LPS331AP_H */
  /** @} */