chris
/
Weather_ESP
1
0
Bifurcation 0
Code Versions 0 Activité
Repo for ESP32 Weather Station Development
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
4 Révisions
2 Branches
4.3MB
Aborescence: b12deb401c
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de 'b12deb401c'
${ noResults }
Weather_ESP/main/bme280_defs.h

392 lignes
11KB
Brut Annotations Historique 

  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_defs.h

  34. * @date 21/01/2020

  35. * @version  3.4.2

  36. *

  37. */

  38. 

  39. /*! @file bme280_defs.h

  40.  * @brief Sensor driver for BME280 sensor

  41.  */

  42. 

  43. /*!

  44.  * @defgroup BME280 SENSOR API

  45.  * @brief

  46.  */

  47. #ifndef BME280_DEFS_H_

  48. #define BME280_DEFS_H_

  49. 

  50. /********************************************************/

  51. /* header includes */

  52. #ifdef __KERNEL__

  53. #include <linux/types.h>

  54. #include <linux/kernel.h>

  55. #else

  56. #include <stdint.h>

  57. #include <stddef.h>

  58. #endif

  59. 

  60. /********************************************************/

  61. /*! @name       Common macros               */

  62. /********************************************************/

  63. 

  64. #if !defined(UINT8_C) && !defined(INT8_C)

  65. #define INT8_C(x)   S8_C(x)

  66. #define UINT8_C(x)  U8_C(x)

  67. #endif

  68. 

  69. #if !defined(UINT16_C) && !defined(INT16_C)

  70. #define INT16_C(x)  S16_C(x)

  71. #define UINT16_C(x) U16_C(x)

  72. #endif

  73. 

  74. #if !defined(INT32_C) && !defined(UINT32_C)

  75. #define INT32_C(x)  S32_C(x)

  76. #define UINT32_C(x) U32_C(x)

  77. #endif

  78. 

  79. #if !defined(INT64_C) && !defined(UINT64_C)

  80. #define INT64_C(x)  S64_C(x)

  81. #define UINT64_C(x) U64_C(x)

  82. #endif

  83. 

  84. /**@}*/

  85. /**\name C standard macros */

  86. #ifndef NULL

  87. #ifdef __cplusplus

  88. #define NULL 0

  89. #else

  90. #define NULL ((void *) 0)

  91. #endif

  92. #endif

  93. 

  94. /********************************************************/

  95. 

  96. #ifndef BME280_FLOAT_ENABLE

  97. 

  98. /* #define BME280_FLOAT_ENABLE */

  99. #endif

  100. 

  101. #ifndef BME280_FLOAT_ENABLE

  102. #ifndef BME280_64BIT_ENABLE

  103. #define BME280_64BIT_ENABLE

  104. #endif

  105. #endif

  106. 

  107. #ifndef TRUE

  108. #define TRUE                              UINT8_C(1)

  109. #endif

  110. #ifndef FALSE

  111. #define FALSE                             UINT8_C(0)

  112. #endif

  113. 

  114. /**\name I2C addresses */

  115. #define BME280_I2C_ADDR_PRIM              UINT8_C(0x76)

  116. #define BME280_I2C_ADDR_SEC               UINT8_C(0x77)

  117. 

  118. /**\name BME280 chip identifier */

  119. #define BME280_CHIP_ID                    UINT8_C(0x60)

  120. 

  121. /**\name Register Address */

  122. #define BME280_CHIP_ID_ADDR               UINT8_C(0xD0)

  123. #define BME280_RESET_ADDR                 UINT8_C(0xE0)

  124. #define BME280_TEMP_PRESS_CALIB_DATA_ADDR UINT8_C(0x88)

  125. #define BME280_HUMIDITY_CALIB_DATA_ADDR   UINT8_C(0xE1)

  126. #define BME280_PWR_CTRL_ADDR              UINT8_C(0xF4)

  127. #define BME280_CTRL_HUM_ADDR              UINT8_C(0xF2)

  128. #define BME280_CTRL_MEAS_ADDR             UINT8_C(0xF4)

  129. #define BME280_CONFIG_ADDR                UINT8_C(0xF5)

  130. #define BME280_DATA_ADDR                  UINT8_C(0xF7)

  131. 

  132. /**\name API success code */

  133. #define BME280_OK                         INT8_C(0)

  134. 

  135. /**\name API error codes */

  136. #define BME280_E_NULL_PTR                 INT8_C(-1)

  137. #define BME280_E_DEV_NOT_FOUND            INT8_C(-2)

  138. #define BME280_E_INVALID_LEN              INT8_C(-3)

  139. #define BME280_E_COMM_FAIL                INT8_C(-4)

  140. #define BME280_E_SLEEP_MODE_FAIL          INT8_C(-5)

  141. #define BME280_E_NVM_COPY_FAILED          INT8_C(-6)

  142. 

  143. /**\name API warning codes */

  144. #define BME280_W_INVALID_OSR_MACRO        INT8_C(1)

  145. 

  146. /**\name Macros related to size */

  147. #define BME280_TEMP_PRESS_CALIB_DATA_LEN  UINT8_C(26)

  148. #define BME280_HUMIDITY_CALIB_DATA_LEN    UINT8_C(7)

  149. #define BME280_P_T_H_DATA_LEN             UINT8_C(8)

  150. 

  151. /**\name Sensor power modes */

  152. #define BME280_SLEEP_MODE                 UINT8_C(0x00)

  153. #define BME280_FORCED_MODE                UINT8_C(0x01)

  154. #define BME280_NORMAL_MODE                UINT8_C(0x03)

  155. 

  156. /**\name Macro to combine two 8 bit data's to form a 16 bit data */

  157. #define BME280_CONCAT_BYTES(msb, lsb)            (((uint16_t)msb << 8) | (uint16_t)lsb)

  158. 

  159. #define BME280_SET_BITS(reg_data, bitname, data) \

  160.     ((reg_data & ~(bitname##_MSK)) | \

  161.      ((data << bitname##_POS) & bitname##_MSK))

  162. #define BME280_SET_BITS_POS_0(reg_data, bitname, data) \

  163.     ((reg_data & ~(bitname##_MSK)) | \

  164.      (data & bitname##_MSK))

  165. 

  166. #define BME280_GET_BITS(reg_data, bitname)       ((reg_data & (bitname##_MSK)) >> \

  167.                                                   (bitname##_POS))

  168. #define BME280_GET_BITS_POS_0(reg_data, bitname) (reg_data & (bitname##_MSK))

  169. 

  170. /**\name Macros for bit masking */

  171. #define BME280_SENSOR_MODE_MSK      UINT8_C(0x03)

  172. #define BME280_SENSOR_MODE_POS      UINT8_C(0x00)

  173. 

  174. #define BME280_CTRL_HUM_MSK         UINT8_C(0x07)

  175. #define BME280_CTRL_HUM_POS         UINT8_C(0x00)

  176. 

  177. #define BME280_CTRL_PRESS_MSK       UINT8_C(0x1C)

  178. #define BME280_CTRL_PRESS_POS       UINT8_C(0x02)

  179. 

  180. #define BME280_CTRL_TEMP_MSK        UINT8_C(0xE0)

  181. #define BME280_CTRL_TEMP_POS        UINT8_C(0x05)

  182. 

  183. #define BME280_FILTER_MSK           UINT8_C(0x1C)

  184. #define BME280_FILTER_POS           UINT8_C(0x02)

  185. 

  186. #define BME280_STANDBY_MSK          UINT8_C(0xE0)

  187. #define BME280_STANDBY_POS          UINT8_C(0x05)

  188. 

  189. /**\name Sensor component selection macros

  190.  * These values are internal for API implementation. Don't relate this to

  191.  * data sheet.

  192.  */

  193. #define BME280_PRESS                UINT8_C(1)

  194. #define BME280_TEMP                 UINT8_C(1 << 1)

  195. #define BME280_HUM                  UINT8_C(1 << 2)

  196. #define BME280_ALL                  UINT8_C(0x07)

  197. 

  198. /**\name Settings selection macros */

  199. #define BME280_OSR_PRESS_SEL        UINT8_C(1)

  200. #define BME280_OSR_TEMP_SEL         UINT8_C(1 << 1)

  201. #define BME280_OSR_HUM_SEL          UINT8_C(1 << 2)

  202. #define BME280_FILTER_SEL           UINT8_C(1 << 3)

  203. #define BME280_STANDBY_SEL          UINT8_C(1 << 4)

  204. #define BME280_ALL_SETTINGS_SEL     UINT8_C(0x1F)

  205. 

  206. /**\name Oversampling macros */

  207. #define BME280_NO_OVERSAMPLING      UINT8_C(0x00)

  208. #define BME280_OVERSAMPLING_1X      UINT8_C(0x01)

  209. #define BME280_OVERSAMPLING_2X      UINT8_C(0x02)

  210. #define BME280_OVERSAMPLING_4X      UINT8_C(0x03)

  211. #define BME280_OVERSAMPLING_8X      UINT8_C(0x04)

  212. #define BME280_OVERSAMPLING_16X     UINT8_C(0x05)

  213. 

  214. /**\name Measurement delay calculation macros  */

  215. #define BME280_MEAS_OFFSET          UINT16_C(1250)

  216. #define BME280_MEAS_DUR             UINT16_C(2300)

  217. #define BME280_PRES_HUM_MEAS_OFFSET UINT16_C(575)

  218. #define BME280_MEAS_SCALING_FACTOR  UINT16_C(1000)

  219. 

  220. /**\name Standby duration selection macros */

  221. #define BME280_STANDBY_TIME_0_5_MS  (0x00)

  222. #define BME280_STANDBY_TIME_62_5_MS (0x01)

  223. #define BME280_STANDBY_TIME_125_MS  (0x02)

  224. #define BME280_STANDBY_TIME_250_MS  (0x03)

  225. #define BME280_STANDBY_TIME_500_MS  (0x04)

  226. #define BME280_STANDBY_TIME_1000_MS (0x05)

  227. #define BME280_STANDBY_TIME_10_MS   (0x06)

  228. #define BME280_STANDBY_TIME_20_MS   (0x07)

  229. 

  230. /**\name Filter coefficient selection macros */

  231. #define BME280_FILTER_COEFF_OFF     (0x00)

  232. #define BME280_FILTER_COEFF_2       (0x01)

  233. #define BME280_FILTER_COEFF_4       (0x02)

  234. #define BME280_FILTER_COEFF_8       (0x03)

  235. #define BME280_FILTER_COEFF_16      (0x04)

  236. 

  237. #define BME280_STATUS_REG_ADDR      (0xF3)

  238. #define BME280_SOFT_RESET_COMMAND   (0xB6)

  239. #define BME280_STATUS_IM_UPDATE     (0x01)

  240. 

  241. /*!

  242.  * @brief Interface selection Enums

  243.  */

  244. enum bme280_intf {

  245.     /*! SPI interface */

  246.     BME280_SPI_INTF,

  247. 

  248.     /*! I2C interface */

  249.     BME280_I2C_INTF

  250. };

  251. 

  252. /*!

  253.  * @brief Type definitions

  254.  */

  255. typedef int8_t (*bme280_com_fptr_t)(uint8_t dev_id, uint8_t reg_addr, uint8_t *data, uint16_t len);

  256. typedef void (*bme280_delay_fptr_t)(uint32_t period);

  257. 

  258. /*!

  259.  * @brief Calibration data

  260.  */

  261. struct bme280_calib_data

  262. {

  263.     /**

  264.      * @ Trim Variables

  265.      */

  266. 

  267.     /**@{*/

  268.     uint16_t dig_t1;

  269.     int16_t dig_t2;

  270.     int16_t dig_t3;

  271.     uint16_t dig_p1;

  272.     int16_t dig_p2;

  273.     int16_t dig_p3;

  274.     int16_t dig_p4;

  275.     int16_t dig_p5;

  276.     int16_t dig_p6;

  277.     int16_t dig_p7;

  278.     int16_t dig_p8;

  279.     int16_t dig_p9;

  280.     uint8_t dig_h1;

  281.     int16_t dig_h2;

  282.     uint8_t dig_h3;

  283.     int16_t dig_h4;

  284.     int16_t dig_h5;

  285.     int8_t dig_h6;

  286.     int32_t t_fine;

  287. 

  288.     /**@}*/

  289. };

  290. 

  291. /*!

  292.  * @brief bme280 sensor structure which comprises of temperature, pressure and

  293.  * humidity data

  294.  */

  295. #ifdef BME280_FLOAT_ENABLE

  296. struct bme280_data

  297. {

  298.     /*! Compensated pressure */

  299.     double pressure;

  300. 

  301.     /*! Compensated temperature */

  302.     double temperature;

  303. 

  304.     /*! Compensated humidity */

  305.     double humidity;

  306. };

  307. #else

  308. struct bme280_data

  309. {

  310.     /*! Compensated pressure */

  311.     uint32_t pressure;

  312. 

  313.     /*! Compensated temperature */

  314.     int32_t temperature;

  315. 

  316.     /*! Compensated humidity */

  317.     uint32_t humidity;

  318. };

  319. #endif /* BME280_USE_FLOATING_POINT */

  320. 

  321. /*!

  322.  * @brief bme280 sensor structure which comprises of uncompensated temperature,

  323.  * pressure and humidity data

  324.  */

  325. struct bme280_uncomp_data

  326. {

  327.     /*! un-compensated pressure */

  328.     uint32_t pressure;

  329. 

  330.     /*! un-compensated temperature */

  331.     uint32_t temperature;

  332. 

  333.     /*! un-compensated humidity */

  334.     uint32_t humidity;

  335. };

  336. 

  337. /*!

  338.  * @brief bme280 sensor settings structure which comprises of mode,

  339.  * oversampling and filter settings.

  340.  */

  341. struct bme280_settings

  342. {

  343.     /*! pressure oversampling */

  344.     uint8_t osr_p;

  345. 

  346.     /*! temperature oversampling */

  347.     uint8_t osr_t;

  348. 

  349.     /*! humidity oversampling */

  350.     uint8_t osr_h;

  351. 

  352.     /*! filter coefficient */

  353.     uint8_t filter;

  354. 

  355.     /*! standby time */

  356.     uint8_t standby_time;

  357. };

  358. 

  359. /*!

  360.  * @brief bme280 device structure

  361.  */

  362. struct bme280_dev

  363. {

  364.     /*! Chip Id */

  365.     uint8_t chip_id;

  366. 

  367.     /*! Device Id */

  368.     uint8_t dev_id;

  369. 

  370.     /*! SPI/I2C interface */

  371.     enum bme280_intf intf;

  372. 

  373.     /*! Read function pointer */

  374.     bme280_com_fptr_t read;

  375. 

  376.     /*! Write function pointer */

  377.     bme280_com_fptr_t write;

  378. 

  379.     /*! Delay function pointer */

  380.     bme280_delay_fptr_t delay_ms;

  381. 

  382.     /*! Trim data */

  383.     struct bme280_calib_data calib_data;

  384. 

  385.     /*! Sensor settings */

  386.     struct bme280_settings settings;

  387. };

  388. 

  389. #endif /* BME280_DEFS_H_ */

  390. /** @}*/

  391. /** @}*/