chris
/
Weather_ESP
1
0
Fork 0
Code Releases 0 Activity
Repo for ESP32 Weather Station Development
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4 Commits
2 Branches
4.3MB
Tree: b12deb401c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'b12deb401c'
${ noResults }
Weather_ESP/main/bme280.h

247 lines
8.8KB
Raw Blame History 

  1. /**

  2. * Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved.

  3. *

  4. * BSD-3-Clause

  5. *

  6. * Redistribution and use in source and binary forms, with or without

  7. * modification, are permitted provided that the following conditions are met:

  8. *

  9. * 1. Redistributions of source code must retain the above copyright

  10. *    notice, this list of conditions and the following disclaimer.

  11. *

  12. * 2. Redistributions in binary form must reproduce the above copyright

  13. *    notice, this list of conditions and the following disclaimer in the

  14. *    documentation and/or other materials provided with the distribution.

  15. *

  16. * 3. Neither the name of the copyright holder nor the names of its

  17. *    contributors may be used to endorse or promote products derived from

  18. *    this software without specific prior written permission.

  19. *

  20. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

  21. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

  22. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

  23. * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

  24. * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

  25. * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

  26. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

  27. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

  28. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

  29. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING

  30. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

  31. * POSSIBILITY OF SUCH DAMAGE.

  32. *

  33. * @file bme280.h

  34. * @date 21/01/2020

  35. * @version  3.4.2

  36. *

  37. */

  38. 

  39. /*! @file bme280.h

  40.  * @brief Sensor driver for BME280 sensor

  41.  */

  42. 

  43. /*!

  44.  * @defgroup BME280 SENSOR API

  45.  */

  46. #ifndef BME280_H_

  47. #define BME280_H_

  48. 

  49. /*! CPP guard */

  50. #ifdef __cplusplus

  51. extern "C" {

  52. #endif

  53. 

  54. /* Header includes */

  55. #include "bme280_defs.h"

  56. 

  57. /*!

  58.  *  @brief This API is the entry point.

  59.  *  It reads the chip-id and calibration data from the sensor.

  60.  *

  61.  *  @param[in,out] dev : Structure instance of bme280_dev

  62.  *

  63.  *  @return Result of API execution status

  64.  *  @retval zero -> Success / +ve value -> Warning / -ve value -> Error

  65.  */

  66. int8_t bme280_init(struct bme280_dev *dev);

  67. 

  68. /*!

  69.  * @brief This API writes the given data to the register address

  70.  * of the sensor.

  71.  *

  72.  * @param[in] reg_addr : Register address from where the data to be written.

  73.  * @param[in] reg_data : Pointer to data buffer which is to be written

  74.  * in the sensor.

  75.  * @param[in] len : No of bytes of data to write..

  76.  * @param[in] dev : Structure instance of bme280_dev.

  77.  *

  78.  * @return Result of API execution status

  79.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

  80.  */

  81. int8_t bme280_set_regs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, const struct bme280_dev *dev);

  82. 

  83. /*!

  84.  * @brief This API reads the data from the given register address of the sensor.

  85.  *

  86.  * @param[in] reg_addr : Register address from where the data to be read

  87.  * @param[out] reg_data : Pointer to data buffer to store the read data.

  88.  * @param[in] len : No of bytes of data to be read.

  89.  * @param[in] dev : Structure instance of bme280_dev.

  90.  *

  91.  * @return Result of API execution status

  92.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

  93.  */

  94. int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, const struct bme280_dev *dev);

  95. 

  96. /*!

  97.  * @brief This API sets the oversampling, filter and standby duration

  98.  * (normal mode) settings in the sensor.

  99.  *

  100.  * @param[in] dev : Structure instance of bme280_dev.

  101.  * @param[in] desired_settings : Variable used to select the settings which

  102.  * are to be set in the sensor.

  103.  *

  104.  * @note : Below are the macros to be used by the user for selecting the

  105.  * desired settings. User can do OR operation of these macros for configuring

  106.  * multiple settings.

  107.  *

  108.  * Macros         |   Functionality

  109.  * -----------------------|----------------------------------------------

  110.  * BME280_OSR_PRESS_SEL    |   To set pressure oversampling.

  111.  * BME280_OSR_TEMP_SEL     |   To set temperature oversampling.

  112.  * BME280_OSR_HUM_SEL    |   To set humidity oversampling.

  113.  * BME280_FILTER_SEL     |   To set filter setting.

  114.  * BME280_STANDBY_SEL  |   To set standby duration setting.

  115.  *

  116.  * @return Result of API execution status

  117.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.

  118.  */

  119. int8_t bme280_set_sensor_settings(uint8_t desired_settings, const struct bme280_dev *dev);

  120. 

  121. /*!

  122.  * @brief This API gets the oversampling, filter and standby duration

  123.  * (normal mode) settings from the sensor.

  124.  *

  125.  * @param[in,out] dev : Structure instance of bme280_dev.

  126.  *

  127.  * @return Result of API execution status

  128.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.

  129.  */

  130. int8_t bme280_get_sensor_settings(struct bme280_dev *dev);

  131. 

  132. /*!

  133.  * @brief This API sets the power mode of the sensor.

  134.  *

  135.  * @param[in] dev : Structure instance of bme280_dev.

  136.  * @param[in] sensor_mode : Variable which contains the power mode to be set.

  137.  *

  138.  *    sensor_mode           |   Macros

  139.  * ---------------------|-------------------

  140.  *     0                | BME280_SLEEP_MODE

  141.  *     1                | BME280_FORCED_MODE

  142.  *     3                | BME280_NORMAL_MODE

  143.  *

  144.  * @return Result of API execution status

  145.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

  146.  */

  147. int8_t bme280_set_sensor_mode(uint8_t sensor_mode, const struct bme280_dev *dev);

  148. 

  149. /*!

  150.  * @brief This API gets the power mode of the sensor.

  151.  *

  152.  * @param[in] dev : Structure instance of bme280_dev.

  153.  * @param[out] sensor_mode : Pointer variable to store the power mode.

  154.  *

  155.  *   sensor_mode            |   Macros

  156.  * ---------------------|-------------------

  157.  *     0                | BME280_SLEEP_MODE

  158.  *     1                | BME280_FORCED_MODE

  159.  *     3                | BME280_NORMAL_MODE

  160.  *

  161.  * @return Result of API execution status

  162.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

  163.  */

  164. int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, const struct bme280_dev *dev);

  165. 

  166. /*!

  167.  * @brief This API performs the soft reset of the sensor.

  168.  *

  169.  * @param[in] dev : Structure instance of bme280_dev.

  170.  *

  171.  * @return Result of API execution status

  172.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.

  173.  */

  174. int8_t bme280_soft_reset(const struct bme280_dev *dev);

  175. 

  176. /*!

  177.  * @brief This API reads the pressure, temperature and humidity data from the

  178.  * sensor, compensates the data and store it in the bme280_data structure

  179.  * instance passed by the user.

  180.  *

  181.  * @param[in] sensor_comp : Variable which selects which data to be read from

  182.  * the sensor.

  183.  *

  184.  * sensor_comp |   Macros

  185.  * ------------|-------------------

  186.  *     1       | BME280_PRESS

  187.  *     2       | BME280_TEMP

  188.  *     4       | BME280_HUM

  189.  *     7       | BME280_ALL

  190.  *

  191.  * @param[out] comp_data : Structure instance of bme280_data.

  192.  * @param[in] dev : Structure instance of bme280_dev.

  193.  *

  194.  * @return Result of API execution status

  195.  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

  196.  */

  197. int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev);

  198. 

  199. /*!

  200.  *  @brief This API is used to parse the pressure, temperature and

  201.  *  humidity data and store it in the bme280_uncomp_data structure instance.

  202.  *

  203.  *  @param[in] reg_data     : Contains register data which needs to be parsed

  204.  *  @param[out] uncomp_data : Contains the uncompensated pressure, temperature

  205.  *  and humidity data.

  206.  */

  207. void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data);

  208. 

  209. /*!

  210.  * @brief This API is used to compensate the pressure and/or

  211.  * temperature and/or humidity data according to the component selected by the

  212.  * user.

  213.  *

  214.  * @param[in] sensor_comp : Used to select pressure and/or temperature and/or

  215.  * humidity.

  216.  * @param[in] uncomp_data : Contains the uncompensated pressure, temperature and

  217.  * humidity data.

  218.  * @param[out] comp_data : Contains the compensated pressure and/or temperature

  219.  * and/or humidity data.

  220.  * @param[in] calib_data : Pointer to the calibration data structure.

  221.  *

  222.  * @return Result of API execution status.

  223.  * @retval zero -> Success / -ve value -> Error

  224.  */

  225. int8_t bme280_compensate_data(uint8_t sensor_comp,

  226.                               const struct bme280_uncomp_data *uncomp_data,

  227.                               struct bme280_data *comp_data,

  228.                               struct bme280_calib_data *calib_data);

  229. 

  230. /*!

  231.  * @brief This API is used to calculate the maximum delay in milliseconds required for the

  232.  * temperature/pressure/humidity(which ever are enabled) measurement to complete.

  233.  * The delay depends upon the number of sensors enabled and their oversampling configuration.

  234.  *

  235.  * @param[in] settings : contains the oversampling configurations.

  236.  *

  237.  * @return delay required in milliseconds.

  238.  */

  239. 

  240. uint32_t bme280_cal_meas_delay(const struct bme280_settings *settings);

  241. 

  242. #ifdef __cplusplus

  243. }

  244. #endif /* End of CPP guard */

  245. #endif /* BME280_H_ */

  246. /** @}*/