]> git.itanic.dy.fi Git - BME280_driver/blobdiff - bme280.c
Updated license and formatting
[BME280_driver] / bme280.c
index 565afce3ecbfcaf2d0cfaad6273444b9534bb0ae..608511509655d2961a7c00f21202490b2f3a51d3 100644 (file)
--- a/bme280.c
+++ b/bme280.c
@@ -1,49 +1,40 @@
-/**\mainpage\r
- * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH\r
- *\r
- * Redistribution and use in source and binary forms, with or without\r
- * modification, are permitted provided that the following conditions are met:\r
- *\r
- * Redistributions of source code must retain the above copyright\r
- * notice, this list of conditions and the following disclaimer.\r
- *\r
- * Redistributions in binary form must reproduce the above copyright\r
- * notice, this list of conditions and the following disclaimer in the\r
- * documentation and/or other materials provided with the distribution.\r
- *\r
- * Neither the name of the copyright holder nor the names of the\r
- * contributors may be used to endorse or promote products derived from\r
- * this software without specific prior written permission.\r
- *\r
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\r
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR\r
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
- * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER\r
- * OR CONTRIBUTORS BE LIABLE FOR ANY\r
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,\r
- * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,\r
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
- * ANY WAY OUT OF THE USE OF THIS\r
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE\r
- *\r
- * The information provided is believed to be accurate and reliable.\r
- * The copyright holder assumes no responsibility\r
- * for the consequences of use\r
- * of such information nor for any infringement of patents or\r
- * other rights of third parties which may result from its use.\r
- * No license is granted by implication or otherwise under any patent or\r
- * patent rights of the copyright holder.\r
- *\r
- * File     bme280.c\r
- * Date     26 Aug 2019\r
- * Version  3.3.7\r
- *\r
- */\r
+/**\r
+* Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved.\r
+*\r
+* BSD-3-Clause\r
+*\r
+* Redistribution and use in source and binary forms, with or without\r
+* modification, are permitted provided that the following conditions are met:\r
+*\r
+* 1. Redistributions of source code must retain the above copyright\r
+*    notice, this list of conditions and the following disclaimer.\r
+*\r
+* 2. Redistributions in binary form must reproduce the above copyright\r
+*    notice, this list of conditions and the following disclaimer in the\r
+*    documentation and/or other materials provided with the distribution.\r
+*\r
+* 3. Neither the name of the copyright holder nor the names of its\r
+*    contributors may be used to endorse or promote products derived from\r
+*    this software without specific prior written permission.\r
+*\r
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
+* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
+* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\r
+* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\r
+* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\r
+* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
+* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
+* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
+* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
+* POSSIBILITY OF SUCH DAMAGE.\r
+*\r
+* @file bme280.c\r
+* @date 10/01/2020\r
+* @version  3.4.1\r
+*\r
+*/\r
 \r
 /*! @file bme280.c\r
  * @brief Sensor driver for BME280 sensor\r
@@ -731,9 +722,9 @@ void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data
     data_xlsb = (uint32_t)reg_data[5] >> 4;\r
     uncomp_data->temperature = data_msb | data_lsb | data_xlsb;\r
 \r
-    /* Store the parsed register values for temperature data */\r
-    data_lsb = (uint32_t)reg_data[6] << 8;\r
-    data_msb = (uint32_t)reg_data[7];\r
+    /* Store the parsed register values for humidity data */\r
+    data_msb = (uint32_t)reg_data[6] << 8;\r
+    data_lsb = (uint32_t)reg_data[7];\r
     uncomp_data->humidity = data_msb | data_lsb;\r
 }\r
 \r
@@ -781,6 +772,56 @@ int8_t bme280_compensate_data(uint8_t sensor_comp,
     return rslt;\r
 }\r
 \r
+/*!\r
+ * @brief This API is used to calculate the maximum delay in milliseconds required for the\r
+ * temperature/pressure/humidity(which ever at enabled) measurement to complete.\r
+ */\r
+uint32_t bme280_cal_meas_delay(const struct bme280_settings *settings)\r
+{\r
+    uint32_t max_delay;\r
+    uint8_t temp_osr;\r
+    uint8_t pres_osr;\r
+    uint8_t hum_osr;\r
+\r
+    /*Array to map OSR config register value to actual OSR */\r
+    uint8_t osr_sett_to_act_osr[] = { 0, 1, 2, 4, 8, 16 };\r
+\r
+    /* Mapping osr settings to the actual osr values e.g. 0b101 -> osr X16  */\r
+    if (settings->osr_t <= 5)\r
+    {\r
+        temp_osr = osr_sett_to_act_osr[settings->osr_t];\r
+    }\r
+    else\r
+    {\r
+        temp_osr = 16;\r
+    }\r
+\r
+    if (settings->osr_p <= 5)\r
+    {\r
+        pres_osr = osr_sett_to_act_osr[settings->osr_p];\r
+    }\r
+    else\r
+    {\r
+        pres_osr = 16;\r
+    }\r
+\r
+    if (settings->osr_h <= 5)\r
+    {\r
+        hum_osr = osr_sett_to_act_osr[settings->osr_h];\r
+    }\r
+    else\r
+    {\r
+        hum_osr = 16;\r
+    }\r
+\r
+    max_delay =\r
+        (uint32_t)((BME280_MEAS_OFFSET + (BME280_MEAS_DUR * temp_osr) +\r
+                    ((BME280_MEAS_DUR * pres_osr) + BME280_PRES_HUM_MEAS_OFFSET) +\r
+                    ((BME280_MEAS_DUR * hum_osr) + BME280_PRES_HUM_MEAS_OFFSET)) / BME280_MEAS_SCALING_FACTOR);\r
+\r
+    return max_delay;\r
+}\r
+\r
 /*!\r
  * @brief This internal API sets the oversampling settings for pressure,\r
  * temperature and humidity in the sensor.\r
@@ -1143,10 +1184,10 @@ static int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_da
     int32_t temperature_min = -4000;\r
     int32_t temperature_max = 8500;\r
 \r
-    var1 = (int32_t)((uncomp_data->temperature / 8) - ((int32_t)calib_data->dig_T1 * 2));\r
-    var1 = (var1 * ((int32_t)calib_data->dig_T2)) / 2048;\r
-    var2 = (int32_t)((uncomp_data->temperature / 16) - ((int32_t)calib_data->dig_T1));\r
-    var2 = (((var2 * var2) / 4096) * ((int32_t)calib_data->dig_T3)) / 16384;\r
+    var1 = (int32_t)((uncomp_data->temperature / 8) - ((int32_t)calib_data->dig_t1 * 2));\r
+    var1 = (var1 * ((int32_t)calib_data->dig_t2)) / 2048;\r
+    var2 = (int32_t)((uncomp_data->temperature / 16) - ((int32_t)calib_data->dig_t1));\r
+    var2 = (((var2 * var2) / 4096) * ((int32_t)calib_data->dig_t3)) / 16384;\r
     calib_data->t_fine = var1 + var2;\r
     temperature = (calib_data->t_fine * 5 + 128) / 256;\r
     if (temperature < temperature_min)\r
@@ -1179,21 +1220,21 @@ static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data
     uint32_t pressure_max = 11000000;\r
 \r
     var1 = ((int64_t)calib_data->t_fine) - 128000;\r
-    var2 = var1 * var1 * (int64_t)calib_data->dig_P6;\r
-    var2 = var2 + ((var1 * (int64_t)calib_data->dig_P5) * 131072);\r
-    var2 = var2 + (((int64_t)calib_data->dig_P4) * 34359738368);\r
-    var1 = ((var1 * var1 * (int64_t)calib_data->dig_P3) / 256) + ((var1 * ((int64_t)calib_data->dig_P2) * 4096));\r
+    var2 = var1 * var1 * (int64_t)calib_data->dig_p6;\r
+    var2 = var2 + ((var1 * (int64_t)calib_data->dig_p5) * 131072);\r
+    var2 = var2 + (((int64_t)calib_data->dig_p4) * 34359738368);\r
+    var1 = ((var1 * var1 * (int64_t)calib_data->dig_p3) / 256) + ((var1 * ((int64_t)calib_data->dig_p2) * 4096));\r
     var3 = ((int64_t)1) * 140737488355328;\r
-    var1 = (var3 + var1) * ((int64_t)calib_data->dig_P1) / 8589934592;\r
+    var1 = (var3 + var1) * ((int64_t)calib_data->dig_p1) / 8589934592;\r
 \r
     /* To avoid divide by zero exception */\r
     if (var1 != 0)\r
     {\r
         var4 = 1048576 - uncomp_data->pressure;\r
         var4 = (((var4 * INT64_C(2147483648)) - var2) * 3125) / var1;\r
-        var1 = (((int64_t)calib_data->dig_P9) * (var4 / 8192) * (var4 / 8192)) / 33554432;\r
-        var2 = (((int64_t)calib_data->dig_P8) * var4) / 524288;\r
-        var4 = ((var4 + var1 + var2) / 256) + (((int64_t)calib_data->dig_P7) * 16);\r
+        var1 = (((int64_t)calib_data->dig_p9) * (var4 / 8192) * (var4 / 8192)) / 33554432;\r
+        var2 = (((int64_t)calib_data->dig_p8) * var4) / 524288;\r
+        var4 = ((var4 + var1 + var2) / 256) + (((int64_t)calib_data->dig_p7) * 16);\r
         pressure = (uint32_t)(((var4 / 2) * 100) / 128);\r
         if (pressure < pressure_min)\r
         {\r
@@ -1289,16 +1330,16 @@ static uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data
 \r
     var1 = calib_data->t_fine - ((int32_t)76800);\r
     var2 = (int32_t)(uncomp_data->humidity * 16384);\r
-    var3 = (int32_t)(((int32_t)calib_data->dig_H4) * 1048576);\r
-    var4 = ((int32_t)calib_data->dig_H5) * var1;\r
+    var3 = (int32_t)(((int32_t)calib_data->dig_h4) * 1048576);\r
+    var4 = ((int32_t)calib_data->dig_h5) * var1;\r
     var5 = (((var2 - var3) - var4) + (int32_t)16384) / 32768;\r
-    var2 = (var1 * ((int32_t)calib_data->dig_H6)) / 1024;\r
-    var3 = (var1 * ((int32_t)calib_data->dig_H3)) / 2048;\r
+    var2 = (var1 * ((int32_t)calib_data->dig_h6)) / 1024;\r
+    var3 = (var1 * ((int32_t)calib_data->dig_h3)) / 2048;\r
     var4 = ((var2 * (var3 + (int32_t)32768)) / 1024) + (int32_t)2097152;\r
-    var2 = ((var4 * ((int32_t)calib_data->dig_H2)) + 8192) / 16384;\r
+    var2 = ((var4 * ((int32_t)calib_data->dig_h2)) + 8192) / 16384;\r
     var3 = var5 * var2;\r
     var4 = ((var3 / 32768) * (var3 / 32768)) / 128;\r
-    var5 = var3 - ((var4 * ((int32_t)calib_data->dig_H1)) / 16);\r
+    var5 = var3 - ((var4 * ((int32_t)calib_data->dig_h1)) / 16);\r
     var5 = (var5 < 0 ? 0 : var5);\r
     var5 = (var5 > 419430400 ? 419430400 : var5);\r
     humidity = (uint32_t)(var5 / 4096);\r
@@ -1370,19 +1411,19 @@ static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_d
 {\r
     struct bme280_calib_data *calib_data = &dev->calib_data;\r
 \r
-    calib_data->dig_T1 = BME280_CONCAT_BYTES(reg_data[1], reg_data[0]);\r
-    calib_data->dig_T2 = (int16_t)BME280_CONCAT_BYTES(reg_data[3], reg_data[2]);\r
-    calib_data->dig_T3 = (int16_t)BME280_CONCAT_BYTES(reg_data[5], reg_data[4]);\r
-    calib_data->dig_P1 = BME280_CONCAT_BYTES(reg_data[7], reg_data[6]);\r
-    calib_data->dig_P2 = (int16_t)BME280_CONCAT_BYTES(reg_data[9], reg_data[8]);\r
-    calib_data->dig_P3 = (int16_t)BME280_CONCAT_BYTES(reg_data[11], reg_data[10]);\r
-    calib_data->dig_P4 = (int16_t)BME280_CONCAT_BYTES(reg_data[13], reg_data[12]);\r
-    calib_data->dig_P5 = (int16_t)BME280_CONCAT_BYTES(reg_data[15], reg_data[14]);\r
-    calib_data->dig_P6 = (int16_t)BME280_CONCAT_BYTES(reg_data[17], reg_data[16]);\r
-    calib_data->dig_P7 = (int16_t)BME280_CONCAT_BYTES(reg_data[19], reg_data[18]);\r
-    calib_data->dig_P8 = (int16_t)BME280_CONCAT_BYTES(reg_data[21], reg_data[20]);\r
-    calib_data->dig_P9 = (int16_t)BME280_CONCAT_BYTES(reg_data[23], reg_data[22]);\r
-    calib_data->dig_H1 = reg_data[25];\r
+    calib_data->dig_t1 = BME280_CONCAT_BYTES(reg_data[1], reg_data[0]);\r
+    calib_data->dig_t2 = (int16_t)BME280_CONCAT_BYTES(reg_data[3], reg_data[2]);\r
+    calib_data->dig_t3 = (int16_t)BME280_CONCAT_BYTES(reg_data[5], reg_data[4]);\r
+    calib_data->dig_p1 = BME280_CONCAT_BYTES(reg_data[7], reg_data[6]);\r
+    calib_data->dig_p2 = (int16_t)BME280_CONCAT_BYTES(reg_data[9], reg_data[8]);\r
+    calib_data->dig_p3 = (int16_t)BME280_CONCAT_BYTES(reg_data[11], reg_data[10]);\r
+    calib_data->dig_p4 = (int16_t)BME280_CONCAT_BYTES(reg_data[13], reg_data[12]);\r
+    calib_data->dig_p5 = (int16_t)BME280_CONCAT_BYTES(reg_data[15], reg_data[14]);\r
+    calib_data->dig_p6 = (int16_t)BME280_CONCAT_BYTES(reg_data[17], reg_data[16]);\r
+    calib_data->dig_p7 = (int16_t)BME280_CONCAT_BYTES(reg_data[19], reg_data[18]);\r
+    calib_data->dig_p8 = (int16_t)BME280_CONCAT_BYTES(reg_data[21], reg_data[20]);\r
+    calib_data->dig_p9 = (int16_t)BME280_CONCAT_BYTES(reg_data[23], reg_data[22]);\r
+    calib_data->dig_h1 = reg_data[25];\r
 }\r
 \r
 /*!\r
@@ -1392,20 +1433,20 @@ static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_d
 static void parse_humidity_calib_data(const uint8_t *reg_data, struct bme280_dev *dev)\r
 {\r
     struct bme280_calib_data *calib_data = &dev->calib_data;\r
-    int16_t dig_H4_lsb;\r
-    int16_t dig_H4_msb;\r
-    int16_t dig_H5_lsb;\r
-    int16_t dig_H5_msb;\r
-\r
-    calib_data->dig_H2 = (int16_t)BME280_CONCAT_BYTES(reg_data[1], reg_data[0]);\r
-    calib_data->dig_H3 = reg_data[2];\r
-    dig_H4_msb = (int16_t)(int8_t)reg_data[3] * 16;\r
-    dig_H4_lsb = (int16_t)(reg_data[4] & 0x0F);\r
-    calib_data->dig_H4 = dig_H4_msb | dig_H4_lsb;\r
-    dig_H5_msb = (int16_t)(int8_t)reg_data[5] * 16;\r
-    dig_H5_lsb = (int16_t)(reg_data[4] >> 4);\r
-    calib_data->dig_H5 = dig_H5_msb | dig_H5_lsb;\r
-    calib_data->dig_H6 = (int8_t)reg_data[6];\r
+    int16_t dig_h4_lsb;\r
+    int16_t dig_h4_msb;\r
+    int16_t dig_h5_lsb;\r
+    int16_t dig_h5_msb;\r
+\r
+    calib_data->dig_h2 = (int16_t)BME280_CONCAT_BYTES(reg_data[1], reg_data[0]);\r
+    calib_data->dig_h3 = reg_data[2];\r
+    dig_h4_msb = (int16_t)(int8_t)reg_data[3] * 16;\r
+    dig_h4_lsb = (int16_t)(reg_data[4] & 0x0F);\r
+    calib_data->dig_h4 = dig_h4_msb | dig_h4_lsb;\r
+    dig_h5_msb = (int16_t)(int8_t)reg_data[5] * 16;\r
+    dig_h5_lsb = (int16_t)(reg_data[4] >> 4);\r
+    calib_data->dig_h5 = dig_h5_msb | dig_h5_lsb;\r
+    calib_data->dig_h6 = (int8_t)reg_data[6];\r
 }\r
 \r
 /*!\r