-# BME280 sensor API
-## Introduction
-This package contains the Bosch Sensortec's BME280 pressure sensor driver (sensor API)
-
-The sensor driver package includes bme280.c, bme280.h and bme280_defs.h files.
-
-## Version
-File | Version | Date
---------------|---------|------------
-bme280.c | 3.3.6 | 08 Mar 2019
-bme280.h | 3.3.6 | 08 Mar 2019
-bme280_defs.h | 3.3.6 | 08 Mar 2019
-
-## Integration details
-* Integrate bme280.h, bme280_defs.h and bme280.c file in to the project.
-* Include the bme280.h file in your code like below.
-``` c
-#include "bme280.h"
-```
-
-## File information
-* bme280_defs.h : This header file has the constants, macros and datatype declarations.
-* bme280.h : This header file contains the declarations of the sensor driver APIs.
-* bme280.c : This source file contains the definitions of the sensor driver APIs.
-
-## Supported sensor interfaces
-* SPI 4-wire
-* I2C
-
-SPI 3-wire is currently not supported in the API.
-## Usage guide
-### Initializing the sensor
-To initialize the sensor, user need to create a device structure. User can do this by
-creating an instance of the structure bme280_dev. After creating the device strcuture, user
-need to fill in the various parameters as shown below.
-
-#### Example for SPI 4-Wire
-``` c
-struct bme280_dev dev;
-int8_t rslt = BME280_OK;
-
-/* Sensor_0 interface over SPI with native chip select line */
-dev.dev_id = 0;
-dev.intf = BME280_SPI_INTF;
-dev.read = user_spi_read;
-dev.write = user_spi_write;
-dev.delay_ms = user_delay_ms;
-
-rslt = bme280_init(&dev);
-```
-#### Example for I2C
-``` c
-struct bme280_dev dev;
-int8_t rslt = BME280_OK;
-
-dev.dev_id = BME280_I2C_ADDR_PRIM;
-dev.intf = BME280_I2C_INTF;
-dev.read = user_i2c_read;
-dev.write = user_i2c_write;
-dev.delay_ms = user_delay_ms;
-
-rslt = bme280_init(&dev);
-```
-Regarding compensation functions for temperature,pressure and humidity we have two implementations.
-1) Double precision floating point version
-2) Integer version
-
-By default, integer version is used in the API. If the user needs the floating point version, the user has to uncomment BME280_FLOAT_ENABLE macro in bme280_defs.h file or add that to the compiler flags.
-
-In integer compensation functions, we also have below two implementations for pressure.
-1) For 32 bit machine.
-2) For 64 bit machine.
-
-By default, 64 bit variant is used in the API. If the user wants 32 bit variant, the user can disable the
-macro BME280_64BIT_ENABLE in bme280_defs.h file.
-
-### Sensor data units
-> The sensor data units depends on the following macros being enabled or not,
-> (in bme280_defs.h file or as compiler macros)
-> * BME280_FLOAT_ENABLE
-> * BME280_64BIT_ENABLE
-
-In case of the macro "BME280_FLOAT_ENABLE" enabled,
-The outputs are in double and the units are
-
- - °C for temperature
- - % relative humidity
- - Pascal for pressure
-
-In case if "BME280_FLOAT_ENABLE" is not enabled, then it is
-
- - int32_t for temperature with the units 100 * °C
- - uint32_t for humidity with the units 1024 * % relative humidity
- - uint32_t for pressure
- If macro "BME280_64BIT_ENABLE" is enabled, which it is by default, the unit is 100 * Pascal
- If this macro is disabled, Then the unit is in Pascal
-
-### Stream sensor data
-#### Stream sensor data in forced mode
-
-``` c
-int8_t stream_sensor_data_forced_mode(struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t settings_sel;
- struct bme280_data comp_data;
-
- /* Recommended mode of operation: Indoor navigation */
- dev->settings.osr_h = BME280_OVERSAMPLING_1X;
- dev->settings.osr_p = BME280_OVERSAMPLING_16X;
- dev->settings.osr_t = BME280_OVERSAMPLING_2X;
- dev->settings.filter = BME280_FILTER_COEFF_16;
-
- settings_sel = BME280_OSR_PRESS_SEL | BME280_OSR_TEMP_SEL | BME280_OSR_HUM_SEL | BME280_FILTER_SEL;
-
- rslt = bme280_set_sensor_settings(settings_sel, dev);
-
- printf("Temperature, Pressure, Humidity\r\n");
- /* Continuously stream sensor data */
- while (1) {
- rslt = bme280_set_sensor_mode(BME280_FORCED_MODE, dev);
- /* Wait for the measurement to complete and print data @25Hz */
- dev->delay_ms(40);
- rslt = bme280_get_sensor_data(BME280_ALL, &comp_data, dev);
- print_sensor_data(&comp_data);
- }
- return rslt;
-}
-
-void print_sensor_data(struct bme280_data *comp_data)
-{
-#ifdef BME280_FLOAT_ENABLE
- printf("%0.2f, %0.2f, %0.2f\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);
-#else
- printf("%ld, %ld, %ld\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);
-#endif
-}
-```
-##### Stream sensor data in normal mode
-``` c
-int8_t stream_sensor_data_normal_mode(struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t settings_sel;
- struct bme280_data comp_data;
-
- /* Recommended mode of operation: Indoor navigation */
- dev->settings.osr_h = BME280_OVERSAMPLING_1X;
- dev->settings.osr_p = BME280_OVERSAMPLING_16X;
- dev->settings.osr_t = BME280_OVERSAMPLING_2X;
- dev->settings.filter = BME280_FILTER_COEFF_16;
- dev->settings.standby_time = BME280_STANDBY_TIME_62_5_MS;
-
- settings_sel = BME280_OSR_PRESS_SEL;
- settings_sel |= BME280_OSR_TEMP_SEL;
- settings_sel |= BME280_OSR_HUM_SEL;
- settings_sel |= BME280_STANDBY_SEL;
- settings_sel |= BME280_FILTER_SEL;
- rslt = bme280_set_sensor_settings(settings_sel, dev);
- rslt = bme280_set_sensor_mode(BME280_NORMAL_MODE, dev);
-
- printf("Temperature, Pressure, Humidity\r\n");
- while (1) {
- /* Delay while the sensor completes a measurement */
- dev->delay_ms(70);
- rslt = bme280_get_sensor_data(BME280_ALL, &comp_data, dev);
- print_sensor_data(&comp_data);
- }
-
- return rslt;
-}
-
-void print_sensor_data(struct bme280_data *comp_data)
-{
-#ifdef BME280_FLOAT_ENABLE
- printf("%0.2f, %0.2f, %0.2f\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);
-#else
- printf("%ld, %ld, %ld\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);
-#endif
-}
-```
-
-### Templates for function pointers
-``` c
-
-void user_delay_ms(uint32_t period)
-{
- /*
- * Return control or wait,
- * for a period amount of milliseconds
- */
-}
-
-int8_t user_spi_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)
-{
- int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */
-
- /*
- * The parameter dev_id can be used as a variable to select which Chip Select pin has
- * to be set low to activate the relevant device on the SPI bus
- */
-
- /*
- * Data on the bus should be like
- * |----------------+---------------------+-------------|
- * | MOSI | MISO | Chip Select |
- * |----------------+---------------------|-------------|
- * | (don't care) | (don't care) | HIGH |
- * | (reg_addr) | (don't care) | LOW |
- * | (don't care) | (reg_data[0]) | LOW |
- * | (....) | (....) | LOW |
- * | (don't care) | (reg_data[len - 1]) | LOW |
- * | (don't care) | (don't care) | HIGH |
- * |----------------+---------------------|-------------|
- */
-
- return rslt;
-}
-
-int8_t user_spi_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)
-{
- int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */
-
- /*
- * The parameter dev_id can be used as a variable to select which Chip Select pin has
- * to be set low to activate the relevant device on the SPI bus
- */
-
- /*
- * Data on the bus should be like
- * |---------------------+--------------+-------------|
- * | MOSI | MISO | Chip Select |
- * |---------------------+--------------|-------------|
- * | (don't care) | (don't care) | HIGH |
- * | (reg_addr) | (don't care) | LOW |
- * | (reg_data[0]) | (don't care) | LOW |
- * | (....) | (....) | LOW |
- * | (reg_data[len - 1]) | (don't care) | LOW |
- * | (don't care) | (don't care) | HIGH |
- * |---------------------+--------------|-------------|
- */
-
- return rslt;
-}
-
-int8_t user_i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)
-{
- int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */
-
- /*
- * The parameter dev_id can be used as a variable to store the I2C address of the device
- */
-
- /*
- * Data on the bus should be like
- * |------------+---------------------|
- * | I2C action | Data |
- * |------------+---------------------|
- * | Start | - |
- * | Write | (reg_addr) |
- * | Stop | - |
- * | Start | - |
- * | Read | (reg_data[0]) |
- * | Read | (....) |
- * | Read | (reg_data[len - 1]) |
- * | Stop | - |
- * |------------+---------------------|
- */
-
- return rslt;
-}
-
-int8_t user_i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)
-{
- int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */
-
- /*
- * The parameter dev_id can be used as a variable to store the I2C address of the device
- */
-
- /*
- * Data on the bus should be like
- * |------------+----------------------|
- * | I2C action | Data |
- * |------------+----------------------|
- * | Start | - |
- * | Write | (reg_addr) |
- * | Write | (reg_data[0]) |
- * | Write | (reg_addr + 1) |
- * | Write | (reg_data[1]) |
- * | Write | (....) |
- * | Write | (reg_addr + len - 1) |
- * | Write | (reg_data[len - 1]) |
- * | Stop | - |
- * |------------+----------------------|
- */
-
- return rslt;
-}
-
-```
-
-## Copyright (C) 2016 - 2017 Bosch Sensortec GmbH
+# BME280 sensor API\r
+## Introduction\r
+This package contains the Bosch Sensortec's BME280 pressure sensor driver (sensor API)\r
+\r
+The sensor driver package includes bme280.c, bme280.h and bme280_defs.h files.\r
+\r
+## Version\r
+File | Version | Date\r
+--------------|---------|------------\r
+bme280.c | 3.3.7 | 26 Aug 2019\r
+bme280.h | 3.3.7 | 26 Aug 2019\r
+bme280_defs.h | 3.3.7 | 26 Aug 2019\r
+\r
+## Integration details\r
+* Integrate bme280.h, bme280_defs.h and bme280.c file in to the project.\r
+* Include the bme280.h file in your code like below.\r
+``` c\r
+#include "bme280.h"\r
+```\r
+\r
+## File information\r
+* bme280_defs.h : This header file has the constants, macros and datatype declarations.\r
+* bme280.h : This header file contains the declarations of the sensor driver APIs.\r
+* bme280.c : This source file contains the definitions of the sensor driver APIs.\r
+\r
+## Supported sensor interfaces\r
+* SPI 4-wire\r
+* I2C\r
+\r
+SPI 3-wire is currently not supported in the API.\r
+## Usage guide\r
+### Initializing the sensor\r
+To initialize the sensor, user need to create a device structure. User can do this by \r
+creating an instance of the structure bme280_dev. After creating the device strcuture, user \r
+need to fill in the various parameters as shown below.\r
+\r
+#### Example for SPI 4-Wire\r
+``` c\r
+struct bme280_dev dev;\r
+int8_t rslt = BME280_OK;\r
+\r
+/* Sensor_0 interface over SPI with native chip select line */\r
+dev.dev_id = 0;\r
+dev.intf = BME280_SPI_INTF;\r
+dev.read = user_spi_read;\r
+dev.write = user_spi_write;\r
+dev.delay_ms = user_delay_ms;\r
+\r
+rslt = bme280_init(&dev);\r
+```\r
+#### Example for I2C\r
+``` c\r
+struct bme280_dev dev;\r
+int8_t rslt = BME280_OK;\r
+\r
+dev.dev_id = BME280_I2C_ADDR_PRIM;\r
+dev.intf = BME280_I2C_INTF;\r
+dev.read = user_i2c_read;\r
+dev.write = user_i2c_write;\r
+dev.delay_ms = user_delay_ms;\r
+\r
+rslt = bme280_init(&dev);\r
+```\r
+Regarding compensation functions for temperature,pressure and humidity we have two implementations.\r
+1) Double precision floating point version\r
+2) Integer version\r
+\r
+By default, integer version is used in the API. If the user needs the floating point version, the user has to uncomment BME280_FLOAT_ENABLE macro in bme280_defs.h file or add that to the compiler flags.\r
+\r
+In integer compensation functions, we also have below two implementations for pressure.\r
+1) For 32 bit machine.\r
+2) For 64 bit machine.\r
+\r
+By default, 64 bit variant is used in the API. If the user wants 32 bit variant, the user can disable the\r
+macro BME280_64BIT_ENABLE in bme280_defs.h file.\r
+\r
+### Sensor data units\r
+> The sensor data units depends on the following macros being enabled or not, \r
+> (in bme280_defs.h file or as compiler macros)\r
+> * BME280_FLOAT_ENABLE\r
+> * BME280_64BIT_ENABLE\r
+\r
+In case of the macro "BME280_FLOAT_ENABLE" enabled,\r
+The outputs are in double and the units are\r
+\r
+ - °C for temperature\r
+ - % relative humidity\r
+ - Pascal for pressure\r
+\r
+In case if "BME280_FLOAT_ENABLE" is not enabled, then it is\r
+\r
+ - int32_t for temperature with the units 100 * °C\r
+ - uint32_t for humidity with the units 1024 * % relative humidity\r
+ - uint32_t for pressure\r
+ If macro "BME280_64BIT_ENABLE" is enabled, which it is by default, the unit is 100 * Pascal\r
+ If this macro is disabled, Then the unit is in Pascal\r
+\r
+### Stream sensor data\r
+#### Stream sensor data in forced mode\r
+\r
+``` c\r
+int8_t stream_sensor_data_forced_mode(struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t settings_sel;\r
+ struct bme280_data comp_data;\r
+\r
+ /* Recommended mode of operation: Indoor navigation */\r
+ dev->settings.osr_h = BME280_OVERSAMPLING_1X;\r
+ dev->settings.osr_p = BME280_OVERSAMPLING_16X;\r
+ dev->settings.osr_t = BME280_OVERSAMPLING_2X;\r
+ dev->settings.filter = BME280_FILTER_COEFF_16;\r
+\r
+ settings_sel = BME280_OSR_PRESS_SEL | BME280_OSR_TEMP_SEL | BME280_OSR_HUM_SEL | BME280_FILTER_SEL;\r
+\r
+ rslt = bme280_set_sensor_settings(settings_sel, dev);\r
+\r
+ printf("Temperature, Pressure, Humidity\r\n");\r
+ /* Continuously stream sensor data */\r
+ while (1) {\r
+ rslt = bme280_set_sensor_mode(BME280_FORCED_MODE, dev);\r
+ /* Wait for the measurement to complete and print data @25Hz */\r
+ dev->delay_ms(40);\r
+ rslt = bme280_get_sensor_data(BME280_ALL, &comp_data, dev);\r
+ print_sensor_data(&comp_data);\r
+ }\r
+ return rslt;\r
+}\r
+\r
+void print_sensor_data(struct bme280_data *comp_data)\r
+{\r
+#ifdef BME280_FLOAT_ENABLE\r
+ printf("%0.2f, %0.2f, %0.2f\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
+#else\r
+ printf("%ld, %ld, %ld\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
+#endif\r
+}\r
+```\r
+##### Stream sensor data in normal mode\r
+``` c\r
+int8_t stream_sensor_data_normal_mode(struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t settings_sel;\r
+ struct bme280_data comp_data;\r
+\r
+ /* Recommended mode of operation: Indoor navigation */\r
+ dev->settings.osr_h = BME280_OVERSAMPLING_1X;\r
+ dev->settings.osr_p = BME280_OVERSAMPLING_16X;\r
+ dev->settings.osr_t = BME280_OVERSAMPLING_2X;\r
+ dev->settings.filter = BME280_FILTER_COEFF_16;\r
+ dev->settings.standby_time = BME280_STANDBY_TIME_62_5_MS;\r
+\r
+ settings_sel = BME280_OSR_PRESS_SEL;\r
+ settings_sel |= BME280_OSR_TEMP_SEL;\r
+ settings_sel |= BME280_OSR_HUM_SEL;\r
+ settings_sel |= BME280_STANDBY_SEL;\r
+ settings_sel |= BME280_FILTER_SEL;\r
+ rslt = bme280_set_sensor_settings(settings_sel, dev);\r
+ rslt = bme280_set_sensor_mode(BME280_NORMAL_MODE, dev);\r
+\r
+ printf("Temperature, Pressure, Humidity\r\n");\r
+ while (1) {\r
+ /* Delay while the sensor completes a measurement */\r
+ dev->delay_ms(70);\r
+ rslt = bme280_get_sensor_data(BME280_ALL, &comp_data, dev);\r
+ print_sensor_data(&comp_data);\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+void print_sensor_data(struct bme280_data *comp_data)\r
+{\r
+#ifdef BME280_FLOAT_ENABLE\r
+ printf("%0.2f, %0.2f, %0.2f\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
+#else\r
+ printf("%ld, %ld, %ld\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
+#endif\r
+}\r
+```\r
+\r
+### Templates for function pointers\r
+``` c\r
+\r
+void user_delay_ms(uint32_t period)\r
+{\r
+ /*\r
+ * Return control or wait,\r
+ * for a period amount of milliseconds\r
+ */\r
+}\r
+\r
+int8_t user_spi_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
+{\r
+ int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
+\r
+ /*\r
+ * The parameter dev_id can be used as a variable to select which Chip Select pin has\r
+ * to be set low to activate the relevant device on the SPI bus\r
+ */\r
+\r
+ /*\r
+ * Data on the bus should be like\r
+ * |----------------+---------------------+-------------|\r
+ * | MOSI | MISO | Chip Select |\r
+ * |----------------+---------------------|-------------|\r
+ * | (don't care) | (don't care) | HIGH |\r
+ * | (reg_addr) | (don't care) | LOW |\r
+ * | (don't care) | (reg_data[0]) | LOW |\r
+ * | (....) | (....) | LOW |\r
+ * | (don't care) | (reg_data[len - 1]) | LOW |\r
+ * | (don't care) | (don't care) | HIGH |\r
+ * |----------------+---------------------|-------------|\r
+ */\r
+\r
+ return rslt;\r
+}\r
+\r
+int8_t user_spi_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
+{\r
+ int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
+\r
+ /*\r
+ * The parameter dev_id can be used as a variable to select which Chip Select pin has\r
+ * to be set low to activate the relevant device on the SPI bus\r
+ */\r
+\r
+ /*\r
+ * Data on the bus should be like\r
+ * |---------------------+--------------+-------------|\r
+ * | MOSI | MISO | Chip Select |\r
+ * |---------------------+--------------|-------------|\r
+ * | (don't care) | (don't care) | HIGH |\r
+ * | (reg_addr) | (don't care) | LOW |\r
+ * | (reg_data[0]) | (don't care) | LOW |\r
+ * | (....) | (....) | LOW |\r
+ * | (reg_data[len - 1]) | (don't care) | LOW |\r
+ * | (don't care) | (don't care) | HIGH |\r
+ * |---------------------+--------------|-------------|\r
+ */\r
+\r
+ return rslt;\r
+}\r
+\r
+int8_t user_i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
+{\r
+ int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
+\r
+ /*\r
+ * The parameter dev_id can be used as a variable to store the I2C address of the device\r
+ */\r
+\r
+ /*\r
+ * Data on the bus should be like\r
+ * |------------+---------------------|\r
+ * | I2C action | Data |\r
+ * |------------+---------------------|\r
+ * | Start | - |\r
+ * | Write | (reg_addr) |\r
+ * | Stop | - |\r
+ * | Start | - |\r
+ * | Read | (reg_data[0]) |\r
+ * | Read | (....) |\r
+ * | Read | (reg_data[len - 1]) |\r
+ * | Stop | - |\r
+ * |------------+---------------------|\r
+ */\r
+\r
+ return rslt;\r
+}\r
+\r
+int8_t user_i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
+{\r
+ int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
+\r
+ /*\r
+ * The parameter dev_id can be used as a variable to store the I2C address of the device\r
+ */\r
+\r
+ /*\r
+ * Data on the bus should be like\r
+ * |------------+---------------------|\r
+ * | I2C action | Data |\r
+ * |------------+---------------------|\r
+ * | Start | - |\r
+ * | Write | (reg_addr) |\r
+ * | Write | (reg_data[0]) |\r
+ * | Write | (....) |\r
+ * | Write | (reg_data[len - 1]) |\r
+ * | Stop | - |\r
+ * |------------+---------------------|\r
+ */\r
+\r
+ return rslt;\r
+}\r
+\r
+```\r
+\r
+## Copyright (C) 2016 - 2017 Bosch Sensortec GmbH
\ No newline at end of file
-/**\mainpage
- * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * Neither the name of the copyright holder nor the names of the
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
- * OR CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
- * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
- *
- * The information provided is believed to be accurate and reliable.
- * The copyright holder assumes no responsibility
- * for the consequences of use
- * of such information nor for any infringement of patents or
- * other rights of third parties which may result from its use.
- * No license is granted by implication or otherwise under any patent or
- * patent rights of the copyright holder.
- *
- * File bme280.c
- * Date 08 Mar 2019
- * Version 3.3.6
- *
- */
-
-/*! @file bme280.c
- * @brief Sensor driver for BME280 sensor
- */
-#include "bme280.h"
-
-/**\name Internal macros */
-/* To identify osr settings selected by user */
-#define OVERSAMPLING_SETTINGS UINT8_C(0x07)
-
-/* To identify filter and standby settings selected by user */
-#define FILTER_STANDBY_SETTINGS UINT8_C(0x18)
-
-/*!
- * @brief This internal API puts the device to sleep mode.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- *
- * @return Result of API execution status.
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t put_device_to_sleep(const struct bme280_dev *dev);
-
-/*!
- * @brief This internal API writes the power mode in the sensor.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[in] sensor_mode : Variable which contains the power mode to be set.
- *
- * @return Result of API execution status.
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t write_power_mode(uint8_t sensor_mode, const struct bme280_dev *dev);
-
-/*!
- * @brief This internal API is used to validate the device pointer for
- * null conditions.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t null_ptr_check(const struct bme280_dev *dev);
-
-/*!
- * @brief This internal API interleaves the register address between the
- * register data buffer for burst write operation.
- *
- * @param[in] reg_addr : Contains the register address array.
- * @param[out] temp_buff : Contains the temporary buffer to store the
- * register data and register address.
- * @param[in] reg_data : Contains the register data to be written in the
- * temporary buffer.
- * @param[in] len : No of bytes of data to be written for burst write.
- */
-static void interleave_reg_addr(const uint8_t *reg_addr, uint8_t *temp_buff, const uint8_t *reg_data, uint8_t len);
-
-/*!
- * @brief This internal API reads the calibration data from the sensor, parse
- * it and store in the device structure.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t get_calib_data(struct bme280_dev *dev);
-
-/*!
- * @brief This internal API is used to parse the temperature and
- * pressure calibration data and store it in the device structure.
- *
- * @param[out] dev : Structure instance of bme280_dev to store the calib data.
- * @param[in] reg_data : Contains the calibration data to be parsed.
- */
-static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_dev *dev);
-
-/*!
- * @brief This internal API is used to parse the humidity calibration data
- * and store it in device structure.
- *
- * @param[out] dev : Structure instance of bme280_dev to store the calib data.
- * @param[in] reg_data : Contains calibration data to be parsed.
- */
-static void parse_humidity_calib_data(const uint8_t *reg_data, struct bme280_dev *dev);
-
-#ifdef BME280_FLOAT_ENABLE
-
-/*!
- * @brief This internal API is used to compensate the raw pressure data and
- * return the compensated pressure data in double data type.
- *
- * @param[in] uncomp_data : Contains the uncompensated pressure data.
- * @param[in] calib_data : Pointer to the calibration data structure.
- *
- * @return Compensated pressure data.
- * @retval Compensated pressure data in double.
- */
-static double compensate_pressure(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data);
-
-/*!
- * @brief This internal API is used to compensate the raw humidity data and
- * return the compensated humidity data in double data type.
- *
- * @param[in] uncomp_data : Contains the uncompensated humidity data.
- * @param[in] calib_data : Pointer to the calibration data structure.
- *
- * @return Compensated humidity data.
- * @retval Compensated humidity data in double.
- */
-static double compensate_humidity(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data);
-
-/*!
- * @brief This internal API is used to compensate the raw temperature data and
- * return the compensated temperature data in double data type.
- *
- * @param[in] uncomp_data : Contains the uncompensated temperature data.
- * @param[in] calib_data : Pointer to calibration data structure.
- *
- * @return Compensated temperature data.
- * @retval Compensated temperature data in double.
- */
-static double compensate_temperature(const struct bme280_uncomp_data *uncomp_data,
- struct bme280_calib_data *calib_data);
-
-#else
-
-/*!
- * @brief This internal API is used to compensate the raw temperature data and
- * return the compensated temperature data in integer data type.
- *
- * @param[in] uncomp_data : Contains the uncompensated temperature data.
- * @param[in] calib_data : Pointer to calibration data structure.
- *
- * @return Compensated temperature data.
- * @retval Compensated temperature data in integer.
- */
-static int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_data,
- struct bme280_calib_data *calib_data);
-
-/*!
- * @brief This internal API is used to compensate the raw pressure data and
- * return the compensated pressure data in integer data type.
- *
- * @param[in] uncomp_data : Contains the uncompensated pressure data.
- * @param[in] calib_data : Pointer to the calibration data structure.
- *
- * @return Compensated pressure data.
- * @retval Compensated pressure data in integer.
- */
-static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data);
-
-/*!
- * @brief This internal API is used to compensate the raw humidity data and
- * return the compensated humidity data in integer data type.
- *
- * @param[in] uncomp_data : Contains the uncompensated humidity data.
- * @param[in] calib_data : Pointer to the calibration data structure.
- *
- * @return Compensated humidity data.
- * @retval Compensated humidity data in integer.
- */
-static uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data);
-
-#endif
-
-/*!
- * @brief This internal API is used to identify the settings which the user
- * wants to modify in the sensor.
- *
- * @param[in] sub_settings : Contains the settings subset to identify particular
- * group of settings which the user is interested to change.
- * @param[in] desired_settings : Contains the user specified settings.
- *
- * @return Indicates whether user is interested to modify the settings which
- * are related to sub_settings.
- * @retval True -> User wants to modify this group of settings
- * @retval False -> User does not want to modify this group of settings
- */
-static uint8_t are_settings_changed(uint8_t sub_settings, uint8_t desired_settings);
-
-/*!
- * @brief This API sets the humidity oversampling settings of the sensor.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t set_osr_humidity_settings(const struct bme280_settings *settings, const struct bme280_dev *dev);
-
-/*!
- * @brief This internal API sets the oversampling settings for pressure,
- * temperature and humidity in the sensor.
- *
- * @param[in] desired_settings : Variable used to select the settings which
- * are to be set.
- * @param[in] dev : Structure instance of bme280_dev.
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t set_osr_settings(uint8_t desired_settings,
- const struct bme280_settings *settings,
- const struct bme280_dev *dev);
-
-/*!
- * @brief This API sets the pressure and/or temperature oversampling settings
- * in the sensor according to the settings selected by the user.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[in] desired_settings: variable to select the pressure and/or
- * temperature oversampling settings.
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t set_osr_press_temp_settings(uint8_t desired_settings,
- const struct bme280_settings *settings,
- const struct bme280_dev *dev);
-
-/*!
- * @brief This internal API fills the pressure oversampling settings provided by
- * the user in the data buffer so as to write in the sensor.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[out] reg_data : Variable which is filled according to the pressure
- * oversampling data provided by the user.
- */
-static void fill_osr_press_settings(uint8_t *reg_data, const struct bme280_settings *settings);
-
-/*!
- * @brief This internal API fills the temperature oversampling settings provided
- * by the user in the data buffer so as to write in the sensor.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[out] reg_data : Variable which is filled according to the temperature
- * oversampling data provided by the user.
- */
-static void fill_osr_temp_settings(uint8_t *reg_data, const struct bme280_settings *settings);
-
-/*!
- * @brief This internal API sets the filter and/or standby duration settings
- * in the sensor according to the settings selected by the user.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[in] desired_settings : variable to select the filter and/or
- * standby duration settings.
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t set_filter_standby_settings(uint8_t desired_settings,
- const struct bme280_settings *settings,
- const struct bme280_dev *dev);
-
-/*!
- * @brief This internal API fills the filter settings provided by the user
- * in the data buffer so as to write in the sensor.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[out] reg_data : Variable which is filled according to the filter
- * settings data provided by the user.
- */
-static void fill_filter_settings(uint8_t *reg_data, const struct bme280_settings *settings);
-
-/*!
- * @brief This internal API fills the standby duration settings provided by the
- * user in the data buffer so as to write in the sensor.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[out] reg_data : Variable which is filled according to the standby
- * settings data provided by the user.
- */
-static void fill_standby_settings(uint8_t *reg_data, const struct bme280_settings *settings);
-
-/*!
- * @brief This internal API parse the oversampling(pressure, temperature
- * and humidity), filter and standby duration settings and store in the
- * device structure.
- *
- * @param[out] dev : Structure instance of bme280_dev.
- * @param[in] reg_data : Register data to be parsed.
- */
-static void parse_device_settings(const uint8_t *reg_data, struct bme280_settings *settings);
-
-/*!
- * @brief This internal API reloads the already existing device settings in the
- * sensor after soft reset.
- *
- * @param[in] dev : Structure instance of bme280_dev.
- * @param[in] settings : Pointer variable which contains the settings to
- * be set in the sensor.
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static int8_t reload_device_settings(const struct bme280_settings *settings, const struct bme280_dev *dev);
-
-/****************** Global Function Definitions *******************************/
-
-/*!
- * @brief This API is the entry point.
- * It reads the chip-id and calibration data from the sensor.
- */
-int8_t bme280_init(struct bme280_dev *dev)
-{
- int8_t rslt;
-
- /* chip id read try count */
- uint8_t try_count = 5;
- uint8_t chip_id = 0;
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
-
- /* Proceed if null check is fine */
- if (rslt == BME280_OK)
- {
- while (try_count)
- {
- /* Read the chip-id of bme280 sensor */
- rslt = bme280_get_regs(BME280_CHIP_ID_ADDR, &chip_id, 1, dev);
-
- /* Check for chip id validity */
- if ((rslt == BME280_OK) && (chip_id == BME280_CHIP_ID))
- {
- dev->chip_id = chip_id;
-
- /* Reset the sensor */
- rslt = bme280_soft_reset(dev);
- if (rslt == BME280_OK)
- {
- /* Read the calibration data */
- rslt = get_calib_data(dev);
- }
- break;
- }
-
- /* Wait for 1 ms */
- dev->delay_ms(1);
- --try_count;
- }
-
- /* Chip id check failed */
- if (!try_count)
- {
- rslt = BME280_E_DEV_NOT_FOUND;
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API reads the data from the given register address of the sensor.
- */
-int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, const struct bme280_dev *dev)
-{
- int8_t rslt;
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
-
- /* Proceed if null check is fine */
- if (rslt == BME280_OK)
- {
- /* If interface selected is SPI */
- if (dev->intf != BME280_I2C_INTF)
- {
- reg_addr = reg_addr | 0x80;
- }
-
- /* Read the data */
- rslt = dev->read(dev->dev_id, reg_addr, reg_data, len);
-
- /* Check for communication error */
- if (rslt != BME280_OK)
- {
- rslt = BME280_E_COMM_FAIL;
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API writes the given data to the register address
- * of the sensor.
- */
-int8_t bme280_set_regs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t temp_buff[20]; /* Typically not to write more than 10 registers */
-
- if (len > 10)
- {
- len = 10;
- }
- uint16_t temp_len;
- uint8_t reg_addr_cnt;
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
-
- /* Check for arguments validity */
- if ((rslt == BME280_OK) && (reg_addr != NULL) && (reg_data != NULL))
- {
- if (len != 0)
- {
- temp_buff[0] = reg_data[0];
-
- /* If interface selected is SPI */
- if (dev->intf != BME280_I2C_INTF)
- {
- for (reg_addr_cnt = 0; reg_addr_cnt < len; reg_addr_cnt++)
- {
- reg_addr[reg_addr_cnt] = reg_addr[reg_addr_cnt] & 0x7F;
- }
- }
-
- /* Burst write mode */
- if (len > 1)
- {
- /* Interleave register address w.r.t data for
- * burst write
- */
- interleave_reg_addr(reg_addr, temp_buff, reg_data, len);
- temp_len = ((len * 2) - 1);
- }
- else
- {
- temp_len = len;
- }
- rslt = dev->write(dev->dev_id, reg_addr[0], temp_buff, temp_len);
-
- /* Check for communication error */
- if (rslt != BME280_OK)
- {
- rslt = BME280_E_COMM_FAIL;
- }
- }
- else
- {
- rslt = BME280_E_INVALID_LEN;
- }
- }
- else
- {
- rslt = BME280_E_NULL_PTR;
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API sets the oversampling, filter and standby duration
- * (normal mode) settings in the sensor.
- */
-int8_t bme280_set_sensor_settings(uint8_t desired_settings, const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t sensor_mode;
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
-
- /* Proceed if null check is fine */
- if (rslt == BME280_OK)
- {
- rslt = bme280_get_sensor_mode(&sensor_mode, dev);
- if ((rslt == BME280_OK) && (sensor_mode != BME280_SLEEP_MODE))
- {
- rslt = put_device_to_sleep(dev);
- }
- if (rslt == BME280_OK)
- {
- /* Check if user wants to change oversampling
- * settings
- */
- if (are_settings_changed(OVERSAMPLING_SETTINGS, desired_settings))
- {
- rslt = set_osr_settings(desired_settings, &dev->settings, dev);
- }
-
- /* Check if user wants to change filter and/or
- * standby settings
- */
- if ((rslt == BME280_OK) && are_settings_changed(FILTER_STANDBY_SETTINGS, desired_settings))
- {
- rslt = set_filter_standby_settings(desired_settings, &dev->settings, dev);
- }
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API gets the oversampling, filter and standby duration
- * (normal mode) settings from the sensor.
- */
-int8_t bme280_get_sensor_settings(struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t reg_data[4];
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
-
- /* Proceed if null check is fine */
- if (rslt == BME280_OK)
- {
- rslt = bme280_get_regs(BME280_CTRL_HUM_ADDR, reg_data, 4, dev);
- if (rslt == BME280_OK)
- {
- parse_device_settings(reg_data, &dev->settings);
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API sets the power mode of the sensor.
- */
-int8_t bme280_set_sensor_mode(uint8_t sensor_mode, const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t last_set_mode;
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
- if (rslt == BME280_OK)
- {
- rslt = bme280_get_sensor_mode(&last_set_mode, dev);
-
- /* If the sensor is not in sleep mode put the device to sleep
- * mode
- */
- if ((rslt == BME280_OK) && (last_set_mode != BME280_SLEEP_MODE))
- {
- rslt = put_device_to_sleep(dev);
- }
-
- /* Set the power mode */
- if (rslt == BME280_OK)
- {
- rslt = write_power_mode(sensor_mode, dev);
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API gets the power mode of the sensor.
- */
-int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, const struct bme280_dev *dev)
-{
- int8_t rslt;
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
- if (rslt == BME280_OK)
- {
- /* Read the power mode register */
- rslt = bme280_get_regs(BME280_PWR_CTRL_ADDR, sensor_mode, 1, dev);
-
- /* Assign the power mode in the device structure */
- *sensor_mode = BME280_GET_BITS_POS_0(*sensor_mode, BME280_SENSOR_MODE);
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API performs the soft reset of the sensor.
- */
-int8_t bme280_soft_reset(const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t reg_addr = BME280_RESET_ADDR;
-
- /* 0xB6 is the soft reset command */
- uint8_t soft_rst_cmd = 0xB6;
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
-
- /* Proceed if null check is fine */
- if (rslt == BME280_OK)
- {
- /* Write the soft reset command in the sensor */
- rslt = bme280_set_regs(®_addr, &soft_rst_cmd, 1, dev);
-
- /* As per data sheet, startup time is 2 ms. */
- dev->delay_ms(2);
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API reads the pressure, temperature and humidity data from the
- * sensor, compensates the data and store it in the bme280_data structure
- * instance passed by the user.
- */
-int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev)
-{
- int8_t rslt;
-
- /* Array to store the pressure, temperature and humidity data read from
- * the sensor
- */
- uint8_t reg_data[BME280_P_T_H_DATA_LEN] = { 0 };
- struct bme280_uncomp_data uncomp_data = { 0 };
-
- /* Check for null pointer in the device structure*/
- rslt = null_ptr_check(dev);
- if ((rslt == BME280_OK) && (comp_data != NULL))
- {
- /* Read the pressure and temperature data from the sensor */
- rslt = bme280_get_regs(BME280_DATA_ADDR, reg_data, BME280_P_T_H_DATA_LEN, dev);
- if (rslt == BME280_OK)
- {
- /* Parse the read data from the sensor */
- bme280_parse_sensor_data(reg_data, &uncomp_data);
-
- /* Compensate the pressure and/or temperature and/or
- * humidity data from the sensor
- */
- rslt = bme280_compensate_data(sensor_comp, &uncomp_data, comp_data, &dev->calib_data);
- }
- }
- else
- {
- rslt = BME280_E_NULL_PTR;
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API is used to parse the pressure, temperature and
- * humidity data and store it in the bme280_uncomp_data structure instance.
- */
-void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data)
-{
- /* Variables to store the sensor data */
- uint32_t data_xlsb;
- uint32_t data_lsb;
- uint32_t data_msb;
-
- /* Store the parsed register values for pressure data */
- data_msb = (uint32_t)reg_data[0] << 12;
- data_lsb = (uint32_t)reg_data[1] << 4;
- data_xlsb = (uint32_t)reg_data[2] >> 4;
- uncomp_data->pressure = data_msb | data_lsb | data_xlsb;
-
- /* Store the parsed register values for temperature data */
- data_msb = (uint32_t)reg_data[3] << 12;
- data_lsb = (uint32_t)reg_data[4] << 4;
- data_xlsb = (uint32_t)reg_data[5] >> 4;
- uncomp_data->temperature = data_msb | data_lsb | data_xlsb;
-
- /* Store the parsed register values for temperature data */
- data_lsb = (uint32_t)reg_data[6] << 8;
- data_msb = (uint32_t)reg_data[7];
- uncomp_data->humidity = data_msb | data_lsb;
-}
-
-/*!
- * @brief This API is used to compensate the pressure and/or
- * temperature and/or humidity data according to the component selected
- * by the user.
- */
-int8_t bme280_compensate_data(uint8_t sensor_comp,
- const struct bme280_uncomp_data *uncomp_data,
- struct bme280_data *comp_data,
- struct bme280_calib_data *calib_data)
-{
- int8_t rslt = BME280_OK;
-
- if ((uncomp_data != NULL) && (comp_data != NULL) && (calib_data != NULL))
- {
- /* Initialize to zero */
- comp_data->temperature = 0;
- comp_data->pressure = 0;
- comp_data->humidity = 0;
-
- /* If pressure or temperature component is selected */
- if (sensor_comp & (BME280_PRESS | BME280_TEMP | BME280_HUM))
- {
- /* Compensate the temperature data */
- comp_data->temperature = compensate_temperature(uncomp_data, calib_data);
- }
- if (sensor_comp & BME280_PRESS)
- {
- /* Compensate the pressure data */
- comp_data->pressure = compensate_pressure(uncomp_data, calib_data);
- }
- if (sensor_comp & BME280_HUM)
- {
- /* Compensate the humidity data */
- comp_data->humidity = compensate_humidity(uncomp_data, calib_data);
- }
- }
- else
- {
- rslt = BME280_E_NULL_PTR;
- }
-
- return rslt;
-}
-
-/*!
- * @brief This internal API sets the oversampling settings for pressure,
- * temperature and humidity in the sensor.
- */
-static int8_t set_osr_settings(uint8_t desired_settings,
- const struct bme280_settings *settings,
- const struct bme280_dev *dev)
-{
- int8_t rslt = BME280_W_INVALID_OSR_MACRO;
-
- if (desired_settings & BME280_OSR_HUM_SEL)
- {
- rslt = set_osr_humidity_settings(settings, dev);
- }
- if (desired_settings & (BME280_OSR_PRESS_SEL | BME280_OSR_TEMP_SEL))
- {
- rslt = set_osr_press_temp_settings(desired_settings, settings, dev);
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API sets the humidity oversampling settings of the sensor.
- */
-static int8_t set_osr_humidity_settings(const struct bme280_settings *settings, const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t ctrl_hum;
- uint8_t ctrl_meas;
- uint8_t reg_addr = BME280_CTRL_HUM_ADDR;
-
- ctrl_hum = settings->osr_h & BME280_CTRL_HUM_MSK;
-
- /* Write the humidity control value in the register */
- rslt = bme280_set_regs(®_addr, &ctrl_hum, 1, dev);
-
- /* Humidity related changes will be only effective after a
- * write operation to ctrl_meas register
- */
- if (rslt == BME280_OK)
- {
- reg_addr = BME280_CTRL_MEAS_ADDR;
- rslt = bme280_get_regs(reg_addr, &ctrl_meas, 1, dev);
- if (rslt == BME280_OK)
- {
- rslt = bme280_set_regs(®_addr, &ctrl_meas, 1, dev);
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This API sets the pressure and/or temperature oversampling settings
- * in the sensor according to the settings selected by the user.
- */
-static int8_t set_osr_press_temp_settings(uint8_t desired_settings,
- const struct bme280_settings *settings,
- const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t reg_addr = BME280_CTRL_MEAS_ADDR;
- uint8_t reg_data;
-
- rslt = bme280_get_regs(reg_addr, ®_data, 1, dev);
- if (rslt == BME280_OK)
- {
- if (desired_settings & BME280_OSR_PRESS_SEL)
- {
- fill_osr_press_settings(®_data, settings);
- }
- if (desired_settings & BME280_OSR_TEMP_SEL)
- {
- fill_osr_temp_settings(®_data, settings);
- }
-
- /* Write the oversampling settings in the register */
- rslt = bme280_set_regs(®_addr, ®_data, 1, dev);
- }
-
- return rslt;
-}
-
-/*!
- * @brief This internal API sets the filter and/or standby duration settings
- * in the sensor according to the settings selected by the user.
- */
-static int8_t set_filter_standby_settings(uint8_t desired_settings,
- const struct bme280_settings *settings,
- const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t reg_addr = BME280_CONFIG_ADDR;
- uint8_t reg_data;
-
- rslt = bme280_get_regs(reg_addr, ®_data, 1, dev);
- if (rslt == BME280_OK)
- {
- if (desired_settings & BME280_FILTER_SEL)
- {
- fill_filter_settings(®_data, settings);
- }
- if (desired_settings & BME280_STANDBY_SEL)
- {
- fill_standby_settings(®_data, settings);
- }
-
- /* Write the oversampling settings in the register */
- rslt = bme280_set_regs(®_addr, ®_data, 1, dev);
- }
-
- return rslt;
-}
-
-/*!
- * @brief This internal API fills the filter settings provided by the user
- * in the data buffer so as to write in the sensor.
- */
-static void fill_filter_settings(uint8_t *reg_data, const struct bme280_settings *settings)
-{
- *reg_data = BME280_SET_BITS(*reg_data, BME280_FILTER, settings->filter);
-}
-
-/*!
- * @brief This internal API fills the standby duration settings provided by
- * the user in the data buffer so as to write in the sensor.
- */
-static void fill_standby_settings(uint8_t *reg_data, const struct bme280_settings *settings)
-{
- *reg_data = BME280_SET_BITS(*reg_data, BME280_STANDBY, settings->standby_time);
-}
-
-/*!
- * @brief This internal API fills the pressure oversampling settings provided by
- * the user in the data buffer so as to write in the sensor.
- */
-static void fill_osr_press_settings(uint8_t *reg_data, const struct bme280_settings *settings)
-{
- *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_PRESS, settings->osr_p);
-}
-
-/*!
- * @brief This internal API fills the temperature oversampling settings
- * provided by the user in the data buffer so as to write in the sensor.
- */
-static void fill_osr_temp_settings(uint8_t *reg_data, const struct bme280_settings *settings)
-{
- *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_TEMP, settings->osr_t);
-}
-
-/*!
- * @brief This internal API parse the oversampling(pressure, temperature
- * and humidity), filter and standby duration settings and store in the
- * device structure.
- */
-static void parse_device_settings(const uint8_t *reg_data, struct bme280_settings *settings)
-{
- settings->osr_h = BME280_GET_BITS_POS_0(reg_data[0], BME280_CTRL_HUM);
- settings->osr_p = BME280_GET_BITS(reg_data[2], BME280_CTRL_PRESS);
- settings->osr_t = BME280_GET_BITS(reg_data[2], BME280_CTRL_TEMP);
- settings->filter = BME280_GET_BITS(reg_data[3], BME280_FILTER);
- settings->standby_time = BME280_GET_BITS(reg_data[3], BME280_STANDBY);
-}
-
-/*!
- * @brief This internal API writes the power mode in the sensor.
- */
-static int8_t write_power_mode(uint8_t sensor_mode, const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t reg_addr = BME280_PWR_CTRL_ADDR;
-
- /* Variable to store the value read from power mode register */
- uint8_t sensor_mode_reg_val;
-
- /* Read the power mode register */
- rslt = bme280_get_regs(reg_addr, &sensor_mode_reg_val, 1, dev);
-
- /* Set the power mode */
- if (rslt == BME280_OK)
- {
- sensor_mode_reg_val = BME280_SET_BITS_POS_0(sensor_mode_reg_val, BME280_SENSOR_MODE, sensor_mode);
-
- /* Write the power mode in the register */
- rslt = bme280_set_regs(®_addr, &sensor_mode_reg_val, 1, dev);
- }
-
- return rslt;
-}
-
-/*!
- * @brief This internal API puts the device to sleep mode.
- */
-static int8_t put_device_to_sleep(const struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t reg_data[4];
- struct bme280_settings settings;
-
- rslt = bme280_get_regs(BME280_CTRL_HUM_ADDR, reg_data, 4, dev);
- if (rslt == BME280_OK)
- {
- parse_device_settings(reg_data, &settings);
- rslt = bme280_soft_reset(dev);
- if (rslt == BME280_OK)
- {
- rslt = reload_device_settings(&settings, dev);
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This internal API reloads the already existing device settings in
- * the sensor after soft reset.
- */
-static int8_t reload_device_settings(const struct bme280_settings *settings, const struct bme280_dev *dev)
-{
- int8_t rslt;
-
- rslt = set_osr_settings(BME280_ALL_SETTINGS_SEL, settings, dev);
- if (rslt == BME280_OK)
- {
- rslt = set_filter_standby_settings(BME280_ALL_SETTINGS_SEL, settings, dev);
- }
-
- return rslt;
-}
-
-#ifdef BME280_FLOAT_ENABLE
-
-/*!
- * @brief This internal API is used to compensate the raw temperature data and
- * return the compensated temperature data in double data type.
- */
-static double compensate_temperature(const struct bme280_uncomp_data *uncomp_data, struct bme280_calib_data *calib_data)
-{
- double var1;
- double var2;
- double temperature;
- double temperature_min = -40;
- double temperature_max = 85;
-
- var1 = ((double)uncomp_data->temperature) / 16384.0 - ((double)calib_data->dig_T1) / 1024.0;
- var1 = var1 * ((double)calib_data->dig_T2);
- var2 = (((double)uncomp_data->temperature) / 131072.0 - ((double)calib_data->dig_T1) / 8192.0);
- var2 = (var2 * var2) * ((double)calib_data->dig_T3);
- calib_data->t_fine = (int32_t)(var1 + var2);
- temperature = (var1 + var2) / 5120.0;
- if (temperature < temperature_min)
- {
- temperature = temperature_min;
- }
- else if (temperature > temperature_max)
- {
- temperature = temperature_max;
- }
-
- return temperature;
-}
-
-/*!
- * @brief This internal API is used to compensate the raw pressure data and
- * return the compensated pressure data in double data type.
- */
-static double compensate_pressure(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data)
-{
- double var1;
- double var2;
- double var3;
- double pressure;
- double pressure_min = 30000.0;
- double pressure_max = 110000.0;
-
- var1 = ((double)calib_data->t_fine / 2.0) - 64000.0;
- var2 = var1 * var1 * ((double)calib_data->dig_P6) / 32768.0;
- var2 = var2 + var1 * ((double)calib_data->dig_P5) * 2.0;
- var2 = (var2 / 4.0) + (((double)calib_data->dig_P4) * 65536.0);
- var3 = ((double)calib_data->dig_P3) * var1 * var1 / 524288.0;
- var1 = (var3 + ((double)calib_data->dig_P2) * var1) / 524288.0;
- var1 = (1.0 + var1 / 32768.0) * ((double)calib_data->dig_P1);
-
- /* avoid exception caused by division by zero */
- if (var1)
- {
- pressure = 1048576.0 - (double) uncomp_data->pressure;
- pressure = (pressure - (var2 / 4096.0)) * 6250.0 / var1;
- var1 = ((double)calib_data->dig_P9) * pressure * pressure / 2147483648.0;
- var2 = pressure * ((double)calib_data->dig_P8) / 32768.0;
- pressure = pressure + (var1 + var2 + ((double)calib_data->dig_P7)) / 16.0;
- if (pressure < pressure_min)
- {
- pressure = pressure_min;
- }
- else if (pressure > pressure_max)
- {
- pressure = pressure_max;
- }
- }
- else /* Invalid case */
- {
- pressure = pressure_min;
- }
-
- return pressure;
-}
-
-/*!
- * @brief This internal API is used to compensate the raw humidity data and
- * return the compensated humidity data in double data type.
- */
-static double compensate_humidity(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data)
-{
- double humidity;
- double humidity_min = 0.0;
- double humidity_max = 100.0;
- double var1;
- double var2;
- double var3;
- double var4;
- double var5;
- double var6;
-
- var1 = ((double)calib_data->t_fine) - 76800.0;
- var2 = (((double)calib_data->dig_H4) * 64.0 + (((double)calib_data->dig_H5) / 16384.0) * var1);
- var3 = uncomp_data->humidity - var2;
- var4 = ((double)calib_data->dig_H2) / 65536.0;
- var5 = (1.0 + (((double)calib_data->dig_H3) / 67108864.0) * var1);
- var6 = 1.0 + (((double)calib_data->dig_H6) / 67108864.0) * var1 * var5;
- var6 = var3 * var4 * (var5 * var6);
- humidity = var6 * (1.0 - ((double)calib_data->dig_H1) * var6 / 524288.0);
- if (humidity > humidity_max)
- {
- humidity = humidity_max;
- }
- else if (humidity < humidity_min)
- {
- humidity = humidity_min;
- }
-
- return humidity;
-}
-
-#else
-
-/*!
- * @brief This internal API is used to compensate the raw temperature data and
- * return the compensated temperature data in integer data type.
- */
-static int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_data,
- struct bme280_calib_data *calib_data)
-{
- int32_t var1;
- int32_t var2;
- int32_t temperature;
- int32_t temperature_min = -4000;
- int32_t temperature_max = 8500;
-
- var1 = (int32_t)((uncomp_data->temperature / 8) - ((int32_t)calib_data->dig_T1 * 2));
- var1 = (var1 * ((int32_t)calib_data->dig_T2)) / 2048;
- var2 = (int32_t)((uncomp_data->temperature / 16) - ((int32_t)calib_data->dig_T1));
- var2 = (((var2 * var2) / 4096) * ((int32_t)calib_data->dig_T3)) / 16384;
- calib_data->t_fine = var1 + var2;
- temperature = (calib_data->t_fine * 5 + 128) / 256;
- if (temperature < temperature_min)
- {
- temperature = temperature_min;
- }
- else if (temperature > temperature_max)
- {
- temperature = temperature_max;
- }
-
- return temperature;
-}
-#ifdef BME280_64BIT_ENABLE
-
-/*!
- * @brief This internal API is used to compensate the raw pressure data and
- * return the compensated pressure data in integer data type with higher
- * accuracy.
- */
-static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data)
-{
- int64_t var1;
- int64_t var2;
- int64_t var3;
- int64_t var4;
- uint32_t pressure;
- uint32_t pressure_min = 3000000;
- uint32_t pressure_max = 11000000;
-
- var1 = ((int64_t)calib_data->t_fine) - 128000;
- var2 = var1 * var1 * (int64_t)calib_data->dig_P6;
- var2 = var2 + ((var1 * (int64_t)calib_data->dig_P5) * 131072);
- var2 = var2 + (((int64_t)calib_data->dig_P4) * 34359738368);
- var1 = ((var1 * var1 * (int64_t)calib_data->dig_P3) / 256) + ((var1 * ((int64_t)calib_data->dig_P2) * 4096));
- var3 = ((int64_t)1) * 140737488355328;
- var1 = (var3 + var1) * ((int64_t)calib_data->dig_P1) / 8589934592;
-
- /* To avoid divide by zero exception */
- if (var1 != 0)
- {
- var4 = 1048576 - uncomp_data->pressure;
- var4 = (((var4 * INT64_C(2147483648)) - var2) * 3125) / var1;
- var1 = (((int64_t)calib_data->dig_P9) * (var4 / 8192) * (var4 / 8192)) / 33554432;
- var2 = (((int64_t)calib_data->dig_P8) * var4) / 524288;
- var4 = ((var4 + var1 + var2) / 256) + (((int64_t)calib_data->dig_P7) * 16);
- pressure = (uint32_t)(((var4 / 2) * 100) / 128);
- if (pressure < pressure_min)
- {
- pressure = pressure_min;
- }
- else if (pressure > pressure_max)
- {
- pressure = pressure_max;
- }
- }
- else
- {
- pressure = pressure_min;
- }
-
- return pressure;
-}
-#else
-
-/*!
- * @brief This internal API is used to compensate the raw pressure data and
- * return the compensated pressure data in integer data type.
- */
-static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data)
-{
- int32_t var1;
- int32_t var2;
- int32_t var3;
- int32_t var4;
- uint32_t var5;
- uint32_t pressure;
- uint32_t pressure_min = 30000;
- uint32_t pressure_max = 110000;
-
- var1 = (((int32_t)calib_data->t_fine) / 2) - (int32_t)64000;
- var2 = (((var1 / 4) * (var1 / 4)) / 2048) * ((int32_t)calib_data->dig_P6);
- var2 = var2 + ((var1 * ((int32_t)calib_data->dig_P5)) * 2);
- var2 = (var2 / 4) + (((int32_t)calib_data->dig_P4) * 65536);
- var3 = (calib_data->dig_P3 * (((var1 / 4) * (var1 / 4)) / 8192)) / 8;
- var4 = (((int32_t)calib_data->dig_P2) * var1) / 2;
- var1 = (var3 + var4) / 262144;
- var1 = (((32768 + var1)) * ((int32_t)calib_data->dig_P1)) / 32768;
-
- /* avoid exception caused by division by zero */
- if (var1)
- {
- var5 = (uint32_t)((uint32_t)1048576) - uncomp_data->pressure;
- pressure = ((uint32_t)(var5 - (uint32_t)(var2 / 4096))) * 3125;
- if (pressure < 0x80000000)
- {
- pressure = (pressure << 1) / ((uint32_t)var1);
- }
- else
- {
- pressure = (pressure / (uint32_t)var1) * 2;
- }
- var1 = (((int32_t)calib_data->dig_P9) * ((int32_t)(((pressure / 8) * (pressure / 8)) / 8192))) / 4096;
- var2 = (((int32_t)(pressure / 4)) * ((int32_t)calib_data->dig_P8)) / 8192;
- pressure = (uint32_t)((int32_t)pressure + ((var1 + var2 + calib_data->dig_P7) / 16));
- if (pressure < pressure_min)
- {
- pressure = pressure_min;
- }
- else if (pressure > pressure_max)
- {
- pressure = pressure_max;
- }
- }
- else
- {
- pressure = pressure_min;
- }
-
- return pressure;
-}
-#endif
-
-/*!
- * @brief This internal API is used to compensate the raw humidity data and
- * return the compensated humidity data in integer data type.
- */
-static uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data,
- const struct bme280_calib_data *calib_data)
-{
- int32_t var1;
- int32_t var2;
- int32_t var3;
- int32_t var4;
- int32_t var5;
- uint32_t humidity;
- uint32_t humidity_max = 102400;
-
- var1 = calib_data->t_fine - ((int32_t)76800);
- var2 = (int32_t)(uncomp_data->humidity * 16384);
- var3 = (int32_t)(((int32_t)calib_data->dig_H4) * 1048576);
- var4 = ((int32_t)calib_data->dig_H5) * var1;
- var5 = (((var2 - var3) - var4) + (int32_t)16384) / 32768;
- var2 = (var1 * ((int32_t)calib_data->dig_H6)) / 1024;
- var3 = (var1 * ((int32_t)calib_data->dig_H3)) / 2048;
- var4 = ((var2 * (var3 + (int32_t)32768)) / 1024) + (int32_t)2097152;
- var2 = ((var4 * ((int32_t)calib_data->dig_H2)) + 8192) / 16384;
- var3 = var5 * var2;
- var4 = ((var3 / 32768) * (var3 / 32768)) / 128;
- var5 = var3 - ((var4 * ((int32_t)calib_data->dig_H1)) / 16);
- var5 = (var5 < 0 ? 0 : var5);
- var5 = (var5 > 419430400 ? 419430400 : var5);
- humidity = (uint32_t)(var5 / 4096);
- if (humidity > humidity_max)
- {
- humidity = humidity_max;
- }
-
- return humidity;
-}
-#endif
-
-/*!
- * @brief This internal API reads the calibration data from the sensor, parse
- * it and store in the device structure.
- */
-static int8_t get_calib_data(struct bme280_dev *dev)
-{
- int8_t rslt;
- uint8_t reg_addr = BME280_TEMP_PRESS_CALIB_DATA_ADDR;
-
- /* Array to store calibration data */
- uint8_t calib_data[BME280_TEMP_PRESS_CALIB_DATA_LEN] = { 0 };
-
- /* Read the calibration data from the sensor */
- rslt = bme280_get_regs(reg_addr, calib_data, BME280_TEMP_PRESS_CALIB_DATA_LEN, dev);
- if (rslt == BME280_OK)
- {
- /* Parse temperature and pressure calibration data and store
- * it in device structure
- */
- parse_temp_press_calib_data(calib_data, dev);
- reg_addr = BME280_HUMIDITY_CALIB_DATA_ADDR;
-
- /* Read the humidity calibration data from the sensor */
- rslt = bme280_get_regs(reg_addr, calib_data, BME280_HUMIDITY_CALIB_DATA_LEN, dev);
- if (rslt == BME280_OK)
- {
- /* Parse humidity calibration data and store it in
- * device structure
- */
- parse_humidity_calib_data(calib_data, dev);
- }
- }
-
- return rslt;
-}
-
-/*!
- * @brief This internal API interleaves the register address between the
- * register data buffer for burst write operation.
- */
-static void interleave_reg_addr(const uint8_t *reg_addr, uint8_t *temp_buff, const uint8_t *reg_data, uint8_t len)
-{
- uint8_t index;
-
- for (index = 1; index < len; index++)
- {
- temp_buff[(index * 2) - 1] = reg_addr[index];
- temp_buff[index * 2] = reg_data[index];
- }
-}
-
-/*!
- * @brief This internal API is used to parse the temperature and
- * pressure calibration data and store it in device structure.
- */
-static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_dev *dev)
-{
- struct bme280_calib_data *calib_data = &dev->calib_data;
-
- calib_data->dig_T1 = BME280_CONCAT_BYTES(reg_data[1], reg_data[0]);
- calib_data->dig_T2 = (int16_t)BME280_CONCAT_BYTES(reg_data[3], reg_data[2]);
- calib_data->dig_T3 = (int16_t)BME280_CONCAT_BYTES(reg_data[5], reg_data[4]);
- calib_data->dig_P1 = BME280_CONCAT_BYTES(reg_data[7], reg_data[6]);
- calib_data->dig_P2 = (int16_t)BME280_CONCAT_BYTES(reg_data[9], reg_data[8]);
- calib_data->dig_P3 = (int16_t)BME280_CONCAT_BYTES(reg_data[11], reg_data[10]);
- calib_data->dig_P4 = (int16_t)BME280_CONCAT_BYTES(reg_data[13], reg_data[12]);
- calib_data->dig_P5 = (int16_t)BME280_CONCAT_BYTES(reg_data[15], reg_data[14]);
- calib_data->dig_P6 = (int16_t)BME280_CONCAT_BYTES(reg_data[17], reg_data[16]);
- calib_data->dig_P7 = (int16_t)BME280_CONCAT_BYTES(reg_data[19], reg_data[18]);
- calib_data->dig_P8 = (int16_t)BME280_CONCAT_BYTES(reg_data[21], reg_data[20]);
- calib_data->dig_P9 = (int16_t)BME280_CONCAT_BYTES(reg_data[23], reg_data[22]);
- calib_data->dig_H1 = reg_data[25];
-}
-
-/*!
- * @brief This internal API is used to parse the humidity calibration data
- * and store it in device structure.
- */
-static void parse_humidity_calib_data(const uint8_t *reg_data, struct bme280_dev *dev)
-{
- struct bme280_calib_data *calib_data = &dev->calib_data;
- int16_t dig_H4_lsb;
- int16_t dig_H4_msb;
- int16_t dig_H5_lsb;
- int16_t dig_H5_msb;
-
- calib_data->dig_H2 = (int16_t)BME280_CONCAT_BYTES(reg_data[1], reg_data[0]);
- calib_data->dig_H3 = reg_data[2];
- dig_H4_msb = (int16_t)(int8_t)reg_data[3] * 16;
- dig_H4_lsb = (int16_t)(reg_data[4] & 0x0F);
- calib_data->dig_H4 = dig_H4_msb | dig_H4_lsb;
- dig_H5_msb = (int16_t)(int8_t)reg_data[5] * 16;
- dig_H5_lsb = (int16_t)(reg_data[4] >> 4);
- calib_data->dig_H5 = dig_H5_msb | dig_H5_lsb;
- calib_data->dig_H6 = (int8_t)reg_data[6];
-}
-
-/*!
- * @brief This internal API is used to identify the settings which the user
- * wants to modify in the sensor.
- */
-static uint8_t are_settings_changed(uint8_t sub_settings, uint8_t desired_settings)
-{
- uint8_t settings_changed = FALSE;
-
- if (sub_settings & desired_settings)
- {
- /* User wants to modify this particular settings */
- settings_changed = TRUE;
- }
- else
- {
- /* User don't want to modify this particular settings */
- settings_changed = FALSE;
- }
-
- return settings_changed;
-}
-
-/*!
- * @brief This internal API is used to validate the device structure pointer for
- * null conditions.
- */
-static int8_t null_ptr_check(const struct bme280_dev *dev)
-{
- int8_t rslt;
-
- if ((dev == NULL) || (dev->read == NULL) || (dev->write == NULL) || (dev->delay_ms == NULL))
- {
- /* Device structure pointer is not valid */
- rslt = BME280_E_NULL_PTR;
- }
- else
- {
- /* Device structure is fine */
- rslt = BME280_OK;
- }
-
- return rslt;
-}
+/**\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
+/*! @file bme280.c\r
+ * @brief Sensor driver for BME280 sensor\r
+ */\r
+#include "bme280.h"\r
+\r
+/**\name Internal macros */\r
+/* To identify osr settings selected by user */\r
+#define OVERSAMPLING_SETTINGS UINT8_C(0x07)\r
+\r
+/* To identify filter and standby settings selected by user */\r
+#define FILTER_STANDBY_SETTINGS UINT8_C(0x18)\r
+\r
+/*!\r
+ * @brief This internal API puts the device to sleep mode.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ *\r
+ * @return Result of API execution status.\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t put_device_to_sleep(const struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API writes the power mode in the sensor.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[in] sensor_mode : Variable which contains the power mode to be set.\r
+ *\r
+ * @return Result of API execution status.\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t write_power_mode(uint8_t sensor_mode, const struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API is used to validate the device pointer for\r
+ * null conditions.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t null_ptr_check(const struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API interleaves the register address between the\r
+ * register data buffer for burst write operation.\r
+ *\r
+ * @param[in] reg_addr : Contains the register address array.\r
+ * @param[out] temp_buff : Contains the temporary buffer to store the\r
+ * register data and register address.\r
+ * @param[in] reg_data : Contains the register data to be written in the\r
+ * temporary buffer.\r
+ * @param[in] len : No of bytes of data to be written for burst write.\r
+ */\r
+static void interleave_reg_addr(const uint8_t *reg_addr, uint8_t *temp_buff, const uint8_t *reg_data, uint8_t len);\r
+\r
+/*!\r
+ * @brief This internal API reads the calibration data from the sensor, parse\r
+ * it and store in the device structure.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t get_calib_data(struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API is used to parse the temperature and\r
+ * pressure calibration data and store it in the device structure.\r
+ *\r
+ * @param[out] dev : Structure instance of bme280_dev to store the calib data.\r
+ * @param[in] reg_data : Contains the calibration data to be parsed.\r
+ */\r
+static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API is used to parse the humidity calibration data\r
+ * and store it in device structure.\r
+ *\r
+ * @param[out] dev : Structure instance of bme280_dev to store the calib data.\r
+ * @param[in] reg_data : Contains calibration data to be parsed.\r
+ */\r
+static void parse_humidity_calib_data(const uint8_t *reg_data, struct bme280_dev *dev);\r
+\r
+#ifdef BME280_FLOAT_ENABLE\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw pressure data and\r
+ * return the compensated pressure data in double data type.\r
+ *\r
+ * @param[in] uncomp_data : Contains the uncompensated pressure data.\r
+ * @param[in] calib_data : Pointer to the calibration data structure.\r
+ *\r
+ * @return Compensated pressure data.\r
+ * @retval Compensated pressure data in double.\r
+ */\r
+static double compensate_pressure(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data);\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw humidity data and\r
+ * return the compensated humidity data in double data type.\r
+ *\r
+ * @param[in] uncomp_data : Contains the uncompensated humidity data.\r
+ * @param[in] calib_data : Pointer to the calibration data structure.\r
+ *\r
+ * @return Compensated humidity data.\r
+ * @retval Compensated humidity data in double.\r
+ */\r
+static double compensate_humidity(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data);\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw temperature data and\r
+ * return the compensated temperature data in double data type.\r
+ *\r
+ * @param[in] uncomp_data : Contains the uncompensated temperature data.\r
+ * @param[in] calib_data : Pointer to calibration data structure.\r
+ *\r
+ * @return Compensated temperature data.\r
+ * @retval Compensated temperature data in double.\r
+ */\r
+static double compensate_temperature(const struct bme280_uncomp_data *uncomp_data,\r
+ struct bme280_calib_data *calib_data);\r
+\r
+#else\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw temperature data and\r
+ * return the compensated temperature data in integer data type.\r
+ *\r
+ * @param[in] uncomp_data : Contains the uncompensated temperature data.\r
+ * @param[in] calib_data : Pointer to calibration data structure.\r
+ *\r
+ * @return Compensated temperature data.\r
+ * @retval Compensated temperature data in integer.\r
+ */\r
+static int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_data,\r
+ struct bme280_calib_data *calib_data);\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw pressure data and\r
+ * return the compensated pressure data in integer data type.\r
+ *\r
+ * @param[in] uncomp_data : Contains the uncompensated pressure data.\r
+ * @param[in] calib_data : Pointer to the calibration data structure.\r
+ *\r
+ * @return Compensated pressure data.\r
+ * @retval Compensated pressure data in integer.\r
+ */\r
+static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data);\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw humidity data and\r
+ * return the compensated humidity data in integer data type.\r
+ *\r
+ * @param[in] uncomp_data : Contains the uncompensated humidity data.\r
+ * @param[in] calib_data : Pointer to the calibration data structure.\r
+ *\r
+ * @return Compensated humidity data.\r
+ * @retval Compensated humidity data in integer.\r
+ */\r
+static uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data);\r
+\r
+#endif\r
+\r
+/*!\r
+ * @brief This internal API is used to identify the settings which the user\r
+ * wants to modify in the sensor.\r
+ *\r
+ * @param[in] sub_settings : Contains the settings subset to identify particular\r
+ * group of settings which the user is interested to change.\r
+ * @param[in] desired_settings : Contains the user specified settings.\r
+ *\r
+ * @return Indicates whether user is interested to modify the settings which\r
+ * are related to sub_settings.\r
+ * @retval True -> User wants to modify this group of settings\r
+ * @retval False -> User does not want to modify this group of settings\r
+ */\r
+static uint8_t are_settings_changed(uint8_t sub_settings, uint8_t desired_settings);\r
+\r
+/*!\r
+ * @brief This API sets the humidity oversampling settings of the sensor.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t set_osr_humidity_settings(const struct bme280_settings *settings, const struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API sets the oversampling settings for pressure,\r
+ * temperature and humidity in the sensor.\r
+ *\r
+ * @param[in] desired_settings : Variable used to select the settings which\r
+ * are to be set.\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t set_osr_settings(uint8_t desired_settings,\r
+ const struct bme280_settings *settings,\r
+ const struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This API sets the pressure and/or temperature oversampling settings\r
+ * in the sensor according to the settings selected by the user.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[in] desired_settings: variable to select the pressure and/or\r
+ * temperature oversampling settings.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t set_osr_press_temp_settings(uint8_t desired_settings,\r
+ const struct bme280_settings *settings,\r
+ const struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API fills the pressure oversampling settings provided by\r
+ * the user in the data buffer so as to write in the sensor.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[out] reg_data : Variable which is filled according to the pressure\r
+ * oversampling data provided by the user.\r
+ */\r
+static void fill_osr_press_settings(uint8_t *reg_data, const struct bme280_settings *settings);\r
+\r
+/*!\r
+ * @brief This internal API fills the temperature oversampling settings provided\r
+ * by the user in the data buffer so as to write in the sensor.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[out] reg_data : Variable which is filled according to the temperature\r
+ * oversampling data provided by the user.\r
+ */\r
+static void fill_osr_temp_settings(uint8_t *reg_data, const struct bme280_settings *settings);\r
+\r
+/*!\r
+ * @brief This internal API sets the filter and/or standby duration settings\r
+ * in the sensor according to the settings selected by the user.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[in] desired_settings : variable to select the filter and/or\r
+ * standby duration settings.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t set_filter_standby_settings(uint8_t desired_settings,\r
+ const struct bme280_settings *settings,\r
+ const struct bme280_dev *dev);\r
+\r
+/*!\r
+ * @brief This internal API fills the filter settings provided by the user\r
+ * in the data buffer so as to write in the sensor.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[out] reg_data : Variable which is filled according to the filter\r
+ * settings data provided by the user.\r
+ */\r
+static void fill_filter_settings(uint8_t *reg_data, const struct bme280_settings *settings);\r
+\r
+/*!\r
+ * @brief This internal API fills the standby duration settings provided by the\r
+ * user in the data buffer so as to write in the sensor.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[out] reg_data : Variable which is filled according to the standby\r
+ * settings data provided by the user.\r
+ */\r
+static void fill_standby_settings(uint8_t *reg_data, const struct bme280_settings *settings);\r
+\r
+/*!\r
+ * @brief This internal API parse the oversampling(pressure, temperature\r
+ * and humidity), filter and standby duration settings and store in the\r
+ * device structure.\r
+ *\r
+ * @param[out] dev : Structure instance of bme280_dev.\r
+ * @param[in] reg_data : Register data to be parsed.\r
+ */\r
+static void parse_device_settings(const uint8_t *reg_data, struct bme280_settings *settings);\r
+\r
+/*!\r
+ * @brief This internal API reloads the already existing device settings in the\r
+ * sensor after soft reset.\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ * @param[in] settings : Pointer variable which contains the settings to\r
+ * be set in the sensor.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static int8_t reload_device_settings(const struct bme280_settings *settings, const struct bme280_dev *dev);\r
+\r
+/****************** Global Function Definitions *******************************/\r
+\r
+/*!\r
+ * @brief This API is the entry point.\r
+ * It reads the chip-id and calibration data from the sensor.\r
+ */\r
+int8_t bme280_init(struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+\r
+ /* chip id read try count */\r
+ uint8_t try_count = 5;\r
+ uint8_t chip_id = 0;\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+\r
+ /* Proceed if null check is fine */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ while (try_count)\r
+ {\r
+ /* Read the chip-id of bme280 sensor */\r
+ rslt = bme280_get_regs(BME280_CHIP_ID_ADDR, &chip_id, 1, dev);\r
+\r
+ /* Check for chip id validity */\r
+ if ((rslt == BME280_OK) && (chip_id == BME280_CHIP_ID))\r
+ {\r
+ dev->chip_id = chip_id;\r
+\r
+ /* Reset the sensor */\r
+ rslt = bme280_soft_reset(dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* Read the calibration data */\r
+ rslt = get_calib_data(dev);\r
+ }\r
+ break;\r
+ }\r
+\r
+ /* Wait for 1 ms */\r
+ dev->delay_ms(1);\r
+ --try_count;\r
+ }\r
+\r
+ /* Chip id check failed */\r
+ if (!try_count)\r
+ {\r
+ rslt = BME280_E_DEV_NOT_FOUND;\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API reads the data from the given register address of the sensor.\r
+ */\r
+int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+\r
+ /* Proceed if null check is fine */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* If interface selected is SPI */\r
+ if (dev->intf != BME280_I2C_INTF)\r
+ {\r
+ reg_addr = reg_addr | 0x80;\r
+ }\r
+\r
+ /* Read the data */\r
+ rslt = dev->read(dev->dev_id, reg_addr, reg_data, len);\r
+\r
+ /* Check for communication error */\r
+ if (rslt != BME280_OK)\r
+ {\r
+ rslt = BME280_E_COMM_FAIL;\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API writes the given data to the register address\r
+ * of the sensor.\r
+ */\r
+int8_t bme280_set_regs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t temp_buff[20]; /* Typically not to write more than 10 registers */\r
+\r
+ if (len > 10)\r
+ {\r
+ len = 10;\r
+ }\r
+ uint16_t temp_len;\r
+ uint8_t reg_addr_cnt;\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+\r
+ /* Check for arguments validity */\r
+ if ((rslt == BME280_OK) && (reg_addr != NULL) && (reg_data != NULL))\r
+ {\r
+ if (len != 0)\r
+ {\r
+ temp_buff[0] = reg_data[0];\r
+\r
+ /* If interface selected is SPI */\r
+ if (dev->intf != BME280_I2C_INTF)\r
+ {\r
+ for (reg_addr_cnt = 0; reg_addr_cnt < len; reg_addr_cnt++)\r
+ {\r
+ reg_addr[reg_addr_cnt] = reg_addr[reg_addr_cnt] & 0x7F;\r
+ }\r
+ }\r
+\r
+ /* Burst write mode */\r
+ if (len > 1)\r
+ {\r
+ /* Interleave register address w.r.t data for\r
+ * burst write\r
+ */\r
+ interleave_reg_addr(reg_addr, temp_buff, reg_data, len);\r
+ temp_len = ((len * 2) - 1);\r
+ }\r
+ else\r
+ {\r
+ temp_len = len;\r
+ }\r
+ rslt = dev->write(dev->dev_id, reg_addr[0], temp_buff, temp_len);\r
+\r
+ /* Check for communication error */\r
+ if (rslt != BME280_OK)\r
+ {\r
+ rslt = BME280_E_COMM_FAIL;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ rslt = BME280_E_INVALID_LEN;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ rslt = BME280_E_NULL_PTR;\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API sets the oversampling, filter and standby duration\r
+ * (normal mode) settings in the sensor.\r
+ */\r
+int8_t bme280_set_sensor_settings(uint8_t desired_settings, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t sensor_mode;\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+\r
+ /* Proceed if null check is fine */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ rslt = bme280_get_sensor_mode(&sensor_mode, dev);\r
+ if ((rslt == BME280_OK) && (sensor_mode != BME280_SLEEP_MODE))\r
+ {\r
+ rslt = put_device_to_sleep(dev);\r
+ }\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* Check if user wants to change oversampling\r
+ * settings\r
+ */\r
+ if (are_settings_changed(OVERSAMPLING_SETTINGS, desired_settings))\r
+ {\r
+ rslt = set_osr_settings(desired_settings, &dev->settings, dev);\r
+ }\r
+\r
+ /* Check if user wants to change filter and/or\r
+ * standby settings\r
+ */\r
+ if ((rslt == BME280_OK) && are_settings_changed(FILTER_STANDBY_SETTINGS, desired_settings))\r
+ {\r
+ rslt = set_filter_standby_settings(desired_settings, &dev->settings, dev);\r
+ }\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API gets the oversampling, filter and standby duration\r
+ * (normal mode) settings from the sensor.\r
+ */\r
+int8_t bme280_get_sensor_settings(struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t reg_data[4];\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+\r
+ /* Proceed if null check is fine */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ rslt = bme280_get_regs(BME280_CTRL_HUM_ADDR, reg_data, 4, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ parse_device_settings(reg_data, &dev->settings);\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API sets the power mode of the sensor.\r
+ */\r
+int8_t bme280_set_sensor_mode(uint8_t sensor_mode, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t last_set_mode;\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ rslt = bme280_get_sensor_mode(&last_set_mode, dev);\r
+\r
+ /* If the sensor is not in sleep mode put the device to sleep\r
+ * mode\r
+ */\r
+ if ((rslt == BME280_OK) && (last_set_mode != BME280_SLEEP_MODE))\r
+ {\r
+ rslt = put_device_to_sleep(dev);\r
+ }\r
+\r
+ /* Set the power mode */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ rslt = write_power_mode(sensor_mode, dev);\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API gets the power mode of the sensor.\r
+ */\r
+int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* Read the power mode register */\r
+ rslt = bme280_get_regs(BME280_PWR_CTRL_ADDR, sensor_mode, 1, dev);\r
+\r
+ /* Assign the power mode in the device structure */\r
+ *sensor_mode = BME280_GET_BITS_POS_0(*sensor_mode, BME280_SENSOR_MODE);\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API performs the soft reset of the sensor.\r
+ */\r
+int8_t bme280_soft_reset(const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t reg_addr = BME280_RESET_ADDR;\r
+ uint8_t status_reg = 0;\r
+ uint8_t try_run = 5;\r
+\r
+ /* 0xB6 is the soft reset command */\r
+ uint8_t soft_rst_cmd = BME280_SOFT_RESET_COMMAND;\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+\r
+ /* Proceed if null check is fine */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* Write the soft reset command in the sensor */\r
+ rslt = bme280_set_regs(®_addr, &soft_rst_cmd, 1, dev);\r
+\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* If NVM not copied yet, Wait for NVM to copy */\r
+ do\r
+ {\r
+ /* As per data sheet - Table 1, startup time is 2 ms. */\r
+ dev->delay_ms(2);\r
+ rslt = bme280_get_regs(BME280_STATUS_REG_ADDR, &status_reg, 1, dev);\r
+ } while ((rslt == BME280_OK) && (try_run--) && (status_reg & BME280_STATUS_IM_UPDATE));\r
+\r
+ if (status_reg & BME280_STATUS_IM_UPDATE)\r
+ {\r
+ rslt = BME280_E_NVM_COPY_FAILED;\r
+ }\r
+\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API reads the pressure, temperature and humidity data from the\r
+ * sensor, compensates the data and store it in the bme280_data structure\r
+ * instance passed by the user.\r
+ */\r
+int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+\r
+ /* Array to store the pressure, temperature and humidity data read from\r
+ * the sensor\r
+ */\r
+ uint8_t reg_data[BME280_P_T_H_DATA_LEN] = { 0 };\r
+ struct bme280_uncomp_data uncomp_data = { 0 };\r
+\r
+ /* Check for null pointer in the device structure*/\r
+ rslt = null_ptr_check(dev);\r
+ if ((rslt == BME280_OK) && (comp_data != NULL))\r
+ {\r
+ /* Read the pressure and temperature data from the sensor */\r
+ rslt = bme280_get_regs(BME280_DATA_ADDR, reg_data, BME280_P_T_H_DATA_LEN, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* Parse the read data from the sensor */\r
+ bme280_parse_sensor_data(reg_data, &uncomp_data);\r
+\r
+ /* Compensate the pressure and/or temperature and/or\r
+ * humidity data from the sensor\r
+ */\r
+ rslt = bme280_compensate_data(sensor_comp, &uncomp_data, comp_data, &dev->calib_data);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ rslt = BME280_E_NULL_PTR;\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API is used to parse the pressure, temperature and\r
+ * humidity data and store it in the bme280_uncomp_data structure instance.\r
+ */\r
+void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data)\r
+{\r
+ /* Variables to store the sensor data */\r
+ uint32_t data_xlsb;\r
+ uint32_t data_lsb;\r
+ uint32_t data_msb;\r
+\r
+ /* Store the parsed register values for pressure data */\r
+ data_msb = (uint32_t)reg_data[0] << 12;\r
+ data_lsb = (uint32_t)reg_data[1] << 4;\r
+ data_xlsb = (uint32_t)reg_data[2] >> 4;\r
+ uncomp_data->pressure = data_msb | data_lsb | data_xlsb;\r
+\r
+ /* Store the parsed register values for temperature data */\r
+ data_msb = (uint32_t)reg_data[3] << 12;\r
+ data_lsb = (uint32_t)reg_data[4] << 4;\r
+ 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
+ uncomp_data->humidity = data_msb | data_lsb;\r
+}\r
+\r
+/*!\r
+ * @brief This API is used to compensate the pressure and/or\r
+ * temperature and/or humidity data according to the component selected\r
+ * by the user.\r
+ */\r
+int8_t bme280_compensate_data(uint8_t sensor_comp,\r
+ const struct bme280_uncomp_data *uncomp_data,\r
+ struct bme280_data *comp_data,\r
+ struct bme280_calib_data *calib_data)\r
+{\r
+ int8_t rslt = BME280_OK;\r
+\r
+ if ((uncomp_data != NULL) && (comp_data != NULL) && (calib_data != NULL))\r
+ {\r
+ /* Initialize to zero */\r
+ comp_data->temperature = 0;\r
+ comp_data->pressure = 0;\r
+ comp_data->humidity = 0;\r
+\r
+ /* If pressure or temperature component is selected */\r
+ if (sensor_comp & (BME280_PRESS | BME280_TEMP | BME280_HUM))\r
+ {\r
+ /* Compensate the temperature data */\r
+ comp_data->temperature = compensate_temperature(uncomp_data, calib_data);\r
+ }\r
+ if (sensor_comp & BME280_PRESS)\r
+ {\r
+ /* Compensate the pressure data */\r
+ comp_data->pressure = compensate_pressure(uncomp_data, calib_data);\r
+ }\r
+ if (sensor_comp & BME280_HUM)\r
+ {\r
+ /* Compensate the humidity data */\r
+ comp_data->humidity = compensate_humidity(uncomp_data, calib_data);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ rslt = BME280_E_NULL_PTR;\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API sets the oversampling settings for pressure,\r
+ * temperature and humidity in the sensor.\r
+ */\r
+static int8_t set_osr_settings(uint8_t desired_settings,\r
+ const struct bme280_settings *settings,\r
+ const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt = BME280_W_INVALID_OSR_MACRO;\r
+\r
+ if (desired_settings & BME280_OSR_HUM_SEL)\r
+ {\r
+ rslt = set_osr_humidity_settings(settings, dev);\r
+ }\r
+ if (desired_settings & (BME280_OSR_PRESS_SEL | BME280_OSR_TEMP_SEL))\r
+ {\r
+ rslt = set_osr_press_temp_settings(desired_settings, settings, dev);\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API sets the humidity oversampling settings of the sensor.\r
+ */\r
+static int8_t set_osr_humidity_settings(const struct bme280_settings *settings, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t ctrl_hum;\r
+ uint8_t ctrl_meas;\r
+ uint8_t reg_addr = BME280_CTRL_HUM_ADDR;\r
+\r
+ ctrl_hum = settings->osr_h & BME280_CTRL_HUM_MSK;\r
+\r
+ /* Write the humidity control value in the register */\r
+ rslt = bme280_set_regs(®_addr, &ctrl_hum, 1, dev);\r
+\r
+ /* Humidity related changes will be only effective after a\r
+ * write operation to ctrl_meas register\r
+ */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ reg_addr = BME280_CTRL_MEAS_ADDR;\r
+ rslt = bme280_get_regs(reg_addr, &ctrl_meas, 1, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ rslt = bme280_set_regs(®_addr, &ctrl_meas, 1, dev);\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API sets the pressure and/or temperature oversampling settings\r
+ * in the sensor according to the settings selected by the user.\r
+ */\r
+static int8_t set_osr_press_temp_settings(uint8_t desired_settings,\r
+ const struct bme280_settings *settings,\r
+ const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t reg_addr = BME280_CTRL_MEAS_ADDR;\r
+ uint8_t reg_data;\r
+\r
+ rslt = bme280_get_regs(reg_addr, ®_data, 1, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ if (desired_settings & BME280_OSR_PRESS_SEL)\r
+ {\r
+ fill_osr_press_settings(®_data, settings);\r
+ }\r
+ if (desired_settings & BME280_OSR_TEMP_SEL)\r
+ {\r
+ fill_osr_temp_settings(®_data, settings);\r
+ }\r
+\r
+ /* Write the oversampling settings in the register */\r
+ rslt = bme280_set_regs(®_addr, ®_data, 1, dev);\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API sets the filter and/or standby duration settings\r
+ * in the sensor according to the settings selected by the user.\r
+ */\r
+static int8_t set_filter_standby_settings(uint8_t desired_settings,\r
+ const struct bme280_settings *settings,\r
+ const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t reg_addr = BME280_CONFIG_ADDR;\r
+ uint8_t reg_data;\r
+\r
+ rslt = bme280_get_regs(reg_addr, ®_data, 1, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ if (desired_settings & BME280_FILTER_SEL)\r
+ {\r
+ fill_filter_settings(®_data, settings);\r
+ }\r
+ if (desired_settings & BME280_STANDBY_SEL)\r
+ {\r
+ fill_standby_settings(®_data, settings);\r
+ }\r
+\r
+ /* Write the oversampling settings in the register */\r
+ rslt = bme280_set_regs(®_addr, ®_data, 1, dev);\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API fills the filter settings provided by the user\r
+ * in the data buffer so as to write in the sensor.\r
+ */\r
+static void fill_filter_settings(uint8_t *reg_data, const struct bme280_settings *settings)\r
+{\r
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_FILTER, settings->filter);\r
+}\r
+\r
+/*!\r
+ * @brief This internal API fills the standby duration settings provided by\r
+ * the user in the data buffer so as to write in the sensor.\r
+ */\r
+static void fill_standby_settings(uint8_t *reg_data, const struct bme280_settings *settings)\r
+{\r
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_STANDBY, settings->standby_time);\r
+}\r
+\r
+/*!\r
+ * @brief This internal API fills the pressure oversampling settings provided by\r
+ * the user in the data buffer so as to write in the sensor.\r
+ */\r
+static void fill_osr_press_settings(uint8_t *reg_data, const struct bme280_settings *settings)\r
+{\r
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_PRESS, settings->osr_p);\r
+}\r
+\r
+/*!\r
+ * @brief This internal API fills the temperature oversampling settings\r
+ * provided by the user in the data buffer so as to write in the sensor.\r
+ */\r
+static void fill_osr_temp_settings(uint8_t *reg_data, const struct bme280_settings *settings)\r
+{\r
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_TEMP, settings->osr_t);\r
+}\r
+\r
+/*!\r
+ * @brief This internal API parse the oversampling(pressure, temperature\r
+ * and humidity), filter and standby duration settings and store in the\r
+ * device structure.\r
+ */\r
+static void parse_device_settings(const uint8_t *reg_data, struct bme280_settings *settings)\r
+{\r
+ settings->osr_h = BME280_GET_BITS_POS_0(reg_data[0], BME280_CTRL_HUM);\r
+ settings->osr_p = BME280_GET_BITS(reg_data[2], BME280_CTRL_PRESS);\r
+ settings->osr_t = BME280_GET_BITS(reg_data[2], BME280_CTRL_TEMP);\r
+ settings->filter = BME280_GET_BITS(reg_data[3], BME280_FILTER);\r
+ settings->standby_time = BME280_GET_BITS(reg_data[3], BME280_STANDBY);\r
+}\r
+\r
+/*!\r
+ * @brief This internal API writes the power mode in the sensor.\r
+ */\r
+static int8_t write_power_mode(uint8_t sensor_mode, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t reg_addr = BME280_PWR_CTRL_ADDR;\r
+\r
+ /* Variable to store the value read from power mode register */\r
+ uint8_t sensor_mode_reg_val;\r
+\r
+ /* Read the power mode register */\r
+ rslt = bme280_get_regs(reg_addr, &sensor_mode_reg_val, 1, dev);\r
+\r
+ /* Set the power mode */\r
+ if (rslt == BME280_OK)\r
+ {\r
+ sensor_mode_reg_val = BME280_SET_BITS_POS_0(sensor_mode_reg_val, BME280_SENSOR_MODE, sensor_mode);\r
+\r
+ /* Write the power mode in the register */\r
+ rslt = bme280_set_regs(®_addr, &sensor_mode_reg_val, 1, dev);\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API puts the device to sleep mode.\r
+ */\r
+static int8_t put_device_to_sleep(const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t reg_data[4];\r
+ struct bme280_settings settings;\r
+\r
+ rslt = bme280_get_regs(BME280_CTRL_HUM_ADDR, reg_data, 4, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ parse_device_settings(reg_data, &settings);\r
+ rslt = bme280_soft_reset(dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ rslt = reload_device_settings(&settings, dev);\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API reloads the already existing device settings in\r
+ * the sensor after soft reset.\r
+ */\r
+static int8_t reload_device_settings(const struct bme280_settings *settings, const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+\r
+ rslt = set_osr_settings(BME280_ALL_SETTINGS_SEL, settings, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ rslt = set_filter_standby_settings(BME280_ALL_SETTINGS_SEL, settings, dev);\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+#ifdef BME280_FLOAT_ENABLE\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw temperature data and\r
+ * return the compensated temperature data in double data type.\r
+ */\r
+static double compensate_temperature(const struct bme280_uncomp_data *uncomp_data, struct bme280_calib_data *calib_data)\r
+{\r
+ double var1;\r
+ double var2;\r
+ double temperature;\r
+ double temperature_min = -40;\r
+ double temperature_max = 85;\r
+\r
+ var1 = ((double)uncomp_data->temperature) / 16384.0 - ((double)calib_data->dig_T1) / 1024.0;\r
+ var1 = var1 * ((double)calib_data->dig_T2);\r
+ var2 = (((double)uncomp_data->temperature) / 131072.0 - ((double)calib_data->dig_T1) / 8192.0);\r
+ var2 = (var2 * var2) * ((double)calib_data->dig_T3);\r
+ calib_data->t_fine = (int32_t)(var1 + var2);\r
+ temperature = (var1 + var2) / 5120.0;\r
+ if (temperature < temperature_min)\r
+ {\r
+ temperature = temperature_min;\r
+ }\r
+ else if (temperature > temperature_max)\r
+ {\r
+ temperature = temperature_max;\r
+ }\r
+\r
+ return temperature;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw pressure data and\r
+ * return the compensated pressure data in double data type.\r
+ */\r
+static double compensate_pressure(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data)\r
+{\r
+ double var1;\r
+ double var2;\r
+ double var3;\r
+ double pressure;\r
+ double pressure_min = 30000.0;\r
+ double pressure_max = 110000.0;\r
+\r
+ var1 = ((double)calib_data->t_fine / 2.0) - 64000.0;\r
+ var2 = var1 * var1 * ((double)calib_data->dig_P6) / 32768.0;\r
+ var2 = var2 + var1 * ((double)calib_data->dig_P5) * 2.0;\r
+ var2 = (var2 / 4.0) + (((double)calib_data->dig_P4) * 65536.0);\r
+ var3 = ((double)calib_data->dig_P3) * var1 * var1 / 524288.0;\r
+ var1 = (var3 + ((double)calib_data->dig_P2) * var1) / 524288.0;\r
+ var1 = (1.0 + var1 / 32768.0) * ((double)calib_data->dig_P1);\r
+\r
+ /* avoid exception caused by division by zero */\r
+ if (var1)\r
+ {\r
+ pressure = 1048576.0 - (double) uncomp_data->pressure;\r
+ pressure = (pressure - (var2 / 4096.0)) * 6250.0 / var1;\r
+ var1 = ((double)calib_data->dig_P9) * pressure * pressure / 2147483648.0;\r
+ var2 = pressure * ((double)calib_data->dig_P8) / 32768.0;\r
+ pressure = pressure + (var1 + var2 + ((double)calib_data->dig_P7)) / 16.0;\r
+ if (pressure < pressure_min)\r
+ {\r
+ pressure = pressure_min;\r
+ }\r
+ else if (pressure > pressure_max)\r
+ {\r
+ pressure = pressure_max;\r
+ }\r
+ }\r
+ else /* Invalid case */\r
+ {\r
+ pressure = pressure_min;\r
+ }\r
+\r
+ return pressure;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw humidity data and\r
+ * return the compensated humidity data in double data type.\r
+ */\r
+static double compensate_humidity(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data)\r
+{\r
+ double humidity;\r
+ double humidity_min = 0.0;\r
+ double humidity_max = 100.0;\r
+ double var1;\r
+ double var2;\r
+ double var3;\r
+ double var4;\r
+ double var5;\r
+ double var6;\r
+\r
+ var1 = ((double)calib_data->t_fine) - 76800.0;\r
+ var2 = (((double)calib_data->dig_H4) * 64.0 + (((double)calib_data->dig_H5) / 16384.0) * var1);\r
+ var3 = uncomp_data->humidity - var2;\r
+ var4 = ((double)calib_data->dig_H2) / 65536.0;\r
+ var5 = (1.0 + (((double)calib_data->dig_H3) / 67108864.0) * var1);\r
+ var6 = 1.0 + (((double)calib_data->dig_H6) / 67108864.0) * var1 * var5;\r
+ var6 = var3 * var4 * (var5 * var6);\r
+ humidity = var6 * (1.0 - ((double)calib_data->dig_H1) * var6 / 524288.0);\r
+ if (humidity > humidity_max)\r
+ {\r
+ humidity = humidity_max;\r
+ }\r
+ else if (humidity < humidity_min)\r
+ {\r
+ humidity = humidity_min;\r
+ }\r
+\r
+ return humidity;\r
+}\r
+\r
+#else\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw temperature data and\r
+ * return the compensated temperature data in integer data type.\r
+ */\r
+static int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_data,\r
+ struct bme280_calib_data *calib_data)\r
+{\r
+ int32_t var1;\r
+ int32_t var2;\r
+ int32_t temperature;\r
+ 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
+ calib_data->t_fine = var1 + var2;\r
+ temperature = (calib_data->t_fine * 5 + 128) / 256;\r
+ if (temperature < temperature_min)\r
+ {\r
+ temperature = temperature_min;\r
+ }\r
+ else if (temperature > temperature_max)\r
+ {\r
+ temperature = temperature_max;\r
+ }\r
+\r
+ return temperature;\r
+}\r
+#ifdef BME280_64BIT_ENABLE\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw pressure data and\r
+ * return the compensated pressure data in integer data type with higher\r
+ * accuracy.\r
+ */\r
+static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data)\r
+{\r
+ int64_t var1;\r
+ int64_t var2;\r
+ int64_t var3;\r
+ int64_t var4;\r
+ uint32_t pressure;\r
+ uint32_t pressure_min = 3000000;\r
+ 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
+ var3 = ((int64_t)1) * 140737488355328;\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
+ pressure = (uint32_t)(((var4 / 2) * 100) / 128);\r
+ if (pressure < pressure_min)\r
+ {\r
+ pressure = pressure_min;\r
+ }\r
+ else if (pressure > pressure_max)\r
+ {\r
+ pressure = pressure_max;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ pressure = pressure_min;\r
+ }\r
+\r
+ return pressure;\r
+}\r
+#else\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw pressure data and\r
+ * return the compensated pressure data in integer data type.\r
+ */\r
+static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data)\r
+{\r
+ int32_t var1;\r
+ int32_t var2;\r
+ int32_t var3;\r
+ int32_t var4;\r
+ uint32_t var5;\r
+ uint32_t pressure;\r
+ uint32_t pressure_min = 30000;\r
+ uint32_t pressure_max = 110000;\r
+\r
+ var1 = (((int32_t)calib_data->t_fine) / 2) - (int32_t)64000;\r
+ var2 = (((var1 / 4) * (var1 / 4)) / 2048) * ((int32_t)calib_data->dig_P6);\r
+ var2 = var2 + ((var1 * ((int32_t)calib_data->dig_P5)) * 2);\r
+ var2 = (var2 / 4) + (((int32_t)calib_data->dig_P4) * 65536);\r
+ var3 = (calib_data->dig_P3 * (((var1 / 4) * (var1 / 4)) / 8192)) / 8;\r
+ var4 = (((int32_t)calib_data->dig_P2) * var1) / 2;\r
+ var1 = (var3 + var4) / 262144;\r
+ var1 = (((32768 + var1)) * ((int32_t)calib_data->dig_P1)) / 32768;\r
+\r
+ /* avoid exception caused by division by zero */\r
+ if (var1)\r
+ {\r
+ var5 = (uint32_t)((uint32_t)1048576) - uncomp_data->pressure;\r
+ pressure = ((uint32_t)(var5 - (uint32_t)(var2 / 4096))) * 3125;\r
+ if (pressure < 0x80000000)\r
+ {\r
+ pressure = (pressure << 1) / ((uint32_t)var1);\r
+ }\r
+ else\r
+ {\r
+ pressure = (pressure / (uint32_t)var1) * 2;\r
+ }\r
+ var1 = (((int32_t)calib_data->dig_P9) * ((int32_t)(((pressure / 8) * (pressure / 8)) / 8192))) / 4096;\r
+ var2 = (((int32_t)(pressure / 4)) * ((int32_t)calib_data->dig_P8)) / 8192;\r
+ pressure = (uint32_t)((int32_t)pressure + ((var1 + var2 + calib_data->dig_P7) / 16));\r
+ if (pressure < pressure_min)\r
+ {\r
+ pressure = pressure_min;\r
+ }\r
+ else if (pressure > pressure_max)\r
+ {\r
+ pressure = pressure_max;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ pressure = pressure_min;\r
+ }\r
+\r
+ return pressure;\r
+}\r
+#endif\r
+\r
+/*!\r
+ * @brief This internal API is used to compensate the raw humidity data and\r
+ * return the compensated humidity data in integer data type.\r
+ */\r
+static uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data,\r
+ const struct bme280_calib_data *calib_data)\r
+{\r
+ int32_t var1;\r
+ int32_t var2;\r
+ int32_t var3;\r
+ int32_t var4;\r
+ int32_t var5;\r
+ uint32_t humidity;\r
+ uint32_t humidity_max = 102400;\r
+\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
+ 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
+ var4 = ((var2 * (var3 + (int32_t)32768)) / 1024) + (int32_t)2097152;\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 = (var5 < 0 ? 0 : var5);\r
+ var5 = (var5 > 419430400 ? 419430400 : var5);\r
+ humidity = (uint32_t)(var5 / 4096);\r
+ if (humidity > humidity_max)\r
+ {\r
+ humidity = humidity_max;\r
+ }\r
+\r
+ return humidity;\r
+}\r
+#endif\r
+\r
+/*!\r
+ * @brief This internal API reads the calibration data from the sensor, parse\r
+ * it and store in the device structure.\r
+ */\r
+static int8_t get_calib_data(struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+ uint8_t reg_addr = BME280_TEMP_PRESS_CALIB_DATA_ADDR;\r
+\r
+ /* Array to store calibration data */\r
+ uint8_t calib_data[BME280_TEMP_PRESS_CALIB_DATA_LEN] = { 0 };\r
+\r
+ /* Read the calibration data from the sensor */\r
+ rslt = bme280_get_regs(reg_addr, calib_data, BME280_TEMP_PRESS_CALIB_DATA_LEN, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* Parse temperature and pressure calibration data and store\r
+ * it in device structure\r
+ */\r
+ parse_temp_press_calib_data(calib_data, dev);\r
+ reg_addr = BME280_HUMIDITY_CALIB_DATA_ADDR;\r
+\r
+ /* Read the humidity calibration data from the sensor */\r
+ rslt = bme280_get_regs(reg_addr, calib_data, BME280_HUMIDITY_CALIB_DATA_LEN, dev);\r
+ if (rslt == BME280_OK)\r
+ {\r
+ /* Parse humidity calibration data and store it in\r
+ * device structure\r
+ */\r
+ parse_humidity_calib_data(calib_data, dev);\r
+ }\r
+ }\r
+\r
+ return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API interleaves the register address between the\r
+ * register data buffer for burst write operation.\r
+ */\r
+static void interleave_reg_addr(const uint8_t *reg_addr, uint8_t *temp_buff, const uint8_t *reg_data, uint8_t len)\r
+{\r
+ uint8_t index;\r
+\r
+ for (index = 1; index < len; index++)\r
+ {\r
+ temp_buff[(index * 2) - 1] = reg_addr[index];\r
+ temp_buff[index * 2] = reg_data[index];\r
+ }\r
+}\r
+\r
+/*!\r
+ * @brief This internal API is used to parse the temperature and\r
+ * pressure calibration data and store it in device structure.\r
+ */\r
+static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_dev *dev)\r
+{\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
+}\r
+\r
+/*!\r
+ * @brief This internal API is used to parse the humidity calibration data\r
+ * and store it in device structure.\r
+ */\r
+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
+}\r
+\r
+/*!\r
+ * @brief This internal API is used to identify the settings which the user\r
+ * wants to modify in the sensor.\r
+ */\r
+static uint8_t are_settings_changed(uint8_t sub_settings, uint8_t desired_settings)\r
+{\r
+ uint8_t settings_changed = FALSE;\r
+\r
+ if (sub_settings & desired_settings)\r
+ {\r
+ /* User wants to modify this particular settings */\r
+ settings_changed = TRUE;\r
+ }\r
+ else\r
+ {\r
+ /* User don't want to modify this particular settings */\r
+ settings_changed = FALSE;\r
+ }\r
+\r
+ return settings_changed;\r
+}\r
+\r
+/*!\r
+ * @brief This internal API is used to validate the device structure pointer for\r
+ * null conditions.\r
+ */\r
+static int8_t null_ptr_check(const struct bme280_dev *dev)\r
+{\r
+ int8_t rslt;\r
+\r
+ if ((dev == NULL) || (dev->read == NULL) || (dev->write == NULL) || (dev->delay_ms == NULL))\r
+ {\r
+ /* Device structure pointer is not valid */\r
+ rslt = BME280_E_NULL_PTR;\r
+ }\r
+ else\r
+ {\r
+ /* Device structure is fine */\r
+ rslt = BME280_OK;\r
+ }\r
+\r
+ return rslt;\r
+}\r
-/**
- * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * Neither the name of the copyright holder nor the names of the
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
- * OR CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
- * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
- *
- * The information provided is believed to be accurate and reliable.
- * The copyright holder assumes no responsibility
- * for the consequences of use
- * of such information nor for any infringement of patents or
- * other rights of third parties which may result from its use.
- * No license is granted by implication or otherwise under any patent or
- * patent rights of the copyright holder.
- *
- * @file bme280_defs.h
- * @date 08 Mar 2019
- * @version 3.3.6
- * @brief
- *
- */
-
-/*! @file bme280_defs.h
- * @brief Sensor driver for BME280 sensor
- */
-
-/*!
- * @defgroup BME280 SENSOR API
- * @brief
- */
-#ifndef BME280_DEFS_H_
-#define BME280_DEFS_H_
-
-/********************************************************/
-/* header includes */
-#ifdef __KERNEL__
-#include <linux/types.h>
-#include <linux/kernel.h>
-#else
-#include <stdint.h>
-#include <stddef.h>
-#endif
-
-/********************************************************/
-/*! @name Common macros */
-/********************************************************/
-
-#if !defined(UINT8_C) && !defined(INT8_C)
-#define INT8_C(x) S8_C(x)
-#define UINT8_C(x) U8_C(x)
-#endif
-
-#if !defined(UINT16_C) && !defined(INT16_C)
-#define INT16_C(x) S16_C(x)
-#define UINT16_C(x) U16_C(x)
-#endif
-
-#if !defined(INT32_C) && !defined(UINT32_C)
-#define INT32_C(x) S32_C(x)
-#define UINT32_C(x) U32_C(x)
-#endif
-
-#if !defined(INT64_C) && !defined(UINT64_C)
-#define INT64_C(x) S64_C(x)
-#define UINT64_C(x) U64_C(x)
-#endif
-
-/**@}*/
-/**\name C standard macros */
-#ifndef NULL
-#ifdef __cplusplus
-#define NULL 0
-#else
-#define NULL ((void *) 0)
-#endif
-#endif
-
-/********************************************************/
-
-#ifndef BME280_FLOAT_ENABLE
-
-/* #define BME280_FLOAT_ENABLE */
-#endif
-
-#ifndef BME280_FLOAT_ENABLE
-#ifndef BME280_64BIT_ENABLE
-#define BME280_64BIT_ENABLE
-#endif
-#endif
-
-#ifndef TRUE
-#define TRUE UINT8_C(1)
-#endif
-#ifndef FALSE
-#define FALSE UINT8_C(0)
-#endif
-
-/**\name I2C addresses */
-#define BME280_I2C_ADDR_PRIM UINT8_C(0x76)
-#define BME280_I2C_ADDR_SEC UINT8_C(0x77)
-
-/**\name BME280 chip identifier */
-#define BME280_CHIP_ID UINT8_C(0x60)
-
-/**\name Register Address */
-#define BME280_CHIP_ID_ADDR UINT8_C(0xD0)
-#define BME280_RESET_ADDR UINT8_C(0xE0)
-#define BME280_TEMP_PRESS_CALIB_DATA_ADDR UINT8_C(0x88)
-#define BME280_HUMIDITY_CALIB_DATA_ADDR UINT8_C(0xE1)
-#define BME280_PWR_CTRL_ADDR UINT8_C(0xF4)
-#define BME280_CTRL_HUM_ADDR UINT8_C(0xF2)
-#define BME280_CTRL_MEAS_ADDR UINT8_C(0xF4)
-#define BME280_CONFIG_ADDR UINT8_C(0xF5)
-#define BME280_DATA_ADDR UINT8_C(0xF7)
-
-/**\name API success code */
-#define BME280_OK INT8_C(0)
-
-/**\name API error codes */
-#define BME280_E_NULL_PTR INT8_C(-1)
-#define BME280_E_DEV_NOT_FOUND INT8_C(-2)
-#define BME280_E_INVALID_LEN INT8_C(-3)
-#define BME280_E_COMM_FAIL INT8_C(-4)
-#define BME280_E_SLEEP_MODE_FAIL INT8_C(-5)
-
-/**\name API warning codes */
-#define BME280_W_INVALID_OSR_MACRO INT8_C(1)
-
-/**\name Macros related to size */
-#define BME280_TEMP_PRESS_CALIB_DATA_LEN UINT8_C(26)
-#define BME280_HUMIDITY_CALIB_DATA_LEN UINT8_C(7)
-#define BME280_P_T_H_DATA_LEN UINT8_C(8)
-
-/**\name Sensor power modes */
-#define BME280_SLEEP_MODE UINT8_C(0x00)
-#define BME280_FORCED_MODE UINT8_C(0x01)
-#define BME280_NORMAL_MODE UINT8_C(0x03)
-
-/**\name Macro to combine two 8 bit data's to form a 16 bit data */
-#define BME280_CONCAT_BYTES(msb, lsb) (((uint16_t)msb << 8) | (uint16_t)lsb)
-
-#define BME280_SET_BITS(reg_data, bitname, data) \
- ((reg_data & ~(bitname##_MSK)) | \
- ((data << bitname##_POS) & bitname##_MSK))
-#define BME280_SET_BITS_POS_0(reg_data, bitname, data) \
- ((reg_data & ~(bitname##_MSK)) | \
- (data & bitname##_MSK))
-
-#define BME280_GET_BITS(reg_data, bitname) ((reg_data & (bitname##_MSK)) >> \
- (bitname##_POS))
-#define BME280_GET_BITS_POS_0(reg_data, bitname) (reg_data & (bitname##_MSK))
-
-/**\name Macros for bit masking */
-#define BME280_SENSOR_MODE_MSK UINT8_C(0x03)
-#define BME280_SENSOR_MODE_POS UINT8_C(0x00)
-
-#define BME280_CTRL_HUM_MSK UINT8_C(0x07)
-#define BME280_CTRL_HUM_POS UINT8_C(0x00)
-
-#define BME280_CTRL_PRESS_MSK UINT8_C(0x1C)
-#define BME280_CTRL_PRESS_POS UINT8_C(0x02)
-
-#define BME280_CTRL_TEMP_MSK UINT8_C(0xE0)
-#define BME280_CTRL_TEMP_POS UINT8_C(0x05)
-
-#define BME280_FILTER_MSK UINT8_C(0x1C)
-#define BME280_FILTER_POS UINT8_C(0x02)
-
-#define BME280_STANDBY_MSK UINT8_C(0xE0)
-#define BME280_STANDBY_POS UINT8_C(0x05)
-
-/**\name Sensor component selection macros
- * These values are internal for API implementation. Don't relate this to
- * data sheet.
- */
-#define BME280_PRESS UINT8_C(1)
-#define BME280_TEMP UINT8_C(1 << 1)
-#define BME280_HUM UINT8_C(1 << 2)
-#define BME280_ALL UINT8_C(0x07)
-
-/**\name Settings selection macros */
-#define BME280_OSR_PRESS_SEL UINT8_C(1)
-#define BME280_OSR_TEMP_SEL UINT8_C(1 << 1)
-#define BME280_OSR_HUM_SEL UINT8_C(1 << 2)
-#define BME280_FILTER_SEL UINT8_C(1 << 3)
-#define BME280_STANDBY_SEL UINT8_C(1 << 4)
-#define BME280_ALL_SETTINGS_SEL UINT8_C(0x1F)
-
-/**\name Oversampling macros */
-#define BME280_NO_OVERSAMPLING UINT8_C(0x00)
-#define BME280_OVERSAMPLING_1X UINT8_C(0x01)
-#define BME280_OVERSAMPLING_2X UINT8_C(0x02)
-#define BME280_OVERSAMPLING_4X UINT8_C(0x03)
-#define BME280_OVERSAMPLING_8X UINT8_C(0x04)
-#define BME280_OVERSAMPLING_16X UINT8_C(0x05)
-
-/**\name Standby duration selection macros */
-#define BME280_STANDBY_TIME_0_5_MS (0x00)
-#define BME280_STANDBY_TIME_62_5_MS (0x01)
-#define BME280_STANDBY_TIME_125_MS (0x02)
-#define BME280_STANDBY_TIME_250_MS (0x03)
-#define BME280_STANDBY_TIME_500_MS (0x04)
-#define BME280_STANDBY_TIME_1000_MS (0x05)
-#define BME280_STANDBY_TIME_10_MS (0x06)
-#define BME280_STANDBY_TIME_20_MS (0x07)
-
-/**\name Filter coefficient selection macros */
-#define BME280_FILTER_COEFF_OFF (0x00)
-#define BME280_FILTER_COEFF_2 (0x01)
-#define BME280_FILTER_COEFF_4 (0x02)
-#define BME280_FILTER_COEFF_8 (0x03)
-#define BME280_FILTER_COEFF_16 (0x04)
-
-/*!
- * @brief Interface selection Enums
- */
-enum bme280_intf {
- /*! SPI interface */
- BME280_SPI_INTF,
-
- /*! I2C interface */
- BME280_I2C_INTF
-};
-
-/*!
- * @brief Type definitions
- */
-typedef int8_t (*bme280_com_fptr_t)(uint8_t dev_id, uint8_t reg_addr, uint8_t *data, uint16_t len);
-typedef void (*bme280_delay_fptr_t)(uint32_t period);
-
-/*!
- * @brief Calibration data
- */
-struct bme280_calib_data
-{
- /**
- * @ Trim Variables
- */
-
- /**@{*/
- uint16_t dig_T1;
- int16_t dig_T2;
- int16_t dig_T3;
- uint16_t dig_P1;
- int16_t dig_P2;
- int16_t dig_P3;
- int16_t dig_P4;
- int16_t dig_P5;
- int16_t dig_P6;
- int16_t dig_P7;
- int16_t dig_P8;
- int16_t dig_P9;
- uint8_t dig_H1;
- int16_t dig_H2;
- uint8_t dig_H3;
- int16_t dig_H4;
- int16_t dig_H5;
- int8_t dig_H6;
- int32_t t_fine;
-
- /**@}*/
-};
-
-/*!
- * @brief bme280 sensor structure which comprises of temperature, pressure and
- * humidity data
- */
-#ifdef BME280_FLOAT_ENABLE
-struct bme280_data
-{
- /*! Compensated pressure */
- double pressure;
-
- /*! Compensated temperature */
- double temperature;
-
- /*! Compensated humidity */
- double humidity;
-};
-#else
-struct bme280_data
-{
- /*! Compensated pressure */
- uint32_t pressure;
-
- /*! Compensated temperature */
- int32_t temperature;
-
- /*! Compensated humidity */
- uint32_t humidity;
-};
-#endif /* BME280_USE_FLOATING_POINT */
-
-/*!
- * @brief bme280 sensor structure which comprises of uncompensated temperature,
- * pressure and humidity data
- */
-struct bme280_uncomp_data
-{
- /*! un-compensated pressure */
- uint32_t pressure;
-
- /*! un-compensated temperature */
- uint32_t temperature;
-
- /*! un-compensated humidity */
- uint32_t humidity;
-};
-
-/*!
- * @brief bme280 sensor settings structure which comprises of mode,
- * oversampling and filter settings.
- */
-struct bme280_settings
-{
- /*! pressure oversampling */
- uint8_t osr_p;
-
- /*! temperature oversampling */
- uint8_t osr_t;
-
- /*! humidity oversampling */
- uint8_t osr_h;
-
- /*! filter coefficient */
- uint8_t filter;
-
- /*! standby time */
- uint8_t standby_time;
-};
-
-/*!
- * @brief bme280 device structure
- */
-struct bme280_dev
-{
- /*! Chip Id */
- uint8_t chip_id;
-
- /*! Device Id */
- uint8_t dev_id;
-
- /*! SPI/I2C interface */
- enum bme280_intf intf;
-
- /*! Read function pointer */
- bme280_com_fptr_t read;
-
- /*! Write function pointer */
- bme280_com_fptr_t write;
-
- /*! Delay function pointer */
- bme280_delay_fptr_t delay_ms;
-
- /*! Trim data */
- struct bme280_calib_data calib_data;
-
- /*! Sensor settings */
- struct bme280_settings settings;
-};
-
-#endif /* BME280_DEFS_H_ */
-/** @}*/
-/** @}*/
+/**\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_defs.h\r
+ * @date 26 Aug 2019\r
+ * @version 3.3.7\r
+ * @brief\r
+ *\r
+ */\r
+\r
+/*! @file bme280_defs.h\r
+ * @brief Sensor driver for BME280 sensor\r
+ */\r
+\r
+/*!\r
+ * @defgroup BME280 SENSOR API\r
+ * @brief\r
+ */\r
+#ifndef BME280_DEFS_H_\r
+#define BME280_DEFS_H_\r
+\r
+/********************************************************/\r
+/* header includes */\r
+#ifdef __KERNEL__\r
+#include <linux/types.h>\r
+#include <linux/kernel.h>\r
+#else\r
+#include <stdint.h>\r
+#include <stddef.h>\r
+#endif\r
+\r
+/********************************************************/\r
+/*! @name Common macros */\r
+/********************************************************/\r
+\r
+#if !defined(UINT8_C) && !defined(INT8_C)\r
+#define INT8_C(x) S8_C(x)\r
+#define UINT8_C(x) U8_C(x)\r
+#endif\r
+\r
+#if !defined(UINT16_C) && !defined(INT16_C)\r
+#define INT16_C(x) S16_C(x)\r
+#define UINT16_C(x) U16_C(x)\r
+#endif\r
+\r
+#if !defined(INT32_C) && !defined(UINT32_C)\r
+#define INT32_C(x) S32_C(x)\r
+#define UINT32_C(x) U32_C(x)\r
+#endif\r
+\r
+#if !defined(INT64_C) && !defined(UINT64_C)\r
+#define INT64_C(x) S64_C(x)\r
+#define UINT64_C(x) U64_C(x)\r
+#endif\r
+\r
+/**@}*/\r
+/**\name C standard macros */\r
+#ifndef NULL\r
+#ifdef __cplusplus\r
+#define NULL 0\r
+#else\r
+#define NULL ((void *) 0)\r
+#endif\r
+#endif\r
+\r
+/********************************************************/\r
+\r
+#ifndef BME280_FLOAT_ENABLE\r
+\r
+/* #define BME280_FLOAT_ENABLE */\r
+#endif\r
+\r
+#ifndef BME280_FLOAT_ENABLE\r
+#ifndef BME280_64BIT_ENABLE\r
+#define BME280_64BIT_ENABLE\r
+#endif\r
+#endif\r
+\r
+#ifndef TRUE\r
+#define TRUE UINT8_C(1)\r
+#endif\r
+#ifndef FALSE\r
+#define FALSE UINT8_C(0)\r
+#endif\r
+\r
+/**\name I2C addresses */\r
+#define BME280_I2C_ADDR_PRIM UINT8_C(0x76)\r
+#define BME280_I2C_ADDR_SEC UINT8_C(0x77)\r
+\r
+/**\name BME280 chip identifier */\r
+#define BME280_CHIP_ID UINT8_C(0x60)\r
+\r
+/**\name Register Address */\r
+#define BME280_CHIP_ID_ADDR UINT8_C(0xD0)\r
+#define BME280_RESET_ADDR UINT8_C(0xE0)\r
+#define BME280_TEMP_PRESS_CALIB_DATA_ADDR UINT8_C(0x88)\r
+#define BME280_HUMIDITY_CALIB_DATA_ADDR UINT8_C(0xE1)\r
+#define BME280_PWR_CTRL_ADDR UINT8_C(0xF4)\r
+#define BME280_CTRL_HUM_ADDR UINT8_C(0xF2)\r
+#define BME280_CTRL_MEAS_ADDR UINT8_C(0xF4)\r
+#define BME280_CONFIG_ADDR UINT8_C(0xF5)\r
+#define BME280_DATA_ADDR UINT8_C(0xF7)\r
+\r
+/**\name API success code */\r
+#define BME280_OK INT8_C(0)\r
+\r
+/**\name API error codes */\r
+#define BME280_E_NULL_PTR INT8_C(-1)\r
+#define BME280_E_DEV_NOT_FOUND INT8_C(-2)\r
+#define BME280_E_INVALID_LEN INT8_C(-3)\r
+#define BME280_E_COMM_FAIL INT8_C(-4)\r
+#define BME280_E_SLEEP_MODE_FAIL INT8_C(-5)\r
+#define BME280_E_NVM_COPY_FAILED INT8_C(-6)\r
+\r
+/**\name API warning codes */\r
+#define BME280_W_INVALID_OSR_MACRO INT8_C(1)\r
+\r
+/**\name Macros related to size */\r
+#define BME280_TEMP_PRESS_CALIB_DATA_LEN UINT8_C(26)\r
+#define BME280_HUMIDITY_CALIB_DATA_LEN UINT8_C(7)\r
+#define BME280_P_T_H_DATA_LEN UINT8_C(8)\r
+\r
+/**\name Sensor power modes */\r
+#define BME280_SLEEP_MODE UINT8_C(0x00)\r
+#define BME280_FORCED_MODE UINT8_C(0x01)\r
+#define BME280_NORMAL_MODE UINT8_C(0x03)\r
+\r
+/**\name Macro to combine two 8 bit data's to form a 16 bit data */\r
+#define BME280_CONCAT_BYTES(msb, lsb) (((uint16_t)msb << 8) | (uint16_t)lsb)\r
+\r
+#define BME280_SET_BITS(reg_data, bitname, data) \\r
+ ((reg_data & ~(bitname##_MSK)) | \\r
+ ((data << bitname##_POS) & bitname##_MSK))\r
+#define BME280_SET_BITS_POS_0(reg_data, bitname, data) \\r
+ ((reg_data & ~(bitname##_MSK)) | \\r
+ (data & bitname##_MSK))\r
+\r
+#define BME280_GET_BITS(reg_data, bitname) ((reg_data & (bitname##_MSK)) >> \\r
+ (bitname##_POS))\r
+#define BME280_GET_BITS_POS_0(reg_data, bitname) (reg_data & (bitname##_MSK))\r
+\r
+/**\name Macros for bit masking */\r
+#define BME280_SENSOR_MODE_MSK UINT8_C(0x03)\r
+#define BME280_SENSOR_MODE_POS UINT8_C(0x00)\r
+\r
+#define BME280_CTRL_HUM_MSK UINT8_C(0x07)\r
+#define BME280_CTRL_HUM_POS UINT8_C(0x00)\r
+\r
+#define BME280_CTRL_PRESS_MSK UINT8_C(0x1C)\r
+#define BME280_CTRL_PRESS_POS UINT8_C(0x02)\r
+\r
+#define BME280_CTRL_TEMP_MSK UINT8_C(0xE0)\r
+#define BME280_CTRL_TEMP_POS UINT8_C(0x05)\r
+\r
+#define BME280_FILTER_MSK UINT8_C(0x1C)\r
+#define BME280_FILTER_POS UINT8_C(0x02)\r
+\r
+#define BME280_STANDBY_MSK UINT8_C(0xE0)\r
+#define BME280_STANDBY_POS UINT8_C(0x05)\r
+\r
+/**\name Sensor component selection macros\r
+ * These values are internal for API implementation. Don't relate this to\r
+ * data sheet.\r
+ */\r
+#define BME280_PRESS UINT8_C(1)\r
+#define BME280_TEMP UINT8_C(1 << 1)\r
+#define BME280_HUM UINT8_C(1 << 2)\r
+#define BME280_ALL UINT8_C(0x07)\r
+\r
+/**\name Settings selection macros */\r
+#define BME280_OSR_PRESS_SEL UINT8_C(1)\r
+#define BME280_OSR_TEMP_SEL UINT8_C(1 << 1)\r
+#define BME280_OSR_HUM_SEL UINT8_C(1 << 2)\r
+#define BME280_FILTER_SEL UINT8_C(1 << 3)\r
+#define BME280_STANDBY_SEL UINT8_C(1 << 4)\r
+#define BME280_ALL_SETTINGS_SEL UINT8_C(0x1F)\r
+\r
+/**\name Oversampling macros */\r
+#define BME280_NO_OVERSAMPLING UINT8_C(0x00)\r
+#define BME280_OVERSAMPLING_1X UINT8_C(0x01)\r
+#define BME280_OVERSAMPLING_2X UINT8_C(0x02)\r
+#define BME280_OVERSAMPLING_4X UINT8_C(0x03)\r
+#define BME280_OVERSAMPLING_8X UINT8_C(0x04)\r
+#define BME280_OVERSAMPLING_16X UINT8_C(0x05)\r
+\r
+/**\name Standby duration selection macros */\r
+#define BME280_STANDBY_TIME_0_5_MS (0x00)\r
+#define BME280_STANDBY_TIME_62_5_MS (0x01)\r
+#define BME280_STANDBY_TIME_125_MS (0x02)\r
+#define BME280_STANDBY_TIME_250_MS (0x03)\r
+#define BME280_STANDBY_TIME_500_MS (0x04)\r
+#define BME280_STANDBY_TIME_1000_MS (0x05)\r
+#define BME280_STANDBY_TIME_10_MS (0x06)\r
+#define BME280_STANDBY_TIME_20_MS (0x07)\r
+\r
+/**\name Filter coefficient selection macros */\r
+#define BME280_FILTER_COEFF_OFF (0x00)\r
+#define BME280_FILTER_COEFF_2 (0x01)\r
+#define BME280_FILTER_COEFF_4 (0x02)\r
+#define BME280_FILTER_COEFF_8 (0x03)\r
+#define BME280_FILTER_COEFF_16 (0x04)\r
+\r
+#define BME280_STATUS_REG_ADDR (0xF3)\r
+#define BME280_SOFT_RESET_COMMAND (0xB6)\r
+#define BME280_STATUS_IM_UPDATE (0x01)\r
+\r
+/*!\r
+ * @brief Interface selection Enums\r
+ */\r
+enum bme280_intf {\r
+ /*! SPI interface */\r
+ BME280_SPI_INTF,\r
+\r
+ /*! I2C interface */\r
+ BME280_I2C_INTF\r
+};\r
+\r
+/*!\r
+ * @brief Type definitions\r
+ */\r
+typedef int8_t (*bme280_com_fptr_t)(uint8_t dev_id, uint8_t reg_addr, uint8_t *data, uint16_t len);\r
+typedef void (*bme280_delay_fptr_t)(uint32_t period);\r
+\r
+/*!\r
+ * @brief Calibration data\r
+ */\r
+struct bme280_calib_data\r
+{\r
+ /**\r
+ * @ Trim Variables\r
+ */\r
+\r
+ /**@{*/\r
+ uint16_t dig_T1;\r
+ int16_t dig_T2;\r
+ int16_t dig_T3;\r
+ uint16_t dig_P1;\r
+ int16_t dig_P2;\r
+ int16_t dig_P3;\r
+ int16_t dig_P4;\r
+ int16_t dig_P5;\r
+ int16_t dig_P6;\r
+ int16_t dig_P7;\r
+ int16_t dig_P8;\r
+ int16_t dig_P9;\r
+ uint8_t dig_H1;\r
+ int16_t dig_H2;\r
+ uint8_t dig_H3;\r
+ int16_t dig_H4;\r
+ int16_t dig_H5;\r
+ int8_t dig_H6;\r
+ int32_t t_fine;\r
+\r
+ /**@}*/\r
+};\r
+\r
+/*!\r
+ * @brief bme280 sensor structure which comprises of temperature, pressure and\r
+ * humidity data\r
+ */\r
+#ifdef BME280_FLOAT_ENABLE\r
+struct bme280_data\r
+{\r
+ /*! Compensated pressure */\r
+ double pressure;\r
+\r
+ /*! Compensated temperature */\r
+ double temperature;\r
+\r
+ /*! Compensated humidity */\r
+ double humidity;\r
+};\r
+#else\r
+struct bme280_data\r
+{\r
+ /*! Compensated pressure */\r
+ uint32_t pressure;\r
+\r
+ /*! Compensated temperature */\r
+ int32_t temperature;\r
+\r
+ /*! Compensated humidity */\r
+ uint32_t humidity;\r
+};\r
+#endif /* BME280_USE_FLOATING_POINT */\r
+\r
+/*!\r
+ * @brief bme280 sensor structure which comprises of uncompensated temperature,\r
+ * pressure and humidity data\r
+ */\r
+struct bme280_uncomp_data\r
+{\r
+ /*! un-compensated pressure */\r
+ uint32_t pressure;\r
+\r
+ /*! un-compensated temperature */\r
+ uint32_t temperature;\r
+\r
+ /*! un-compensated humidity */\r
+ uint32_t humidity;\r
+};\r
+\r
+/*!\r
+ * @brief bme280 sensor settings structure which comprises of mode,\r
+ * oversampling and filter settings.\r
+ */\r
+struct bme280_settings\r
+{\r
+ /*! pressure oversampling */\r
+ uint8_t osr_p;\r
+\r
+ /*! temperature oversampling */\r
+ uint8_t osr_t;\r
+\r
+ /*! humidity oversampling */\r
+ uint8_t osr_h;\r
+\r
+ /*! filter coefficient */\r
+ uint8_t filter;\r
+\r
+ /*! standby time */\r
+ uint8_t standby_time;\r
+};\r
+\r
+/*!\r
+ * @brief bme280 device structure\r
+ */\r
+struct bme280_dev\r
+{\r
+ /*! Chip Id */\r
+ uint8_t chip_id;\r
+\r
+ /*! Device Id */\r
+ uint8_t dev_id;\r
+\r
+ /*! SPI/I2C interface */\r
+ enum bme280_intf intf;\r
+\r
+ /*! Read function pointer */\r
+ bme280_com_fptr_t read;\r
+\r
+ /*! Write function pointer */\r
+ bme280_com_fptr_t write;\r
+\r
+ /*! Delay function pointer */\r
+ bme280_delay_fptr_t delay_ms;\r
+\r
+ /*! Trim data */\r
+ struct bme280_calib_data calib_data;\r
+\r
+ /*! Sensor settings */\r
+ struct bme280_settings settings;\r
+};\r
+\r
+#endif /* BME280_DEFS_H_ */\r
+/** @}*/\r
+/** @}*/\r
projects / BME280_driver / commitdiff