2 * Copyright (C) 2016 - 2017 Bosch Sensortec GmbH
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
10 * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * Neither the name of the copyright holder nor the names of the
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
23 * OR CONTRIBUTORS BE LIABLE FOR ANY
24 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
25 * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
34 * The information provided is believed to be accurate and reliable.
35 * The copyright holder assumes no responsibility
36 * for the consequences of use
37 * of such information nor for any infringement of patents or
38 * other rights of third parties which may result from its use.
39 * No license is granted by implication or otherwise under any patent or
40 * patent rights of the copyright holder.
49 @brief Sensor driver for BME280 sensor */
51 * @defgroup BME280 SENSOR API
62 #include "bme280_defs.h"
65 * @brief This API is the entry point.
66 * It reads the chip-id and calibration data from the sensor.
68 * @param[in,out] dev : Structure instance of bme280_dev
70 * @return Result of API execution status
71 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
73 int8_t bme280_init(struct bme280_dev *dev);
76 * @brief This API writes the given data to the register address
79 * @param[in] reg_addr : Register address from where the data to be written.
80 * @param[in] reg_data : Pointer to data buffer which is to be written
82 * @param[in] len : No of bytes of data to write..
83 * @param[in] dev : Structure instance of bme280_dev.
85 * @return Result of API execution status
86 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
88 int8_t bme280_set_regs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, const struct bme280_dev *dev);
91 * @brief This API reads the data from the given register address of the sensor.
93 * @param[in] reg_addr : Register address from where the data to be read
94 * @param[out] reg_data : Pointer to data buffer to store the read data.
95 * @param[in] len : No of bytes of data to be read.
96 * @param[in] dev : Structure instance of bme280_dev.
98 * @return Result of API execution status
99 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
101 int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, const struct bme280_dev *dev);
104 * @brief This API sets the oversampling, filter and standby duration
105 * (normal mode) settings in the sensor.
107 * @param[in] dev : Structure instance of bme280_dev.
108 * @param[in] desired_settings : Variable used to select the settings which
109 * are to be set in the sensor.
111 * @note : Below are the macros to be used by the user for selecting the
112 * desired settings. User can do OR operation of these macros for configuring
115 * Macros | Functionality
116 * -----------------------|----------------------------------------------
117 * BME280_OSR_PRESS_SEL | To set pressure oversampling.
118 * BME280_OSR_TEMP_SEL | To set temperature oversampling.
119 * BME280_OSR_HUM_SEL | To set humidity oversampling.
120 * BME280_FILTER_SEL | To set filter setting.
121 * BME280_STANDBY_SEL | To set standby duration setting.
123 * @return Result of API execution status
124 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
126 int8_t bme280_set_sensor_settings(uint8_t desired_settings, const struct bme280_dev *dev);
129 * @brief This API gets the oversampling, filter and standby duration
130 * (normal mode) settings from the sensor.
132 * @param[in,out] dev : Structure instance of bme280_dev.
134 * @return Result of API execution status
135 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
137 int8_t bme280_get_sensor_settings(struct bme280_dev *dev);
140 * @brief This API sets the power mode of the sensor.
142 * @param[in] dev : Structure instance of bme280_dev.
143 * @param[in] sensor_mode : Variable which contains the power mode to be set.
145 * sensor_mode | Macros
146 * ---------------------|-------------------
147 * 0 | BME280_SLEEP_MODE
148 * 1 | BME280_FORCED_MODE
149 * 3 | BME280_NORMAL_MODE
151 * @return Result of API execution status
152 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
154 int8_t bme280_set_sensor_mode(uint8_t sensor_mode,
155 const struct bme280_dev *dev);
158 * @brief This API gets the power mode of the sensor.
160 * @param[in] dev : Structure instance of bme280_dev.
161 * @param[out] sensor_mode : Pointer variable to store the power mode.
163 * sensor_mode | Macros
164 * ---------------------|-------------------
165 * 0 | BME280_SLEEP_MODE
166 * 1 | BME280_FORCED_MODE
167 * 3 | BME280_NORMAL_MODE
169 * @return Result of API execution status
170 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
172 int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, const struct bme280_dev *dev);
175 * @brief This API performs the soft reset of the sensor.
177 * @param[in] dev : Structure instance of bme280_dev.
179 * @return Result of API execution status
180 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
182 int8_t bme280_soft_reset(const struct bme280_dev *dev);
185 * @brief This API reads the pressure, temperature and humidity data from the
186 * sensor, compensates the data and store it in the bme280_data structure
187 * instance passed by the user.
189 * @param[in] sensor_comp : Variable which selects which data to be read from
192 * sensor_comp | Macros
193 * ------------|-------------------
199 * @param[out] comp_data : Structure instance of bme280_data.
200 * @param[in] dev : Structure instance of bme280_dev.
202 * @return Result of API execution status
203 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
205 int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev);
208 * @brief This API is used to parse the pressure, temperature and
209 * humidity data and store it in the bme280_uncomp_data structure instance.
211 * @param[in] reg_data : Contains register data which needs to be parsed
212 * @param[out] uncomp_data : Contains the uncompensated pressure, temperature
215 void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data);
218 * @brief This API is used to compensate the pressure and/or
219 * temperature and/or humidity data according to the component selected by the
222 * @param[in] sensor_comp : Used to select pressure and/or temperature and/or
224 * @param[in] uncomp_data : Contains the uncompensated pressure, temperature and
226 * @param[out] comp_data : Contains the compensated pressure and/or temperature
227 * and/or humidity data.
228 * @param[in] calib_data : Pointer to the calibration data structure.
230 * @return Result of API execution status.
231 * @retval zero -> Success / -ve value -> Error
233 int8_t bme280_compensate_data(uint8_t sensor_comp, const struct bme280_uncomp_data *uncomp_data,
234 struct bme280_data *comp_data, struct bme280_calib_data *calib_data);
238 #endif /* End of CPP guard */
239 #endif /* BME280_H_ */