-/*
-****************************************************************************
-* Copyright (C) 2015 - 2016 Bosch Sensortec GmbH
-*
-* bme280.c
-* Date: 2016/07/04
-* Revision: 2.0.5(Pressure and Temperature compensation code revision is 1.1
-* and Humidity compensation code revision is 1.0)
-*
-* Usage: Sensor Driver file for BME280 sensor
-*
-****************************************************************************
-* License:
-*
-* 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.
-**************************************************************************/
+/**\mainpage
+ * Copyright (C) 2016 - 2017 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 21 Mar 2017
+ * Version 3.2.0
+ *
+ */
+/*! @file bme280.c
+ @brief Sensor driver for BME280 sensor */
#include "bme280.h"
-static struct bme280_t *p_bme280; /**< pointer to BME280 */
+
+/**\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 function is used for initialize
- * the bus read and bus write functions
- * and assign the chip id and I2C address of the BME280 sensor
- * chip id is read in the register 0xD0 bit from 0 to 7
- *
- * @param bme280 structure pointer.
- *
- * @note While changing the parameter of the bme280_t
- * @note consider the following point:
- * Changing the reference value of the parameter
- * will changes the local copy or local reference
- * make sure your changes will not
- * affect the reference value of the parameter
- * (Better case don't change the reference value of the parameter)
- *
- *
- *
+ * @brief This internal API puts the device to sleep mode.
*
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
+ * @param[in] dev : Structure instance of bme280_dev.
*
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_init(struct bme280_t *bme280)
-{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 v_chip_id_read_count = BME280_CHIP_ID_READ_COUNT;
-
- /* assign BME280 ptr */
- p_bme280 = bme280;
-
- while (v_chip_id_read_count > 0) {
-
- /* read Chip Id */
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(p_bme280->dev_addr,
- BME280_CHIP_ID_REG, &v_data_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* Check for the correct chip id */
- if (v_data_u8 == BME280_CHIP_ID)
- break;
- v_chip_id_read_count--;
- /* Delay added concerning the low speed of power up system to
- facilitate the proper reading of the chip ID */
- p_bme280->delay_msec(BME280_REGISTER_READ_DELAY);
- }
- /*assign chip ID to the global structure*/
- p_bme280->chip_id = v_data_u8;
- /*com_rslt status of chip ID read*/
- com_rslt = (v_chip_id_read_count == BME280_INIT_VALUE) ?
- BME280_CHIP_ID_READ_FAIL : BME280_CHIP_ID_READ_SUCCESS;
-
- if (com_rslt == BME280_CHIP_ID_READ_SUCCESS) {
- /* readout bme280 calibparam structure */
- com_rslt += bme280_get_calib_param();
- }
- return com_rslt;
-}
+ * @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 API is used to read uncompensated temperature
- * in the registers 0xFA, 0xFB and 0xFC
- * @note 0xFA -> MSB -> bit from 0 to 7
- * @note 0xFB -> LSB -> bit from 0 to 7
- * @note 0xFC -> LSB -> bit from 4 to 7
- *
- * @param v_uncomp_temperature_s32 : The value of uncompensated temperature
+ * @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.
*
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
+ * @param[in] dev : Structure instance of bme280_dev.
*
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_temperature(
-s32 *v_uncomp_temperature_s32)
-{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- /* Array holding the MSB and LSb value
- a_data_u8r[0] - Temperature MSB
- a_data_u8r[1] - Temperature LSB
- a_data_u8r[2] - Temperature XLSB
- */
- u8 a_data_u8r[BME280_TEMPERATURE_DATA_SIZE] = {
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE};
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_TEMPERATURE_MSB_REG,
- a_data_u8r,
- BME280_TEMPERATURE_DATA_LENGTH);
- *v_uncomp_temperature_s32 = (s32)(((
- (u32) (a_data_u8r[BME280_TEMPERATURE_MSB_DATA]))
- << BME280_SHIFT_BIT_POSITION_BY_12_BITS) |
- (((u32)(a_data_u8r[BME280_TEMPERATURE_LSB_DATA]))
- << BME280_SHIFT_BIT_POSITION_BY_04_BITS)
- | ((u32)a_data_u8r[BME280_TEMPERATURE_XLSB_DATA] >>
- BME280_SHIFT_BIT_POSITION_BY_04_BITS));
- }
- return com_rslt;
-}
+ * @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 Reads actual temperature from uncompensated temperature
- * @note Returns the value in 0.01 degree Centigrade
- * Output value of "5123" equals 51.23 DegC.
- *
+ * @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.
*
- * @param v_uncomp_temperature_s32 : value of uncompensated temperature
+ * @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.
*
- * @return Returns the actual temperature
+ * @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);
+
+/*!
+ * @brief This internal API is used to parse the pressure, temperature and
+ * humidity data and store it in the bme280_uncomp_data structure instance.
*
-*/
-s32 bme280_compensate_temperature_int32(s32 v_uncomp_temperature_s32)
-{
- s32 v_x1_u32r = BME280_INIT_VALUE;
- s32 v_x2_u32r = BME280_INIT_VALUE;
- s32 temperature = BME280_INIT_VALUE;
-
- /* calculate x1*/
- v_x1_u32r =
- ((((v_uncomp_temperature_s32
- >> BME280_SHIFT_BIT_POSITION_BY_03_BITS) -
- ((s32)p_bme280->cal_param.dig_T1
- << BME280_SHIFT_BIT_POSITION_BY_01_BIT))) *
- ((s32)p_bme280->cal_param.dig_T2)) >>
- BME280_SHIFT_BIT_POSITION_BY_11_BITS;
- /* calculate x2*/
- v_x2_u32r = (((((v_uncomp_temperature_s32
- >> BME280_SHIFT_BIT_POSITION_BY_04_BITS) -
- ((s32)p_bme280->cal_param.dig_T1))
- * ((v_uncomp_temperature_s32 >> BME280_SHIFT_BIT_POSITION_BY_04_BITS) -
- ((s32)p_bme280->cal_param.dig_T1)))
- >> BME280_SHIFT_BIT_POSITION_BY_12_BITS) *
- ((s32)p_bme280->cal_param.dig_T3))
- >> BME280_SHIFT_BIT_POSITION_BY_14_BITS;
- /* calculate t_fine*/
- p_bme280->cal_param.t_fine = v_x1_u32r + v_x2_u32r;
- /* calculate temperature*/
- temperature = (p_bme280->cal_param.t_fine * 5 + 128)
- >> BME280_SHIFT_BIT_POSITION_BY_08_BITS;
- return temperature;
-}
+ * @param[in] reg_data : Contains the register data which needs to be parsed.
+ * @param[out] uncomp_data : Contains the uncompensated pressure, temperature
+ * and humidity data.
+ */
+static void parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data);
+
/*!
- * @brief Reads actual temperature from uncompensated temperature
- * @note Returns the value with 500LSB/DegC centred around 24 DegC
- * output value of "5123" equals(5123/500)+24 = 34.246DegC
+ * @brief This internal API is used to compensate the pressure and/or
+ * temperature and/or humidity data according to the component selected by the
+ * user.
+ *
+ * @param[in] sensor_comp : Used to select pressure and/or temperature and/or
+ * humidity.
+ * @param[in] uncomp_data : Contains the uncompensated pressure, temperature and
+ * humidity data.
+ * @param[out] comp_data : Contains the compensated pressure and/or temperature
+ * and/or humidity data.
+ * @param[in] calib_data : Pointer to the calibration data structure.
+ *
+ * @return Result of API execution status.
+ * @retval zero -> Success / -ve value -> Error
+ */
+static int8_t compensate_data(uint8_t sensor_comp, const struct bme280_uncomp_data *uncomp_data,
+ struct bme280_data *comp_data, struct bme280_calib_data *calib_data);
+
+#ifdef FLOATING_POINT_REPRESENTATION
+/*!
+ * @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.
*
- * @param v_uncomp_temperature_s32: value of uncompensated temperature
+ * @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.
*
- * @return Return the actual temperature as s16 output
+ * @param[in] uncomp_data : Contains the uncompensated temperature data.
+ * @param[in] calib_data : Pointer to calibration data structure.
*
-*/
-s16 bme280_compensate_temperature_int32_sixteen_bit_output(
-s32 v_uncomp_temperature_s32)
-{
- s16 temperature = BME280_INIT_VALUE;
+ * @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);
- bme280_compensate_temperature_int32(
- v_uncomp_temperature_s32);
- temperature = (s16)((((
- p_bme280->cal_param.t_fine - 122880) * 25) + 128)
- >> BME280_SHIFT_BIT_POSITION_BY_08_BITS);
+#else
- return temperature;
-}
/*!
- * @brief This API is used to read uncompensated pressure.
- * in the registers 0xF7, 0xF8 and 0xF9
- * @note 0xF7 -> MSB -> bit from 0 to 7
- * @note 0xF8 -> LSB -> bit from 0 to 7
- * @note 0xF9 -> LSB -> bit from 4 to 7
- *
- *
- *
- * @param v_uncomp_pressure_s32 : The value of uncompensated pressure
+ * @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.
*
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
+ * @param[in] uncomp_data : Contains the uncompensated pressure data.
+ * @param[in] calib_data : Pointer to the calibration data structure.
*
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_pressure(
-s32 *v_uncomp_pressure_s32)
-{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- /* Array holding the MSB and LSb value
- a_data_u8[0] - Pressure MSB
- a_data_u8[1] - Pressure LSB
- a_data_u8[2] - Pressure XLSB
- */
- u8 a_data_u8[BME280_PRESSURE_DATA_SIZE] = {
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE};
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_PRESSURE_MSB_REG,
- a_data_u8, BME280_PRESSURE_DATA_LENGTH);
- *v_uncomp_pressure_s32 = (s32)((
- ((u32)(a_data_u8[BME280_PRESSURE_MSB_DATA]))
- << BME280_SHIFT_BIT_POSITION_BY_12_BITS) |
- (((u32)(a_data_u8[BME280_PRESSURE_LSB_DATA]))
- << BME280_SHIFT_BIT_POSITION_BY_04_BITS) |
- ((u32)a_data_u8[BME280_PRESSURE_XLSB_DATA] >>
- BME280_SHIFT_BIT_POSITION_BY_04_BITS));
- }
- return com_rslt;
-}
+ * @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 Reads actual pressure from uncompensated pressure
- * @note Returns the value in Pascal(Pa)
- * Output value of "96386" equals 96386 Pa =
- * 963.86 hPa = 963.86 millibar
+ * @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 v_uncomp_pressure_s32 : value of uncompensated pressure
- *
+ * @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.
*
- * @return Return the actual pressure output as u32
+ * @param[in] dev : Structure instance of bme280_dev.
*
-*/
-u32 bme280_compensate_pressure_int32(s32 v_uncomp_pressure_s32)
-{
- s32 v_x1_u32 = BME280_INIT_VALUE;
- s32 v_x2_u32 = BME280_INIT_VALUE;
- u32 v_pressure_u32 = BME280_INIT_VALUE;
-
- /* calculate x1*/
- v_x1_u32 = (((s32)p_bme280->cal_param.t_fine)
- >> BME280_SHIFT_BIT_POSITION_BY_01_BIT) - (s32)64000;
- /* calculate x2*/
- v_x2_u32 = (((v_x1_u32 >> BME280_SHIFT_BIT_POSITION_BY_02_BITS)
- * (v_x1_u32 >> BME280_SHIFT_BIT_POSITION_BY_02_BITS)
- ) >> BME280_SHIFT_BIT_POSITION_BY_11_BITS)
- * ((s32)p_bme280->cal_param.dig_P6);
- /* calculate x2*/
- v_x2_u32 = v_x2_u32 + ((v_x1_u32 *
- ((s32)p_bme280->cal_param.dig_P5))
- << BME280_SHIFT_BIT_POSITION_BY_01_BIT);
- /* calculate x2*/
- v_x2_u32 = (v_x2_u32 >> BME280_SHIFT_BIT_POSITION_BY_02_BITS) +
- (((s32)p_bme280->cal_param.dig_P4)
- << BME280_SHIFT_BIT_POSITION_BY_16_BITS);
- /* calculate x1*/
- v_x1_u32 = (((p_bme280->cal_param.dig_P3 *
- (((v_x1_u32 >> BME280_SHIFT_BIT_POSITION_BY_02_BITS) *
- (v_x1_u32 >> BME280_SHIFT_BIT_POSITION_BY_02_BITS))
- >> BME280_SHIFT_BIT_POSITION_BY_13_BITS))
- >> BME280_SHIFT_BIT_POSITION_BY_03_BITS) +
- ((((s32)p_bme280->cal_param.dig_P2) *
- v_x1_u32) >> BME280_SHIFT_BIT_POSITION_BY_01_BIT))
- >> BME280_SHIFT_BIT_POSITION_BY_18_BITS;
- /* calculate x1*/
- v_x1_u32 = ((((32768 + v_x1_u32)) *
- ((s32)p_bme280->cal_param.dig_P1))
- >> BME280_SHIFT_BIT_POSITION_BY_15_BITS);
- /* calculate pressure*/
- v_pressure_u32 =
- (((u32)(((s32)1048576) - v_uncomp_pressure_s32)
- - (v_x2_u32 >> BME280_SHIFT_BIT_POSITION_BY_12_BITS))) * 3125;
- if (v_pressure_u32
- < 0x80000000)
- /* Avoid exception caused by division by zero */
- if (v_x1_u32 != BME280_INIT_VALUE)
- v_pressure_u32 =
- (v_pressure_u32
- << BME280_SHIFT_BIT_POSITION_BY_01_BIT) /
- ((u32)v_x1_u32);
- else
- return BME280_INVALID_DATA;
- else
- /* Avoid exception caused by division by zero */
- if (v_x1_u32 != BME280_INIT_VALUE)
- v_pressure_u32 = (v_pressure_u32
- / (u32)v_x1_u32) * 2;
- else
- return BME280_INVALID_DATA;
-
- v_x1_u32 = (((s32)p_bme280->cal_param.dig_P9) *
- ((s32)(((v_pressure_u32 >> BME280_SHIFT_BIT_POSITION_BY_03_BITS)
- * (v_pressure_u32 >> BME280_SHIFT_BIT_POSITION_BY_03_BITS))
- >> BME280_SHIFT_BIT_POSITION_BY_13_BITS)))
- >> BME280_SHIFT_BIT_POSITION_BY_12_BITS;
- v_x2_u32 = (((s32)(v_pressure_u32
- >> BME280_SHIFT_BIT_POSITION_BY_02_BITS)) *
- ((s32)p_bme280->cal_param.dig_P8))
- >> BME280_SHIFT_BIT_POSITION_BY_13_BITS;
- v_pressure_u32 = (u32)((s32)v_pressure_u32 +
- ((v_x1_u32 + v_x2_u32 + p_bme280->cal_param.dig_P7)
- >> BME280_SHIFT_BIT_POSITION_BY_04_BITS));
-
- return v_pressure_u32;
-}
+ * @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 API is used to read uncompensated humidity.
- * in the registers 0xF7, 0xF8 and 0xF9
- * @note 0xFD -> MSB -> bit from 0 to 7
- * @note 0xFE -> LSB -> bit from 0 to 7
+ * @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 v_uncomp_humidity_s32 : The value of uncompensated humidity
+ * @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.
*
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
+ * @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.
*
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_humidity(
-s32 *v_uncomp_humidity_s32)
-{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- /* Array holding the MSB and LSb value
- a_data_u8[0] - Humidity MSB
- a_data_u8[1] - Humidity LSB
- */
- u8 a_data_u8[BME280_HUMIDITY_DATA_SIZE] = {
- BME280_INIT_VALUE, BME280_INIT_VALUE};
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_HUMIDITY_MSB_REG, a_data_u8,
- BME280_HUMIDITY_DATA_LENGTH);
- *v_uncomp_humidity_s32 = (s32)(
- (((u32)(a_data_u8[BME280_HUMIDITY_MSB_DATA]))
- << BME280_SHIFT_BIT_POSITION_BY_08_BITS)|
- ((u32)(a_data_u8[BME280_HUMIDITY_LSB_DATA])));
- }
- return com_rslt;
-}
+ * @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 Reads actual humidity from uncompensated humidity
- * @note Returns the value in %rH as unsigned 32bit integer
- * in Q22.10 format(22 integer 10 fractional bits).
- * @note An output value of 42313
- * represents 42313 / 1024 = 41.321 %rH
+ * @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 v_uncomp_humidity_s32: value of uncompensated humidity
+ * @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.
*
- * @return Return the actual relative humidity output as u32
+ * @param[in] dev : Structure instance of bme280_dev.
+ * @param[in] settings : Pointer variable which contains the settings to
+ * be set in the sensor.
*
-*/
-u32 bme280_compensate_humidity_int32(s32 v_uncomp_humidity_s32)
+ * @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)
{
- s32 v_x1_u32 = BME280_INIT_VALUE;
-
- /* calculate x1*/
- v_x1_u32 = (p_bme280->cal_param.t_fine - ((s32)76800));
- /* calculate x1*/
- v_x1_u32 = (((((v_uncomp_humidity_s32
- << BME280_SHIFT_BIT_POSITION_BY_14_BITS) -
- (((s32)p_bme280->cal_param.dig_H4)
- << BME280_SHIFT_BIT_POSITION_BY_20_BITS) -
- (((s32)p_bme280->cal_param.dig_H5) * v_x1_u32)) +
- ((s32)16384)) >> BME280_SHIFT_BIT_POSITION_BY_15_BITS)
- * (((((((v_x1_u32 *
- ((s32)p_bme280->cal_param.dig_H6))
- >> BME280_SHIFT_BIT_POSITION_BY_10_BITS) *
- (((v_x1_u32 * ((s32)p_bme280->cal_param.dig_H3))
- >> BME280_SHIFT_BIT_POSITION_BY_11_BITS) + ((s32)32768)))
- >> BME280_SHIFT_BIT_POSITION_BY_10_BITS) + ((s32)2097152)) *
- ((s32)p_bme280->cal_param.dig_H2) + 8192) >> 14));
- v_x1_u32 = (v_x1_u32 - (((((v_x1_u32
- >> BME280_SHIFT_BIT_POSITION_BY_15_BITS) *
- (v_x1_u32 >> BME280_SHIFT_BIT_POSITION_BY_15_BITS))
- >> BME280_SHIFT_BIT_POSITION_BY_07_BITS) *
- ((s32)p_bme280->cal_param.dig_H1))
- >> BME280_SHIFT_BIT_POSITION_BY_04_BITS));
- v_x1_u32 = (v_x1_u32 < 0 ? 0 : v_x1_u32);
- v_x1_u32 = (v_x1_u32 > 419430400 ?
- 419430400 : v_x1_u32);
- return (u32)(v_x1_u32 >> BME280_SHIFT_BIT_POSITION_BY_12_BITS);
+ 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 Reads actual humidity from uncompensated humidity
- * @note Returns the value in %rH as unsigned 16bit integer
- * @note An output value of 42313
- * represents 42313/512 = 82.643 %rH
- *
- *
- *
- * @param v_uncomp_humidity_s32: value of uncompensated humidity
- *
- *
- * @return Return the actual relative humidity output as u16
- *
-*/
-u16 bme280_compensate_humidity_int32_sixteen_bit_output(
-s32 v_uncomp_humidity_s32)
+ * @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)
{
- u32 v_x1_u32 = BME280_INIT_VALUE;
- u16 v_x2_u32 = BME280_INIT_VALUE;
+ int8_t rslt;
- v_x1_u32 = bme280_compensate_humidity_int32(v_uncomp_humidity_s32);
- v_x2_u32 = (u16)(v_x1_u32 >> BME280_SHIFT_BIT_POSITION_BY_01_BIT);
- return v_x2_u32;
+ /* 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->interface != BME280_I2C_INTF)
+ reg_addr = reg_addr | 0x80;
+ /* Read the data */
+ rslt = dev->read(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 used to read uncompensated
- * pressure,temperature and humidity
- *
- *
- *
- *
- * @param v_uncomp_pressure_s32: The value of uncompensated pressure.
- * @param v_uncomp_temperature_s32: The value of uncompensated temperature
- * @param v_uncomp_humidity_s32: The value of uncompensated humidity.
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_pressure_temperature_humidity(
-s32 *v_uncomp_pressure_s32,
-s32 *v_uncomp_temperature_s32, s32 *v_uncomp_humidity_s32)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- /* Array holding the MSB and LSb value of
- a_data_u8[0] - Pressure MSB
- a_data_u8[1] - Pressure LSB
- a_data_u8[1] - Pressure LSB
- a_data_u8[1] - Temperature MSB
- a_data_u8[1] - Temperature LSB
- a_data_u8[1] - Temperature LSB
- a_data_u8[1] - Humidity MSB
- a_data_u8[1] - Humidity LSB
- */
- u8 a_data_u8[BME280_DATA_FRAME_SIZE] = {
- BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE};
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
+ int8_t rslt;
+ uint8_t temp_buff[len * 2];
+ 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->interface != 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;
+ } else {
+ temp_len = len;
+ }
+ rslt = dev->write(dev->id, reg_addr[0], temp_buff, temp_len);
+ /* Check for communication error */
+ if (rslt != BME280_OK)
+ rslt = BME280_E_COMM_FAIL;
} else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_PRESSURE_MSB_REG,
- a_data_u8, BME280_ALL_DATA_FRAME_LENGTH);
- /*Pressure*/
- *v_uncomp_pressure_s32 = (s32)((
- ((u32)(a_data_u8[
- BME280_DATA_FRAME_PRESSURE_MSB_BYTE]))
- << BME280_SHIFT_BIT_POSITION_BY_12_BITS) |
- (((u32)(a_data_u8[
- BME280_DATA_FRAME_PRESSURE_LSB_BYTE]))
- << BME280_SHIFT_BIT_POSITION_BY_04_BITS) |
- ((u32)a_data_u8[
- BME280_DATA_FRAME_PRESSURE_XLSB_BYTE] >>
- BME280_SHIFT_BIT_POSITION_BY_04_BITS));
-
- /* Temperature */
- *v_uncomp_temperature_s32 = (s32)(((
- (u32) (a_data_u8[
- BME280_DATA_FRAME_TEMPERATURE_MSB_BYTE]))
- << BME280_SHIFT_BIT_POSITION_BY_12_BITS) |
- (((u32)(a_data_u8[
- BME280_DATA_FRAME_TEMPERATURE_LSB_BYTE]))
- << BME280_SHIFT_BIT_POSITION_BY_04_BITS)
- | ((u32)a_data_u8[
- BME280_DATA_FRAME_TEMPERATURE_XLSB_BYTE]
- >> BME280_SHIFT_BIT_POSITION_BY_04_BITS));
-
- /*Humidity*/
- *v_uncomp_humidity_s32 = (s32)((
- ((u32)(a_data_u8[
- BME280_DATA_FRAME_HUMIDITY_MSB_BYTE]))
- << BME280_SHIFT_BIT_POSITION_BY_08_BITS)|
- ((u32)(a_data_u8[
- BME280_DATA_FRAME_HUMIDITY_LSB_BYTE])));
+ rslt = BME280_E_INVALID_LEN;
}
- return com_rslt;
+ } else {
+ rslt = BME280_E_NULL_PTR;
+ }
+
+
+ return rslt;
}
+
/*!
- * @brief This API used to read true pressure, temperature and humidity
- *
- *
- *
- *
- * @param v_pressure_u32 : The value of compensated pressure.
- * @param v_temperature_s32 : The value of compensated temperature.
- * @param v_humidity_u32 : The value of compensated humidity.
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_pressure_temperature_humidity(
-u32 *v_pressure_u32, s32 *v_temperature_s32, u32 *v_humidity_u32)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- s32 v_uncomp_pressure_s32 = BME280_INIT_VALUE;
- s32 v_uncom_temperature_s32 = BME280_INIT_VALUE;
- s32 v_uncom_humidity_s32 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- /* read the uncompensated pressure,
- temperature and humidity*/
- com_rslt =
- bme280_read_uncomp_pressure_temperature_humidity(
- &v_uncomp_pressure_s32, &v_uncom_temperature_s32,
- &v_uncom_humidity_s32);
- /* read the true pressure, temperature and humidity*/
- *v_temperature_s32 =
- bme280_compensate_temperature_int32(
- v_uncom_temperature_s32);
- *v_pressure_u32 = bme280_compensate_pressure_int32(
- v_uncomp_pressure_s32);
- *v_humidity_u32 = bme280_compensate_humidity_int32(
- v_uncom_humidity_s32);
+ 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 com_rslt;
+ }
+
+ return rslt;
}
+
/*!
- * @brief This API is used to
- * calibration parameters used for calculation in the registers
- *
- * parameter | Register address | bit
- *------------|------------------|----------------
- * dig_T1 | 0x88 and 0x89 | from 0 : 7 to 8: 15
- * dig_T2 | 0x8A and 0x8B | from 0 : 7 to 8: 15
- * dig_T3 | 0x8C and 0x8D | from 0 : 7 to 8: 15
- * dig_P1 | 0x8E and 0x8F | from 0 : 7 to 8: 15
- * dig_P2 | 0x90 and 0x91 | from 0 : 7 to 8: 15
- * dig_P3 | 0x92 and 0x93 | from 0 : 7 to 8: 15
- * dig_P4 | 0x94 and 0x95 | from 0 : 7 to 8: 15
- * dig_P5 | 0x96 and 0x97 | from 0 : 7 to 8: 15
- * dig_P6 | 0x98 and 0x99 | from 0 : 7 to 8: 15
- * dig_P7 | 0x9A and 0x9B | from 0 : 7 to 8: 15
- * dig_P8 | 0x9C and 0x9D | from 0 : 7 to 8: 15
- * dig_P9 | 0x9E and 0x9F | from 0 : 7 to 8: 15
- * dig_H1 | 0xA1 | from 0 to 7
- * dig_H2 | 0xE1 and 0xE2 | from 0 : 7 to 8: 15
- * dig_H3 | 0xE3 | from 0 to 7
- * dig_H4 | 0xE4 and 0xE5 | from 4 : 11 to 0: 3
- * dig_H5 | 0xE5 and 0xE6 | from 0 : 3 to 4: 11
- * dig_H6 | 0xE7 | from 0 to 7
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_calib_param(void)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 a_data_u8[BME280_CALIB_DATA_SIZE] = {
- BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE,
- BME280_INIT_VALUE, BME280_INIT_VALUE, BME280_INIT_VALUE};
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_TEMPERATURE_CALIB_DIG_T1_LSB_REG,
- a_data_u8,
- BME280_PRESSURE_TEMPERATURE_CALIB_DATA_LENGTH);
-
- p_bme280->cal_param.dig_T1 = (u16)(((
- (u16)((u8)a_data_u8[
- BME280_TEMPERATURE_CALIB_DIG_T1_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_TEMPERATURE_CALIB_DIG_T1_LSB]);
- p_bme280->cal_param.dig_T2 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_TEMPERATURE_CALIB_DIG_T2_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_TEMPERATURE_CALIB_DIG_T2_LSB]);
- p_bme280->cal_param.dig_T3 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_TEMPERATURE_CALIB_DIG_T3_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_TEMPERATURE_CALIB_DIG_T3_LSB]);
- p_bme280->cal_param.dig_P1 = (u16)(((
- (u16)((u8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P1_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P1_LSB]);
- p_bme280->cal_param.dig_P2 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P2_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P2_LSB]);
- p_bme280->cal_param.dig_P3 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P3_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P3_LSB]);
- p_bme280->cal_param.dig_P4 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P4_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P4_LSB]);
- p_bme280->cal_param.dig_P5 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P5_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P5_LSB]);
- p_bme280->cal_param.dig_P6 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P6_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P6_LSB]);
- p_bme280->cal_param.dig_P7 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P7_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P7_LSB]);
- p_bme280->cal_param.dig_P8 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P8_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P8_LSB]);
- p_bme280->cal_param.dig_P9 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_PRESSURE_CALIB_DIG_P9_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_PRESSURE_CALIB_DIG_P9_LSB]);
- p_bme280->cal_param.dig_H1 =
- a_data_u8[BME280_HUMIDITY_CALIB_DIG_H1];
- com_rslt += p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_HUMIDITY_CALIB_DIG_H2_LSB_REG, a_data_u8,
- BME280_HUMIDITY_CALIB_DATA_LENGTH);
- p_bme280->cal_param.dig_H2 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_HUMIDITY_CALIB_DIG_H2_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_08_BITS)
- | a_data_u8[BME280_HUMIDITY_CALIB_DIG_H2_LSB]);
- p_bme280->cal_param.dig_H3 =
- a_data_u8[BME280_HUMIDITY_CALIB_DIG_H3];
- p_bme280->cal_param.dig_H4 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_HUMIDITY_CALIB_DIG_H4_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_04_BITS) |
- (((u8)BME280_MASK_DIG_H4) &
- a_data_u8[BME280_HUMIDITY_CALIB_DIG_H4_LSB]));
- p_bme280->cal_param.dig_H5 = (s16)(((
- (s16)((s8)a_data_u8[
- BME280_HUMIDITY_CALIB_DIG_H5_MSB])) <<
- BME280_SHIFT_BIT_POSITION_BY_04_BITS) |
- (a_data_u8[BME280_HUMIDITY_CALIB_DIG_H4_LSB] >>
- BME280_SHIFT_BIT_POSITION_BY_04_BITS));
- p_bme280->cal_param.dig_H6 =
- (s8)a_data_u8[BME280_HUMIDITY_CALIB_DIG_H6];
- }
- return com_rslt;
+ 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 is used to get
- * the temperature oversampling setting in the register 0xF4
- * bits from 5 to 7
- *
- * value | Temperature oversampling
- * ---------------------|---------------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of temperature over sampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_oversamp_temperature(
-u8 *v_value_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- *v_value_u8 = BME280_GET_BITSLICE(v_data_u8,
- BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE);
-
- p_bme280->oversamp_temperature = *v_value_u8;
- }
- return com_rslt;
+ 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 is used to set
- * the temperature oversampling setting in the register 0xF4
- * bits from 5 to 7
- *
- * value | Temperature oversampling
- * ---------------------|---------------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of temperature over sampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_oversamp_temperature(
-u8 v_value_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- u8 v_pre_ctrl_hum_value_u8 = BME280_INIT_VALUE;
- u8 v_pre_config_value_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- v_data_u8 = p_bme280->ctrl_meas_reg;
- v_data_u8 =
- BME280_SET_BITSLICE(v_data_u8,
- BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE, v_value_u8);
- com_rslt = bme280_get_power_mode(&v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous value
- of configuration register*/
- v_pre_config_value_u8 = p_bme280->config_reg;
- com_rslt += bme280_write_register(
- BME280_CONFIG_REG,
- &v_pre_config_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value
- of humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous and updated value
- of configuration register*/
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- com_rslt = p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- p_bme280->oversamp_temperature = v_value_u8;
- /* read the control measurement register value*/
- com_rslt = bme280_read_register(
- BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the control
- configuration register value*/
- com_rslt += bme280_read_register(
- BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
- }
- return com_rslt;
+ 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 is used to get
- * the pressure oversampling setting in the register 0xF4
- * bits from 2 to 4
- *
- * value | Pressure oversampling
- * --------------------|--------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of pressure oversampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_oversamp_pressure(
-u8 *v_value_u8)
+ * @brief This API performs the soft reset of the sensor.
+ */
+int8_t bme280_soft_reset(const struct bme280_dev *dev)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- *v_value_u8 = BME280_GET_BITSLICE(
- v_data_u8,
- BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE);
-
- p_bme280->oversamp_pressure = *v_value_u8;
- }
- return com_rslt;
+ 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 is used to set
- * the pressure oversampling setting in the register 0xF4
- * bits from 2 to 4
- *
- * value | Pressure oversampling
- * --------------------|--------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of pressure oversampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_oversamp_pressure(
-u8 v_value_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- u8 v_pre_ctrl_hum_value_u8 = BME280_INIT_VALUE;
- u8 v_pre_config_value_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- v_data_u8 = p_bme280->ctrl_meas_reg;
- v_data_u8 =
- BME280_SET_BITSLICE(v_data_u8,
- BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE, v_value_u8);
- com_rslt = bme280_get_power_mode(&v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous value of
- configuration register*/
- v_pre_config_value_u8 = p_bme280->config_reg;
- com_rslt = bme280_write_register(
- BME280_CONFIG_REG,
- &v_pre_config_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous and updated value of
- control measurement register*/
- bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- com_rslt = p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- p_bme280->oversamp_pressure = v_value_u8;
- /* read the control measurement register value*/
- com_rslt = bme280_read_register(
- BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the control
- configuration register value*/
- com_rslt += bme280_read_register(
- BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
+ 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 */
+ parse_sensor_data(reg_data, &uncomp_data);
+ /* Compensate the pressure and/or temperature and/or
+ humidity data from the sensor */
+ rslt = compensate_data(sensor_comp, &uncomp_data, comp_data, &dev->calib_data);
}
- return com_rslt;
+ } else {
+ rslt = BME280_E_NULL_PTR;
+ }
+
+ return rslt;
}
+
/*!
- * @brief This API is used to get
- * the humidity oversampling setting in the register 0xF2
- * bits from 0 to 2
- *
- * value | Humidity oversampling
- * ---------------------|-------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of humidity over sampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_oversamp_humidity(
-u8 *v_value_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- *v_value_u8 = BME280_GET_BITSLICE(
- v_data_u8,
- BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY);
-
- p_bme280->oversamp_humidity = *v_value_u8;
- }
- return com_rslt;
+ 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 is used to set
- * the humidity oversampling setting in the register 0xF2
- * bits from 0 to 2
- *
- * value | Humidity oversampling
- * ---------------------|-------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of humidity over sampling
- *
- *
- *
- * @note The "BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY"
- * register sets the humidity
- * data acquisition options of the device.
- * @note changes to this registers only become
- * effective after a write operation to
- * "BME280_CTRL_MEAS_REG" register.
- * @note In the code automated reading and writing of
- * "BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY"
- * @note register first set the
- * "BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY"
- * and then read and write
- * the "BME280_CTRL_MEAS_REG" register in the function.
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_oversamp_humidity(
-u8 v_value_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 pre_ctrl_meas_value = BME280_INIT_VALUE;
- u8 v_pre_config_value_u8 = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- /* write humidity oversampling*/
- v_data_u8 = p_bme280->ctrl_hum_reg;
- v_data_u8 =
- BME280_SET_BITSLICE(v_data_u8,
- BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY, v_value_u8);
- com_rslt = bme280_get_power_mode(&v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous value of
- configuration register*/
- v_pre_config_value_u8 = p_bme280->config_reg;
- com_rslt += bme280_write_register(
- BME280_CONFIG_REG,
- &v_pre_config_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write the value of control humidity*/
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- control measurement register*/
- pre_ctrl_meas_value =
- p_bme280->ctrl_meas_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &pre_ctrl_meas_value,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- com_rslt +=
- p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* Control humidity write will effective only
- after the control measurement register*/
- pre_ctrl_meas_value =
- p_bme280->ctrl_meas_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &pre_ctrl_meas_value,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- p_bme280->oversamp_humidity = v_value_u8;
- /* read the control measurement register value*/
- com_rslt += bme280_read_register(BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the control configuration register value*/
- com_rslt += bme280_read_register(BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
- }
- return com_rslt;
+ 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 used to get the
- * Operational Mode from the sensor in the register 0xF4 bit 0 and 1
- *
- *
- *
- * @param v_power_mode_u8 : The value of power mode
- * value | mode
- * -----------------|------------------
- * 0x00 | BME280_SLEEP_MODE
- * 0x01 and 0x02 | BME280_FORCED_MODE
- * 0x03 | BME280_NORMAL_MODE
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_power_mode(u8 *v_power_mode_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_mode_u8r = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_MEAS_REG_POWER_MODE__REG,
- &v_mode_u8r, BME280_GEN_READ_WRITE_DATA_LENGTH);
- *v_power_mode_u8 = BME280_GET_BITSLICE(v_mode_u8r,
- BME280_CTRL_MEAS_REG_POWER_MODE);
- }
- return com_rslt;
+ 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 API used to set the
- * Operational Mode from the sensor in the register 0xF4 bit 0 and 1
- *
- *
- *
- * @param v_power_mode_u8 : The value of power mode
- * value | mode
- * -----------------|------------------
- * 0x00 | BME280_SLEEP_MODE
- * 0x01 and 0x02 | BME280_FORCED_MODE
- * 0x03 | BME280_NORMAL_MODE
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_power_mode(u8 v_power_mode_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_mode_u8r = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- u8 v_pre_ctrl_hum_value_u8 = BME280_INIT_VALUE;
- u8 v_pre_config_value_u8 = BME280_INIT_VALUE;
- u8 v_data_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- if (v_power_mode_u8 <= BME280_NORMAL_MODE) {
- v_mode_u8r = p_bme280->ctrl_meas_reg;
- v_mode_u8r =
- BME280_SET_BITSLICE(v_mode_u8r,
- BME280_CTRL_MEAS_REG_POWER_MODE,
- v_power_mode_u8);
- com_rslt = bme280_get_power_mode(
- &v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous value of
- configuration register*/
- v_pre_config_value_u8 =
- p_bme280->config_reg;
- com_rslt = bme280_write_register(
- BME280_CONFIG_REG,
- &v_pre_config_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous and updated value of
- control measurement register*/
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &v_mode_u8r,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- com_rslt =
- p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_CTRL_MEAS_REG_POWER_MODE__REG,
- &v_mode_u8r,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- /* read the control measurement register value*/
- com_rslt = bme280_read_register(
- BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the config register value*/
- com_rslt += bme280_read_register(
- BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
- } else {
- com_rslt = E_BME280_OUT_OF_RANGE;
- }
- }
- return com_rslt;
+ 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 Used to reset the sensor
- * The value 0xB6 is written to the 0xE0
- * register the device is reset using the
- * complete power-on-reset procedure.
- * @note Soft reset can be easily set using bme280_set_softreset().
- * @note Usage Hint : bme280_set_softreset()
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_soft_rst(void)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_SOFT_RESET_CODE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_RST_REG, &v_data_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- return com_rslt;
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_FILTER, settings->filter);
}
+
/*!
- * @brief This API used to get the sensor
- * SPI mode(communication type) in the register 0xF5 bit 0
- *
- *
- *
- * @param v_enable_disable_u8 : The value of SPI enable
- * value | Description
- * --------|--------------
- * 0 | Disable
- * 1 | Enable
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_spi3(u8 *v_enable_disable_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_CONFIG_REG_SPI3_ENABLE__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- *v_enable_disable_u8 = BME280_GET_BITSLICE(
- v_data_u8,
- BME280_CONFIG_REG_SPI3_ENABLE);
- }
- return com_rslt;
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_STANDBY, settings->standby_time);
}
+
/*!
- * @brief This API used to set the sensor
- * SPI mode(communication type) in the register 0xF5 bit 0
- *
- *
- *
- * @param v_enable_disable_u8 : The value of SPI enable
- * value | Description
- * --------|--------------
- * 0 | Disable
- * 1 | Enable
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_spi3(u8 v_enable_disable_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 pre_ctrl_meas_value = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- u8 v_pre_ctrl_hum_value_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- v_data_u8 = p_bme280->config_reg;
- v_data_u8 =
- BME280_SET_BITSLICE(v_data_u8,
- BME280_CONFIG_REG_SPI3_ENABLE, v_enable_disable_u8);
- com_rslt = bme280_get_power_mode(&v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous and updated value of
- configuration register*/
- com_rslt += bme280_write_register(
- BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- control measurement register*/
- pre_ctrl_meas_value =
- p_bme280->ctrl_meas_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &pre_ctrl_meas_value,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- com_rslt =
- p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_CONFIG_REG_SPI3_ENABLE__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- /* read the control measurement register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the control configuration register value*/
- com_rslt += bme280_read_register(
- BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
- }
- return com_rslt;
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_PRESS, settings->osr_p);
}
+
/*!
- * @brief This API is used to reads filter setting
- * in the register 0xF5 bit 3 and 4
- *
- *
- *
- * @param v_value_u8 : The value of IIR filter coefficient
- *
- * value | Filter coefficient
- * -------------|-------------------------
- * 0x00 | BME280_FILTER_COEFF_OFF
- * 0x01 | BME280_FILTER_COEFF_2
- * 0x02 | BME280_FILTER_COEFF_4
- * 0x03 | BME280_FILTER_COEFF_8
- * 0x04 | BME280_FILTER_COEFF_16
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_filter(u8 *v_value_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_CONFIG_REG_FILTER__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- *v_value_u8 = BME280_GET_BITSLICE(v_data_u8,
- BME280_CONFIG_REG_FILTER);
- }
- return com_rslt;
+ *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_TEMP, settings->osr_t);
}
+
/*!
- * @brief This API is used to write filter setting
- * in the register 0xF5 bit 3 and 4
- *
- *
- *
- * @param v_value_u8 : The value of IIR filter coefficient
- *
- * value | Filter coefficient
- * -------------|-------------------------
- * 0x00 | BME280_FILTER_COEFF_OFF
- * 0x01 | BME280_FILTER_COEFF_2
- * 0x02 | BME280_FILTER_COEFF_4
- * 0x03 | BME280_FILTER_COEFF_8
- * 0x04 | BME280_FILTER_COEFF_16
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_filter(u8 v_value_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 pre_ctrl_meas_value = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- u8 v_pre_ctrl_hum_value_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- v_data_u8 = p_bme280->config_reg;
- v_data_u8 =
- BME280_SET_BITSLICE(v_data_u8,
- BME280_CONFIG_REG_FILTER, v_value_u8);
- com_rslt = bme280_get_power_mode(&v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous and updated value of
- configuration register*/
- com_rslt += bme280_write_register(
- BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- control measurement register*/
- pre_ctrl_meas_value =
- p_bme280->ctrl_meas_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &pre_ctrl_meas_value,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- com_rslt =
- p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_CONFIG_REG_FILTER__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- /* read the control measurement register value*/
- com_rslt += bme280_read_register(BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the configuration register value*/
- com_rslt += bme280_read_register(BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
- }
- return com_rslt;
+ 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 API used to Read the
- * standby duration time from the sensor in the register 0xF5 bit 5 to 7
- *
- * @param v_standby_durn_u8 : The value of standby duration time value.
- * value | standby duration
- * -------------|-----------------------
- * 0x00 | BME280_STANDBY_TIME_1_MS
- * 0x01 | BME280_STANDBY_TIME_63_MS
- * 0x02 | BME280_STANDBY_TIME_125_MS
- * 0x03 | BME280_STANDBY_TIME_250_MS
- * 0x04 | BME280_STANDBY_TIME_500_MS
- * 0x05 | BME280_STANDBY_TIME_1000_MS
- * 0x06 | BME280_STANDBY_TIME_2000_MS
- * 0x07 | BME280_STANDBY_TIME_4000_MS
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_standby_durn(u8 *v_standby_durn_u8)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- BME280_CONFIG_REG_TSB__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- *v_standby_durn_u8 = BME280_GET_BITSLICE(
- v_data_u8, BME280_CONFIG_REG_TSB);
- }
- return com_rslt;
+ 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 API used to write the
- * standby duration time from the sensor in the register 0xF5 bit 5 to 7
- *
- * @param v_standby_durn_u8 : The value of standby duration time value.
- * value | standby duration
- * -------------|-----------------------
- * 0x00 | BME280_STANDBY_TIME_1_MS
- * 0x01 | BME280_STANDBY_TIME_63_MS
- * 0x02 | BME280_STANDBY_TIME_125_MS
- * 0x03 | BME280_STANDBY_TIME_250_MS
- * 0x04 | BME280_STANDBY_TIME_500_MS
- * 0x05 | BME280_STANDBY_TIME_1000_MS
- * 0x06 | BME280_STANDBY_TIME_2000_MS
- * 0x07 | BME280_STANDBY_TIME_4000_MS
- *
- * @note Normal mode comprises an automated perpetual
- * cycling between an (active)
- * Measurement period and an (inactive) standby period.
- * @note The standby time is determined by
- * the contents of the register t_sb.
- * Standby time can be set using BME280_STANDBY_TIME_125_MS.
- *
- * @note Usage Hint : bme280_set_standby_durn(BME280_STANDBY_TIME_125_MS)
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_standby_durn(u8 v_standby_durn_u8)
+ * @brief This internal API puts the device to sleep mode.
+ */
+static int8_t put_device_to_sleep(const struct bme280_dev *dev)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 pre_ctrl_meas_value = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- u8 v_pre_ctrl_hum_value_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- v_data_u8 = p_bme280->config_reg;
- v_data_u8 =
- BME280_SET_BITSLICE(v_data_u8,
- BME280_CONFIG_REG_TSB, v_standby_durn_u8);
- com_rslt = bme280_get_power_mode(&v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous and updated value of
- configuration register*/
- com_rslt += bme280_write_register(
- BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of control
- measurement register*/
- pre_ctrl_meas_value =
- p_bme280->ctrl_meas_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &pre_ctrl_meas_value,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- com_rslt =
- p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- BME280_CONFIG_REG_TSB__REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- /* read the control measurement register value*/
- com_rslt += bme280_read_register(BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the configuration register value*/
- com_rslt += bme280_read_register(BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
- }
- return com_rslt;
+ 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 Writes the working mode to the sensor
- *
- *
- *
- *
- * @param v_work_mode_u8 : Mode to be set
- * value | Working mode
- * ----------|--------------------
- * 0 | BME280_ULTRALOWPOWER_MODE
- * 1 | BME280_LOWPOWER_MODE
- * 2 | BME280_STANDARDRESOLUTION_MODE
- * 3 | BME280_HIGHRESOLUTION_MODE
- * 4 | BME280_ULTRAHIGHRESOLUTION_MODE
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-/*BME280_RETURN_FUNCTION_TYPE bme280_set_work_mode(u8 v_work_mode_u8)
+
+/*!
+ * @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)
{
-BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
-u8 v_data_u8 = BME280_INIT_VALUE;
-if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
-} else {
- if (v_work_mode_u8 <= BME280_ULTRAHIGHRESOLUTION_MODE) {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr, BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- if (com_rslt == SUCCESS) {
- switch (v_work_mode_u8) {
- case BME280_ULTRALOWPOWER_MODE:
- p_bme280->oversamp_temperature =
- BME280_ULTRALOWPOWER_OSRS_T;
- p_bme280->osrs_p =
- BME280_ULTRALOWPOWER_OSRS_P;
- break;
- case BME280_LOWPOWER_MODE:
- p_bme280->oversamp_temperature =
- BME280_LOWPOWER_OSRS_T;
- p_bme280->osrs_p = BME280_LOWPOWER_OSRS_P;
- break;
- case BME280_STANDARDRESOLUTION_MODE:
- p_bme280->oversamp_temperature =
- BME280_STANDARDRESOLUTION_OSRS_T;
- p_bme280->osrs_p =
- BME280_STANDARDRESOLUTION_OSRS_P;
- break;
- case BME280_HIGHRESOLUTION_MODE:
- p_bme280->oversamp_temperature =
- BME280_HIGHRESOLUTION_OSRS_T;
- p_bme280->osrs_p = BME280_HIGHRESOLUTION_OSRS_P;
- break;
- case BME280_ULTRAHIGHRESOLUTION_MODE:
- p_bme280->oversamp_temperature =
- BME280_ULTRAHIGHRESOLUTION_OSRS_T;
- p_bme280->osrs_p =
- BME280_ULTRAHIGHRESOLUTION_OSRS_P;
- break;
- }
- v_data_u8 = BME280_SET_BITSLICE(v_data_u8,
- BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE,
- p_bme280->oversamp_temperature);
- v_data_u8 = BME280_SET_BITSLICE(v_data_u8,
- BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE,
- p_bme280->osrs_p);
- com_rslt += p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr, BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
+ 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;
+}
+
+/*!
+ * @brief This internal API is used to parse the pressure, temperature and
+ * humidity data and store it in the bme280_uncomp_data structure instance.
+ */
+static void 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_xlsb = (uint32_t)reg_data[0] << 12;
+ data_lsb = (uint32_t)reg_data[1] << 4;
+ data_msb = (uint32_t)reg_data[2] << 4;
+ uncomp_data->pressure = data_msb | data_lsb | data_xlsb;
+
+ /* Store the parsed register values for temperature data */
+ data_xlsb = (uint32_t)reg_data[3] << 12;
+ data_lsb = (uint32_t)reg_data[4] << 4;
+ data_msb = (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 internal API is used to compensate the pressure and/or
+ * temperature and/or humidity data according to the component selected
+ * by the user.
+ */
+static int8_t 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 {
- com_rslt = E_BME280_OUT_OF_RANGE;
+ rslt = BME280_E_NULL_PTR;
}
+
+ return rslt;
}
-return com_rslt;
-}*/
+
+#ifdef FLOATING_POINT_REPRESENTATION
/*!
- * @brief This API used to read uncompensated
- * temperature,pressure and humidity in forced mode
- *
- *
- * @param v_uncom_pressure_s32: The value of uncompensated pressure
- * @param v_uncom_temperature_s32: The value of uncompensated temperature
- * @param v_uncom_humidity_s32: The value of uncompensated humidity
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE
-bme280_get_forced_uncomp_pressure_temperature_humidity(
-s32 *v_uncom_pressure_s32,
-s32 *v_uncom_temperature_s32, s32 *v_uncom_humidity_s32)
+ * @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)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- u8 v_data_u8 = BME280_INIT_VALUE;
- u8 v_waittime_u8 = BME280_INIT_VALUE;
- u8 v_prev_pow_mode_u8 = BME280_INIT_VALUE;
- u8 v_mode_u8r = BME280_INIT_VALUE;
- u8 pre_ctrl_config_value = BME280_INIT_VALUE;
- u8 v_pre_ctrl_hum_value_u8 = BME280_INIT_VALUE;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- v_mode_u8r = p_bme280->ctrl_meas_reg;
- v_mode_u8r =
- BME280_SET_BITSLICE(v_mode_u8r,
- BME280_CTRL_MEAS_REG_POWER_MODE, BME280_FORCED_MODE);
- com_rslt = bme280_get_power_mode(&v_prev_pow_mode_u8);
- if (v_prev_pow_mode_u8 != BME280_SLEEP_MODE) {
- com_rslt += bme280_set_soft_rst();
- p_bme280->delay_msec(BME280_3MS_DELAY);
- /* write previous and updated value of
- configuration register*/
- pre_ctrl_config_value = p_bme280->config_reg;
- com_rslt += bme280_write_register(
- BME280_CONFIG_REG,
- &pre_ctrl_config_value,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write previous value of
- humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write the force mode */
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &v_mode_u8r, BME280_GEN_READ_WRITE_DATA_LENGTH);
- } else {
- /* write previous value of
- humidity oversampling*/
- v_pre_ctrl_hum_value_u8 =
- p_bme280->ctrl_hum_reg;
- com_rslt += bme280_write_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_pre_ctrl_hum_value_u8,
- BME280_GEN_READ_WRITE_DATA_LENGTH);
- /* write the force mode */
- com_rslt += bme280_write_register(
- BME280_CTRL_MEAS_REG,
- &v_mode_u8r, BME280_GEN_READ_WRITE_DATA_LENGTH);
- }
- bme280_compute_wait_time(&v_waittime_u8);
- p_bme280->delay_msec(v_waittime_u8);
- /* read the force-mode value of pressure
- temperature and humidity*/
- com_rslt +=
- bme280_read_uncomp_pressure_temperature_humidity(
- v_uncom_pressure_s32, v_uncom_temperature_s32,
- v_uncom_humidity_s32);
-
- /* read the control humidity register value*/
- com_rslt += bme280_read_register(
- BME280_CTRL_HUMIDITY_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_hum_reg = v_data_u8;
- /* read the configuration register value*/
- com_rslt += bme280_read_register(BME280_CONFIG_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->config_reg = v_data_u8;
-
- /* read the control measurement register value*/
- com_rslt += bme280_read_register(BME280_CTRL_MEAS_REG,
- &v_data_u8, BME280_GEN_READ_WRITE_DATA_LENGTH);
- p_bme280->ctrl_meas_reg = v_data_u8;
- }
- return com_rslt;
+ 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 API write the data to
- * the given register
- *
- *
- * @param v_addr_u8 -> Address of the register
- * @param v_data_u8 -> The data from the register
- * @param v_len_u8 -> no of bytes to read
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
+ * @brief This internal API is used to compensate the raw pressure data and
+ * return the compensated pressure data in double data type.
*/
-BME280_RETURN_FUNCTION_TYPE bme280_write_register(u8 v_addr_u8,
-u8 *v_data_u8, u8 v_len_u8)
+static double compensate_pressure(const struct bme280_uncomp_data *uncomp_data,
+ const struct bme280_calib_data *calib_data)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_WRITE_FUNC(
- p_bme280->dev_addr,
- v_addr_u8, v_data_u8, v_len_u8);
- }
- return com_rslt;
+ 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 API reads the data from
- * the given register
- *
- *
- * @param v_addr_u8 -> Address of the register
- * @param v_data_u8 -> The data from the register
- * @param v_len_u8 -> no of bytes to read
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
+ * @brief This internal API is used to compensate the raw humidity data and
+ * return the compensated humidity data in double data type.
*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_register(u8 v_addr_u8,
-u8 *v_data_u8, u8 v_len_u8)
+static double compensate_humidity(const struct bme280_uncomp_data *uncomp_data,
+ const struct bme280_calib_data *calib_data)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = ERROR;
- /* check the p_bme280 structure pointer as NULL*/
- if (p_bme280 == BME280_NULL) {
- return E_BME280_NULL_PTR;
- } else {
- com_rslt = p_bme280->BME280_BUS_READ_FUNC(
- p_bme280->dev_addr,
- v_addr_u8, v_data_u8, v_len_u8);
- }
- return com_rslt;
+ 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;
}
-#ifdef BME280_ENABLE_FLOAT
+
+#else
/*!
- * @brief Reads actual temperature from uncompensated temperature
- * @note returns the value in Degree centigrade
- * @note Output value of "51.23" equals 51.23 DegC.
- *
- *
- *
- * @param v_uncom_temperature_s32 : value of uncompensated temperature
- *
- *
- *
- * @return Return the actual temperature in floating point
- *
-*/
-double bme280_compensate_temperature_double(s32 v_uncom_temperature_s32)
+ * @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)
{
- double v_x1_u32 = BME280_INIT_VALUE;
- double v_x2_u32 = BME280_INIT_VALUE;
- double temperature = BME280_INIT_VALUE;
-
- v_x1_u32 = (((double)v_uncom_temperature_s32) / 16384.0 -
- ((double)p_bme280->cal_param.dig_T1) / 1024.0) *
- ((double)p_bme280->cal_param.dig_T2);
- v_x2_u32 = ((((double)v_uncom_temperature_s32) / 131072.0 -
- ((double)p_bme280->cal_param.dig_T1) / 8192.0) *
- (((double)v_uncom_temperature_s32) / 131072.0 -
- ((double)p_bme280->cal_param.dig_T1) / 8192.0)) *
- ((double)p_bme280->cal_param.dig_T3);
- p_bme280->cal_param.t_fine = (s32)(v_x1_u32 + v_x2_u32);
- temperature = (v_x1_u32 + v_x2_u32) / 5120.0;
+ 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 MACHINE_64_BIT
/*!
- * @brief Reads actual pressure from uncompensated pressure
- * @note Returns pressure in Pa as double.
- * @note Output value of "96386.2"
- * equals 96386.2 Pa = 963.862 hPa.
- *
- *
- * @param v_uncom_pressure_s32 : value of uncompensated pressure
- *
- *
- * @return Return the actual pressure in floating point
- *
-*/
-double bme280_compensate_pressure_double(s32 v_uncom_pressure_s32)
+ * @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)
{
- double v_x1_u32 = BME280_INIT_VALUE;
- double v_x2_u32 = BME280_INIT_VALUE;
- double pressure = BME280_INIT_VALUE;
-
- v_x1_u32 = ((double)p_bme280->cal_param.t_fine /
- 2.0) - 64000.0;
- v_x2_u32 = v_x1_u32 * v_x1_u32 *
- ((double)p_bme280->cal_param.dig_P6) / 32768.0;
- v_x2_u32 = v_x2_u32 + v_x1_u32 *
- ((double)p_bme280->cal_param.dig_P5) * 2.0;
- v_x2_u32 = (v_x2_u32 / 4.0) +
- (((double)p_bme280->cal_param.dig_P4) * 65536.0);
- v_x1_u32 = (((double)p_bme280->cal_param.dig_P3) *
- v_x1_u32 * v_x1_u32 / 524288.0 +
- ((double)p_bme280->cal_param.dig_P2) * v_x1_u32) / 524288.0;
- v_x1_u32 = (1.0 + v_x1_u32 / 32768.0) *
- ((double)p_bme280->cal_param.dig_P1);
- pressure = 1048576.0 - (double)v_uncom_pressure_s32;
- /* Avoid exception caused by division by zero */
- if ((v_x1_u32 > 0) || (v_x1_u32 < 0))
- pressure = (pressure - (v_x2_u32 / 4096.0)) * 6250.0 / v_x1_u32;
- else
- return BME280_INVALID_DATA;
- v_x1_u32 = ((double)p_bme280->cal_param.dig_P9) *
- pressure * pressure / 2147483648.0;
- v_x2_u32 = pressure * ((double)p_bme280->cal_param.dig_P8) / 32768.0;
- pressure = pressure + (v_x1_u32 + v_x2_u32 +
- ((double)p_bme280->cal_param.dig_P7)) / 16.0;
+ 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 * (2147483648UL)) - 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 Reads actual humidity from uncompensated humidity
- * @note returns the value in relative humidity (%rH)
- * @note Output value of "42.12" equals 42.12 %rH
- *
- * @param v_uncom_humidity_s32 : value of uncompensated humidity
- *
- *
- *
- * @return Return the actual humidity in floating point
- *
-*/
-double bme280_compensate_humidity_double(s32 v_uncom_humidity_s32)
+ * @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)
{
- double var_h = BME280_INIT_VALUE;
-
- var_h = (((double)p_bme280->cal_param.t_fine) - 76800.0);
- if ((var_h > 0) || (var_h < 0))
- var_h = (v_uncom_humidity_s32 -
- (((double)p_bme280->cal_param.dig_H4) * 64.0 +
- ((double)p_bme280->cal_param.dig_H5) / 16384.0 * var_h))*
- (((double)p_bme280->cal_param.dig_H2) / 65536.0 *
- (1.0 + ((double) p_bme280->cal_param.dig_H6)
- / 67108864.0 * var_h * (1.0 + ((double)
- p_bme280->cal_param.dig_H3) / 67108864.0 * var_h)));
- else
- return BME280_INVALID_DATA;
- var_h = var_h * (1.0 - ((double)
- p_bme280->cal_param.dig_H1)*var_h / 524288.0);
- if (var_h > 100.0)
- var_h = 100.0;
- else if (var_h < 0.0)
- var_h = 0.0;
- return var_h;
+ 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
-#if defined(BME280_ENABLE_INT64) && defined(BME280_64BITSUPPORT_PRESENT)
+
/*!
- * @brief Reads actual pressure from uncompensated pressure
- * @note Returns the value in Pa as unsigned 32 bit
- * integer in Q24.8 format (24 integer bits and
- * 8 fractional bits).
- * @note Output value of "24674867"
- * represents 24674867 / 256 = 96386.2 Pa = 963.862 hPa
- *
- *
- *
- * @param v_uncom_pressure_s32 : value of uncompensated temperature
- *
- *
- * @return Return the actual pressure in u32
- *
-*/
-u32 bme280_compensate_pressure_int64(s32 v_uncom_pressure_s32)
+ * @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)
{
- s64 v_x1_s64r = BME280_INIT_VALUE;
- s64 v_x2_s64r = BME280_INIT_VALUE;
- s64 pressure = BME280_INIT_VALUE;
-
- v_x1_s64r = ((s64)p_bme280->cal_param.t_fine)
- - 128000;
- v_x2_s64r = v_x1_s64r * v_x1_s64r *
- (s64)p_bme280->cal_param.dig_P6;
- v_x2_s64r = v_x2_s64r + ((v_x1_s64r *
- (s64)p_bme280->cal_param.dig_P5)
- << BME280_SHIFT_BIT_POSITION_BY_17_BITS);
- v_x2_s64r = v_x2_s64r +
- (((s64)p_bme280->cal_param.dig_P4)
- << BME280_SHIFT_BIT_POSITION_BY_35_BITS);
- v_x1_s64r = ((v_x1_s64r * v_x1_s64r *
- (s64)p_bme280->cal_param.dig_P3)
- >> BME280_SHIFT_BIT_POSITION_BY_08_BITS) +
- ((v_x1_s64r * (s64)p_bme280->cal_param.dig_P2)
- << BME280_SHIFT_BIT_POSITION_BY_12_BITS);
- v_x1_s64r = (((((s64)1)
- << BME280_SHIFT_BIT_POSITION_BY_47_BITS) + v_x1_s64r)) *
- ((s64)p_bme280->cal_param.dig_P1)
- >> BME280_SHIFT_BIT_POSITION_BY_33_BITS;
- pressure = 1048576 - v_uncom_pressure_s32;
- /* Avoid exception caused by division by zero */
- if (v_x1_s64r != BME280_INIT_VALUE)
- #if defined __KERNEL__
- pressure = div64_s64((((pressure
- << BME280_SHIFT_BIT_POSITION_BY_31_BITS) - v_x2_s64r)
- * 3125), v_x1_s64r);
- #else
- pressure = (((pressure
- << BME280_SHIFT_BIT_POSITION_BY_31_BITS) - v_x2_s64r)
- * 3125) / v_x1_s64r;
- #endif
- else
- return BME280_INVALID_DATA;
- v_x1_s64r = (((s64)p_bme280->cal_param.dig_P9) *
- (pressure >> BME280_SHIFT_BIT_POSITION_BY_13_BITS) *
- (pressure >> BME280_SHIFT_BIT_POSITION_BY_13_BITS))
- >> BME280_SHIFT_BIT_POSITION_BY_25_BITS;
- v_x2_s64r = (((s64)p_bme280->cal_param.dig_P8) *
- pressure) >> BME280_SHIFT_BIT_POSITION_BY_19_BITS;
- pressure = (((pressure + v_x1_s64r +
- v_x2_s64r) >> BME280_SHIFT_BIT_POSITION_BY_08_BITS) +
- (((s64)p_bme280->cal_param.dig_P7)
- << BME280_SHIFT_BIT_POSITION_BY_04_BITS));
-
- return (u32)pressure;
+ int32_t var1;
+ int32_t var2;
+ int32_t var3;
+ int32_t var4;
+ int32_t var5;
+ uint32_t humidity;
+ uint32_t humidity_max = 100000;
+
+ 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 Reads actual pressure from uncompensated pressure
- * @note Returns the value in Pa.
- * @note Output value of "12337434"
- * @note represents 12337434 / 128 = 96386.2 Pa = 963.862 hPa
- *
- *
- *
- * @param v_uncom_pressure_s32 : value of uncompensated pressure
- *
- *
- * @return the actual pressure in u32
- *
-*/
-u32 bme280_compensate_pressure_int64_twentyfour_bit_output(
-s32 v_uncom_pressure_s32)
+ * @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)
{
- u32 pressure = BME280_INIT_VALUE;
+ 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};
- pressure = bme280_compensate_pressure_int64(
- v_uncom_pressure_s32);
- pressure = (u32)(pressure >> BME280_SHIFT_BIT_POSITION_BY_01_BIT);
- return pressure;
+ /* 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;
}
-#endif
+
/*!
- * @brief Computing waiting time for sensor data read
- *
- *
- *
- *
- * @param v_delaytime_u8 : The value of delay time for force mode
- *
- *
- * @retval 0 -> Success
- *
- *
+ * @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.
*/
-BME280_RETURN_FUNCTION_TYPE bme280_compute_wait_time(u8
-*v_delaytime_u8)
+static int8_t null_ptr_check(const struct bme280_dev *dev)
{
- /* used to return the communication result*/
- BME280_RETURN_FUNCTION_TYPE com_rslt = SUCCESS;
-
- *v_delaytime_u8 = (T_INIT_MAX +
- T_MEASURE_PER_OSRS_MAX *
- (((1 <<
- p_bme280->oversamp_temperature)
- >> BME280_SHIFT_BIT_POSITION_BY_01_BIT)
- + ((1 << p_bme280->oversamp_pressure)
- >> BME280_SHIFT_BIT_POSITION_BY_01_BIT) +
- ((1 << p_bme280->oversamp_humidity)
- >> BME280_SHIFT_BIT_POSITION_BY_01_BIT))
- + ((p_bme280->oversamp_pressure > 0) ?
- T_SETUP_PRESSURE_MAX : 0) +
- ((p_bme280->oversamp_humidity > 0) ?
- T_SETUP_HUMIDITY_MAX : 0) + 15) / 16;
- return com_rslt;
+ 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
-*
-****************************************************************************
-* Copyright (C) 2015 - 2016 Bosch Sensortec GmbH
-*
-* File : bme280.h
-*
-* Date : 2016/07/04
-*
-* Revision : 2.0.5(Pressure and Temperature compensation code revision is 1.1
-* and Humidity compensation code revision is 1.0)
-*
-* Usage: Sensor Driver for BME280 sensor
-*
-****************************************************************************
-*
-* \section License
-*
-* 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.h
- \brief BME280 Sensor Driver Support Header File */
-#ifndef __BME280_H__
-#define __BME280_H__
-
-
-/*!
-* @brief The following definition uses for define the data types
-*
-* @note While porting the API please consider the following
-* @note Please check the version of C standard
-* @note Are you using Linux platform
-*/
-
-/*!
-* @brief For the Linux platform support
-* Please use the types.h for your data types definitions
-*/
-#ifdef __KERNEL__
-
-#include <linux/types.h>
-#include <linux/math64.h>
-#define BME280_64BITSUPPORT_PRESENT
-/* singed integer type*/
-typedef int8_t s8;/**< used for signed 8bit */
-typedef int16_t s16;/**< used for signed 16bit */
-typedef int32_t s32;/**< used for signed 32bit */
-typedef int64_t s64;/**< used for signed 64bit */
-
-typedef u_int8_t u8;/**< used for unsigned 8bit */
-typedef u_int16_t u16;/**< used for unsigned 16bit */
-typedef u_int32_t u32;/**< used for unsigned 32bit */
-typedef u_int64_t u64;/**< used for unsigned 64bit */
-
-
-
-#else /* ! __KERNEL__ */
-/**********************************************************
-* These definition uses for define the C
-* standard version data types
-***********************************************************/
-# if defined(__STDC_VERSION__)
-
-/************************************************
- * compiler is C11 C standard
-************************************************/
-#if (__STDC_VERSION__ == 201112L)
-
-/************************************************/
-#include <stdint.h>
-/************************************************/
-
-/*unsigned integer types*/
-typedef uint8_t u8;/**< used for unsigned 8bit */
-typedef uint16_t u16;/**< used for unsigned 16bit */
-typedef uint32_t u32;/**< used for unsigned 32bit */
-typedef uint64_t u64;/**< used for unsigned 64bit */
-
-/*signed integer types*/
-typedef int8_t s8;/**< used for signed 8bit */
-typedef int16_t s16;/**< used for signed 16bit */
-typedef int32_t s32;/**< used for signed 32bit */
-typedef int64_t s64;/**< used for signed 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-/************************************************
- * compiler is C99 C standard
-************************************************/
-
-#elif (__STDC_VERSION__ == 199901L)
-
-/* stdint.h is a C99 supported c library.
-which is used to fixed the integer size*/
-/************************************************/
-#include <stdint.h>
-/************************************************/
-
-/*unsigned integer types*/
-typedef uint8_t u8;/**< used for unsigned 8bit */
-typedef uint16_t u16;/**< used for unsigned 16bit */
-typedef uint32_t u32;/**< used for unsigned 32bit */
-typedef uint64_t u64;/**< used for unsigned 64bit */
-
-/*signed integer types*/
-typedef int8_t s8;/**< used for signed 8bit */
-typedef int16_t s16;/**< used for signed 16bit */
-typedef int32_t s32;/**< used for signed 32bit */
-typedef int64_t s64;/**< used for signed 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-/************************************************
- * compiler is C89 or other C standard
-************************************************/
-
-#else /* !defined(__STDC_VERSION__) */
-/*!
-* @brief By default it is defined as 32 bit machine configuration
-* define your data types based on your
-* machine/compiler/controller configuration
-*/
-#define MACHINE_32_BIT
-
-/*! @brief
- * If your machine support 16 bit
- * define the MACHINE_16_BIT
- */
-#ifdef MACHINE_16_BIT
-#include <limits.h>
-/*signed integer types*/
-typedef signed char s8;/**< used for signed 8bit */
-typedef signed short int s16;/**< used for signed 16bit */
-typedef signed long int s32;/**< used for signed 32bit */
-
-#if defined(LONG_MAX) && LONG_MAX == 0x7fffffffffffffffL
-typedef long int s64;/**< used for signed 64bit */
-typedef unsigned long int u64;/**< used for unsigned 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-#elif defined(LLONG_MAX) && (LLONG_MAX == 0x7fffffffffffffffLL)
-typedef long long int s64;/**< used for signed 64bit */
-typedef unsigned long long int u64;/**< used for unsigned 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-#else
-#warning Either the correct data type for signed 64 bit integer \
-could not be found, or 64 bit integers are not supported in your environment.
-#warning The API will only offer 32 bit pressure calculation.This will \
-slightly impede accuracy(noise of ~1 pascal RMS will be added to output).
-#warning If 64 bit integers are supported on your platform, \
-please set s64 manually and "#define(BME280_64BITSUPPORT_PRESENT)" manually.
-#endif
-
-/*unsigned integer types*/
-typedef unsigned char u8;/**< used for unsigned 8bit */
-typedef unsigned short int u16;/**< used for unsigned 16bit */
-typedef unsigned long int u32;/**< used for unsigned 32bit */
-
-/* If your machine support 32 bit
-define the MACHINE_32_BIT*/
-#elif defined MACHINE_32_BIT
-/*signed integer types*/
-typedef signed char s8;/**< used for signed 8bit */
-typedef signed short int s16;/**< used for signed 16bit */
-typedef signed int s32;/**< used for signed 32bit */
-typedef signed long long int s64;/**< used for signed 64bit */
-
-/*unsigned integer types*/
-typedef unsigned char u8;/**< used for unsigned 8bit */
-typedef unsigned short int u16;/**< used for unsigned 16bit */
-typedef unsigned int u32;/**< used for unsigned 32bit */
-typedef unsigned long long int u64;/**< used for unsigned 64bit */
-/*! @brief
- * If your machine support 64 bit
- * define the MACHINE_64_BIT
+/**
+ * Copyright (C) 2016 - 2017 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.h
+ * @date 21 Mar 2017
+ * @version 3.2.0
+ * @brief
+ *
*/
-#define BME280_64BITSUPPORT_PRESENT
-
-/* If your machine support 64 bit
-define the MACHINE_64_BIT*/
-#elif defined MACHINE_64_BIT
-/*signed integer types*/
-typedef signed char s8;/**< used for signed 8bit */
-typedef signed short int s16;/**< used for signed 16bit */
-typedef signed int s32;/**< used for signed 32bit */
-typedef signed long int s64;/**< used for signed 64bit */
-
-/*unsigned integer types*/
-typedef unsigned char u8;/**< used for unsigned 8bit */
-typedef unsigned short int u16;/**< used for unsigned 16bit */
-typedef unsigned int u32;/**< used for unsigned 32bit */
-typedef unsigned long int u64;/**< used for unsigned 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-
-#else
-#warning The data types defined above which not supported \
-define the data types manually
-#endif
-#endif
-
-/*** This else will execute for the compilers
- * which are not supported the C standards
- * Like C89/C99/C11***/
-#else
+/*! @file bme280.h
+ @brief Sensor driver for BME280 sensor */
/*!
-* @brief By default it is defined as 32 bit machine configuration
-* define your data types based on your
-* machine/compiler/controller configuration
-*/
-#define MACHINE_32_BIT
-
-/* If your machine support 16 bit
-define the MACHINE_16_BIT*/
-#ifdef MACHINE_16_BIT
-#include <limits.h>
-/*signed integer types*/
-typedef signed char s8;/**< used for signed 8bit */
-typedef signed short int s16;/**< used for signed 16bit */
-typedef signed long int s32;/**< used for signed 32bit */
+ * @defgroup BME280 SENSOR API
+ * @{*/
+#ifndef BME280_H_
+#define BME280_H_
-#if defined(LONG_MAX) && LONG_MAX == 0x7fffffffffffffffL
-typedef long int s64;/**< used for signed 64bit */
-typedef unsigned long int u64;/**< used for unsigned 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-#elif defined(LLONG_MAX) && (LLONG_MAX == 0x7fffffffffffffffLL)
-typedef long long int s64;/**< used for signed 64bit */
-typedef unsigned long long int u64;/**< used for unsigned 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-#else
-#warning Either the correct data type for signed 64 bit integer \
-could not be found, or 64 bit integers are not supported in your environment.
-#warning The API will only offer 32 bit pressure calculation.This will \
-slightly impede accuracy(noise of ~1 pascal RMS will be added to output).
-#warning If 64 bit integers are supported on your platform, \
-please set s64 manually and "#define(BME280_64BITSUPPORT_PRESENT)" manually.
+/*! CPP guard */
+#ifdef __cplusplus
+extern "C" {
#endif
-/*unsigned integer types*/
-typedef unsigned char u8;/**< used for unsigned 8bit */
-typedef unsigned short int u16;/**< used for unsigned 16bit */
-typedef unsigned long int u32;/**< used for unsigned 32bit */
-
-/*! @brief If your machine support 32 bit
-define the MACHINE_32_BIT*/
-#elif defined MACHINE_32_BIT
-/*signed integer types*/
-typedef signed char s8;/**< used for signed 8bit */
-typedef signed short int s16;/**< used for signed 16bit */
-typedef signed int s32;/**< used for signed 32bit */
-typedef signed long long int s64;/**< used for signed 64bit */
-
-/*unsigned integer types*/
-typedef unsigned char u8;/**< used for unsigned 8bit */
-typedef unsigned short int u16;/**< used for unsigned 16bit */
-typedef unsigned int u32;/**< used for unsigned 32bit */
-typedef unsigned long long int u64;/**< used for unsigned 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-
-/* If your machine support 64 bit
-define the MACHINE_64_BIT*/
-#elif defined MACHINE_64_BIT
-/*signed integer types*/
-typedef signed char s8;/**< used for signed 8bit */
-typedef signed short int s16;/**< used for signed 16bit */
-typedef signed int s32;/**< used for signed 32bit */
-typedef signed long int s64;/**< used for signed 64bit */
-
-/*unsigned integer types*/
-typedef unsigned char u8;/**< used for unsigned 8bit */
-typedef unsigned short int u16;/**< used for unsigned 16bit */
-typedef unsigned int u32;/**< used for unsigned 32bit */
-typedef unsigned long int u64;/**< used for unsigned 64bit */
-#define BME280_64BITSUPPORT_PRESENT
-
-#else
-#warning The data types defined above which not supported \
-define the data types manually
-#endif
-#endif
-#endif
-/********************************************/
-/**\name ENABLE FLOATING OUTPUT */
-/**************************************/
-/*!
-* @brief If the user wants to support floating point calculations, please set
- the following define. If floating point
- calculation is not wanted or allowed
- (e.g. in Linux kernel), please do not set the define. */
-#define BME280_ENABLE_FLOAT
-/*!
-* @brief If the user wants to support 64 bit integer calculation
- (needed for optimal pressure accuracy) please set
- the following define. If int64 calculation is not wanted
- (e.g. because it would include
- large libraries), please do not set the define. */
-#define BME280_ENABLE_INT64
-/***************************************************************/
-/**\name BUS READ AND WRITE FUNCTION POINTERS */
-/***************************************************************/
-/*!
- @brief Define the calling convention of YOUR bus communication routine.
- @note This includes types of parameters. This example shows the
- configuration for an SPI bus link.
-
- If your communication function looks like this:
-
- write_my_bus_xy(u8 device_addr, u8 register_addr,
- u8 * data, u8 length);
-
- The BME280_WR_FUNC_PTR would equal:
-
- BME280_WR_FUNC_PTR s8 (* bus_write)(u8,
- u8, u8 *, u8)
-
- Parameters can be mixed as needed refer to the
- refer BME280_BUS_WRITE_FUNC macro.
-
-
-*/
-/** defines the return parameter type of the BME280_WR_FUNCTION */
-#define BME280_BUS_WR_RETURN_TYPE s8
-
-/* links the order of parameters defined in
-BME280_BUS_WR_PARAM_TYPE to function calls used inside the API*/
-#define BME280_BUS_WR_PARAM_TYPES u8, u8,\
- u8 *, u8
-
-/* links the order of parameters defined in
-BME280_BUS_WR_PARAM_TYPE to function calls used inside the API*/
-#define BME280_BUS_WR_PARAM_ORDER(device_addr, register_addr,\
- register_data, wr_len)
-
-/* never change this line */
-#define BME280_BUS_WRITE_FUNC(device_addr, register_addr,\
-register_data, wr_len) bus_write(device_addr, register_addr,\
- register_data, wr_len)
-/*!
- @brief link macro between API function calls and bus read function
- @note The bus write function can change since this is a
- system dependant issue.
-
- If the bus_read parameter calling order is like: reg_addr,
- reg_data, wr_len it would be as it is here.
-
- If the parameters are differently ordered or your communication
- function like I2C need to know the device address,
- you can change this macro accordingly.
-
-
- BME280_BUS_READ_FUNC(dev_addr, reg_addr, reg_data, wr_len)\
- bus_read(dev_addr, reg_addr, reg_data, wr_len)
-
- This macro lets all API functions call YOUR communication routine in a
- way that equals your definition in the
- refer BME280_WR_FUNC_PTR definition.
-
- @note: this macro also includes the "MSB='1'
- for reading BME280 addresses.
-
-*/
-/*defines the return parameter type of the BME280_RD_FUNCTION
-*/
-#define BME280_BUS_RD_RETURN_TYPE s8
-
-/**\brief defines the calling parameter types of the BME280_RD_FUNCTION
-*/
-#define BME280_BUS_RD_PARAM_TYPES (u8, u8,\
- u8 *, u8)
-
-/* links the order of parameters defined in \
-BME280_BUS_RD_PARAM_TYPE to function calls used inside the API
-*/
-#define BME280_BUS_RD_PARAM_ORDER (device_addr, register_addr,\
- register_data)
-
-/* never change this line */
-#define BME280_BUS_READ_FUNC(device_addr, register_addr,\
- register_data, rd_len)bus_read(device_addr, register_addr,\
- register_data, rd_len)
-/****************************************/
-/**\name DELAY */
-/****************************************/
-/* defines the return parameter type of the BME280_DELAY_FUNCTION
-*/
-#define BME280_DELAY_RETURN_TYPE void
-
-/* defines the calling parameter types of the BME280_DELAY_FUNCTION
-*/
-#define BME280_DELAY_PARAM_TYPES u16
-/***************************************************************/
-/**\name GET AND SET BITSLICE FUNCTIONS */
-/***************************************************************/
-/* never change this line */
-#define BME280_DELAY_FUNC(delay_in_msec)\
- delay_func(delay_in_msec)
-
-#define BME280_GET_BITSLICE(regvar, bitname)\
- ((regvar & bitname##__MSK) >> bitname##__POS)
-
-#define BME280_SET_BITSLICE(regvar, bitname, val)\
-((regvar & ~bitname##__MSK) | ((val<<bitname##__POS)&bitname##__MSK))
-
-/***************************************************************/
-/**\name COMMON USED CONSTANTS */
-/***************************************************************/
-/* Constants */
-#define BME280_NULL (0)
-#define BME280_RETURN_FUNCTION_TYPE s8
-/* shift definitions*/
-#define BME280_SHIFT_BIT_POSITION_BY_01_BIT (1)
-#define BME280_SHIFT_BIT_POSITION_BY_02_BITS (2)
-#define BME280_SHIFT_BIT_POSITION_BY_03_BITS (3)
-#define BME280_SHIFT_BIT_POSITION_BY_04_BITS (4)
-#define BME280_SHIFT_BIT_POSITION_BY_07_BITS (7)
-#define BME280_SHIFT_BIT_POSITION_BY_08_BITS (8)
-#define BME280_SHIFT_BIT_POSITION_BY_10_BITS (10)
-#define BME280_SHIFT_BIT_POSITION_BY_11_BITS (11)
-#define BME280_SHIFT_BIT_POSITION_BY_12_BITS (12)
-#define BME280_SHIFT_BIT_POSITION_BY_13_BITS (13)
-#define BME280_SHIFT_BIT_POSITION_BY_14_BITS (14)
-#define BME280_SHIFT_BIT_POSITION_BY_15_BITS (15)
-#define BME280_SHIFT_BIT_POSITION_BY_16_BITS (16)
-#define BME280_SHIFT_BIT_POSITION_BY_17_BITS (17)
-#define BME280_SHIFT_BIT_POSITION_BY_18_BITS (18)
-#define BME280_SHIFT_BIT_POSITION_BY_19_BITS (19)
-#define BME280_SHIFT_BIT_POSITION_BY_20_BITS (20)
-#define BME280_SHIFT_BIT_POSITION_BY_25_BITS (25)
-#define BME280_SHIFT_BIT_POSITION_BY_31_BITS (31)
-#define BME280_SHIFT_BIT_POSITION_BY_33_BITS (33)
-#define BME280_SHIFT_BIT_POSITION_BY_35_BITS (35)
-#define BME280_SHIFT_BIT_POSITION_BY_47_BITS (47)
-
-/* numeric definitions */
-#define BME280_PRESSURE_TEMPERATURE_CALIB_DATA_LENGTH (26)
-#define BME280_HUMIDITY_CALIB_DATA_LENGTH (7)
-#define BME280_GEN_READ_WRITE_DATA_LENGTH (1)
-#define BME280_HUMIDITY_DATA_LENGTH (2)
-#define BME280_TEMPERATURE_DATA_LENGTH (3)
-#define BME280_PRESSURE_DATA_LENGTH (3)
-#define BME280_ALL_DATA_FRAME_LENGTH (8)
-#define BME280_INIT_VALUE (0)
-#define BME280_CHIP_ID_READ_COUNT (5)
-#define BME280_INVALID_DATA (0)
-
-/****************************************************/
-/**\name ERROR CODE DEFINITIONS */
-/***************************************************/
-#define SUCCESS ((u8)0)
-#define E_BME280_NULL_PTR ((s8)-127)
-#define E_BME280_COMM_RES ((s8)-1)
-#define E_BME280_OUT_OF_RANGE ((s8)-2)
-#define ERROR ((s8)-1)
-#define BME280_CHIP_ID_READ_FAIL ((s8)-1)
-#define BME280_CHIP_ID_READ_SUCCESS ((u8)0)
-
-/****************************************************/
-/**\name CHIP ID DEFINITIONS */
-/***************************************************/
-#define BME280_CHIP_ID (0x60)
-
-/****************************************************/
-/**\name I2C ADDRESS DEFINITIONS */
-/***************************************************/
-#define BME280_I2C_ADDRESS1 (0x76)
-#define BME280_I2C_ADDRESS2 (0x77)
-/****************************************************/
-/**\name POWER MODE DEFINITIONS */
-/***************************************************/
-/* Sensor Specific constants */
-#define BME280_SLEEP_MODE (0x00)
-#define BME280_FORCED_MODE (0x01)
-#define BME280_NORMAL_MODE (0x03)
-#define BME280_SOFT_RESET_CODE (0xB6)
-/****************************************************/
-/**\name STANDBY DEFINITIONS */
-/***************************************************/
-#define BME280_STANDBY_TIME_1_MS (0x00)
-#define BME280_STANDBY_TIME_63_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 OVER SAMPLING DEFINITIONS */
-/***************************************************/
-#define BME280_OVERSAMP_SKIPPED (0x00)
-#define BME280_OVERSAMP_1X (0x01)
-#define BME280_OVERSAMP_2X (0x02)
-#define BME280_OVERSAMP_4X (0x03)
-#define BME280_OVERSAMP_8X (0x04)
-#define BME280_OVERSAMP_16X (0x05)
-/****************************************************/
-/**\name WORK MODE DEFINITIONS */
-/***************************************************/
-/*#define BME280_ULTRALOWPOWER_MODE (0x00)
-#define BME280_LOWPOWER_MODE (0x01)
-#define BME280_STANDARDRESOLUTION_MODE (0x02)
-#define BME280_HIGHRESOLUTION_MODE (0x03)
-#define BME280_ULTRAHIGHRESOLUTION_MODE (0x04)
-
-#define BME280_ULTRALOWPOWER_OSRS_P BME280_OVERSAMP_1X
-#define BME280_ULTRALOWPOWER_OSRS_T BME280_OVERSAMP_1X
-
-#define BME280_LOWPOWER_OSRS_P BME280_OVERSAMP_2X
-#define BME280_LOWPOWER_OSRS_T BME280_OVERSAMP_1X
-
-#define BME280_STANDARDRESOLUTION_OSRS_P BME280_OVERSAMP_4X
-#define BME280_STANDARDRESOLUTION_OSRS_T BME280_OVERSAMP_1X
-
-#define BME280_HIGHRESOLUTION_OSRS_P BME280_OVERSAMP_8X
-#define BME280_HIGHRESOLUTION_OSRS_T BME280_OVERSAMP_1X
-
-#define BME280_ULTRAHIGHRESOLUTION_OSRS_P BME280_OVERSAMP_16X
-#define BME280_ULTRAHIGHRESOLUTION_OSRS_T BME280_OVERSAMP_2X */
-
-#define BME280_STANDARD_OVERSAMP_HUMIDITY BME280_OVERSAMP_1X
-/****************************************************/
-/**\name FILTER DEFINITIONS */
-/***************************************************/
-#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)
-/****************************************************/
-/**\name DELAY DEFINITIONS */
-/***************************************************/
-#define T_INIT_MAX (20)
- /* 20/16 = 1.25 ms */
-#define T_MEASURE_PER_OSRS_MAX (37)
- /* 37/16 = 2.3125 ms*/
-
-#define T_SETUP_PRESSURE_MAX (10)
- /* 10/16 = 0.625 ms */
-
-#define T_SETUP_HUMIDITY_MAX (10)
- /* 10/16 = 0.625 ms */
-/****************************************************/
-/**\name DEFINITIONS FOR ARRAY SIZE OF DATA */
-/***************************************************/
-#define BME280_HUMIDITY_DATA_SIZE (2)
-#define BME280_TEMPERATURE_DATA_SIZE (3)
-#define BME280_PRESSURE_DATA_SIZE (3)
-#define BME280_DATA_FRAME_SIZE (8)
-/**< data frames includes temperature,
-pressure and humidity*/
-#define BME280_CALIB_DATA_SIZE (26)
-
-#define BME280_TEMPERATURE_MSB_DATA (0)
-#define BME280_TEMPERATURE_LSB_DATA (1)
-#define BME280_TEMPERATURE_XLSB_DATA (2)
-#define BME280_PRESSURE_MSB_DATA (0)
-#define BME280_PRESSURE_LSB_DATA (1)
-#define BME280_PRESSURE_XLSB_DATA (2)
-#define BME280_HUMIDITY_MSB_DATA (0)
-#define BME280_HUMIDITY_LSB_DATA (1)
-
-#define BME280_DATA_FRAME_PRESSURE_MSB_BYTE (0)
-#define BME280_DATA_FRAME_PRESSURE_LSB_BYTE (1)
-#define BME280_DATA_FRAME_PRESSURE_XLSB_BYTE (2)
-#define BME280_DATA_FRAME_TEMPERATURE_MSB_BYTE (3)
-#define BME280_DATA_FRAME_TEMPERATURE_LSB_BYTE (4)
-#define BME280_DATA_FRAME_TEMPERATURE_XLSB_BYTE (5)
-#define BME280_DATA_FRAME_HUMIDITY_MSB_BYTE (6)
-#define BME280_DATA_FRAME_HUMIDITY_LSB_BYTE (7)
-/****************************************************/
-/**\name ARRAY PARAMETER FOR CALIBRATION */
-/***************************************************/
-#define BME280_TEMPERATURE_CALIB_DIG_T1_LSB (0)
-#define BME280_TEMPERATURE_CALIB_DIG_T1_MSB (1)
-#define BME280_TEMPERATURE_CALIB_DIG_T2_LSB (2)
-#define BME280_TEMPERATURE_CALIB_DIG_T2_MSB (3)
-#define BME280_TEMPERATURE_CALIB_DIG_T3_LSB (4)
-#define BME280_TEMPERATURE_CALIB_DIG_T3_MSB (5)
-#define BME280_PRESSURE_CALIB_DIG_P1_LSB (6)
-#define BME280_PRESSURE_CALIB_DIG_P1_MSB (7)
-#define BME280_PRESSURE_CALIB_DIG_P2_LSB (8)
-#define BME280_PRESSURE_CALIB_DIG_P2_MSB (9)
-#define BME280_PRESSURE_CALIB_DIG_P3_LSB (10)
-#define BME280_PRESSURE_CALIB_DIG_P3_MSB (11)
-#define BME280_PRESSURE_CALIB_DIG_P4_LSB (12)
-#define BME280_PRESSURE_CALIB_DIG_P4_MSB (13)
-#define BME280_PRESSURE_CALIB_DIG_P5_LSB (14)
-#define BME280_PRESSURE_CALIB_DIG_P5_MSB (15)
-#define BME280_PRESSURE_CALIB_DIG_P6_LSB (16)
-#define BME280_PRESSURE_CALIB_DIG_P6_MSB (17)
-#define BME280_PRESSURE_CALIB_DIG_P7_LSB (18)
-#define BME280_PRESSURE_CALIB_DIG_P7_MSB (19)
-#define BME280_PRESSURE_CALIB_DIG_P8_LSB (20)
-#define BME280_PRESSURE_CALIB_DIG_P8_MSB (21)
-#define BME280_PRESSURE_CALIB_DIG_P9_LSB (22)
-#define BME280_PRESSURE_CALIB_DIG_P9_MSB (23)
-#define BME280_HUMIDITY_CALIB_DIG_H1 (25)
-#define BME280_HUMIDITY_CALIB_DIG_H2_LSB (0)
-#define BME280_HUMIDITY_CALIB_DIG_H2_MSB (1)
-#define BME280_HUMIDITY_CALIB_DIG_H3 (2)
-#define BME280_HUMIDITY_CALIB_DIG_H4_MSB (3)
-#define BME280_HUMIDITY_CALIB_DIG_H4_LSB (4)
-#define BME280_HUMIDITY_CALIB_DIG_H5_MSB (5)
-#define BME280_HUMIDITY_CALIB_DIG_H6 (6)
-#define BME280_MASK_DIG_H4 (0x0F)
-/****************************************************/
-/**\name CALIBRATION REGISTER ADDRESS DEFINITIONS */
-/***************************************************/
-/*calibration parameters */
-#define BME280_TEMPERATURE_CALIB_DIG_T1_LSB_REG (0x88)
-#define BME280_TEMPERATURE_CALIB_DIG_T1_MSB_REG (0x89)
-#define BME280_TEMPERATURE_CALIB_DIG_T2_LSB_REG (0x8A)
-#define BME280_TEMPERATURE_CALIB_DIG_T2_MSB_REG (0x8B)
-#define BME280_TEMPERATURE_CALIB_DIG_T3_LSB_REG (0x8C)
-#define BME280_TEMPERATURE_CALIB_DIG_T3_MSB_REG (0x8D)
-#define BME280_PRESSURE_CALIB_DIG_P1_LSB_REG (0x8E)
-#define BME280_PRESSURE_CALIB_DIG_P1_MSB_REG (0x8F)
-#define BME280_PRESSURE_CALIB_DIG_P2_LSB_REG (0x90)
-#define BME280_PRESSURE_CALIB_DIG_P2_MSB_REG (0x91)
-#define BME280_PRESSURE_CALIB_DIG_P3_LSB_REG (0x92)
-#define BME280_PRESSURE_CALIB_DIG_P3_MSB_REG (0x93)
-#define BME280_PRESSURE_CALIB_DIG_P4_LSB_REG (0x94)
-#define BME280_PRESSURE_CALIB_DIG_P4_MSB_REG (0x95)
-#define BME280_PRESSURE_CALIB_DIG_P5_LSB_REG (0x96)
-#define BME280_PRESSURE_CALIB_DIG_P5_MSB_REG (0x97)
-#define BME280_PRESSURE_CALIB_DIG_P6_LSB_REG (0x98)
-#define BME280_PRESSURE_CALIB_DIG_P6_MSB_REG (0x99)
-#define BME280_PRESSURE_CALIB_DIG_P7_LSB_REG (0x9A)
-#define BME280_PRESSURE_CALIB_DIG_P7_MSB_REG (0x9B)
-#define BME280_PRESSURE_CALIB_DIG_P8_LSB_REG (0x9C)
-#define BME280_PRESSURE_CALIB_DIG_P8_MSB_REG (0x9D)
-#define BME280_PRESSURE_CALIB_DIG_P9_LSB_REG (0x9E)
-#define BME280_PRESSURE_CALIB_DIG_P9_MSB_REG (0x9F)
-
-#define BME280_HUMIDITY_CALIB_DIG_H1_REG (0xA1)
-
-#define BME280_HUMIDITY_CALIB_DIG_H2_LSB_REG (0xE1)
-#define BME280_HUMIDITY_CALIB_DIG_H2_MSB_REG (0xE2)
-#define BME280_HUMIDITY_CALIB_DIG_H3_REG (0xE3)
-#define BME280_HUMIDITY_CALIB_DIG_H4_MSB_REG (0xE4)
-#define BME280_HUMIDITY_CALIB_DIG_H4_LSB_REG (0xE5)
-#define BME280_HUMIDITY_CALIB_DIG_H5_MSB_REG (0xE6)
-#define BME280_HUMIDITY_CALIB_DIG_H6_REG (0xE7)
-/****************************************************/
-/**\name REGISTER ADDRESS DEFINITIONS */
-/***************************************************/
-#define BME280_CHIP_ID_REG (0xD0) /*Chip ID Register */
-#define BME280_RST_REG (0xE0) /*Softreset Register */
-#define BME280_STAT_REG (0xF3) /*Status Register */
-#define BME280_CTRL_MEAS_REG (0xF4) /*Ctrl Measure Register */
-#define BME280_CTRL_HUMIDITY_REG (0xF2) /*Ctrl Humidity Register*/
-#define BME280_CONFIG_REG (0xF5) /*Configuration Register */
-#define BME280_PRESSURE_MSB_REG (0xF7) /*Pressure MSB Register */
-#define BME280_PRESSURE_LSB_REG (0xF8) /*Pressure LSB Register */
-#define BME280_PRESSURE_XLSB_REG (0xF9) /*Pressure XLSB Register */
-#define BME280_TEMPERATURE_MSB_REG (0xFA) /*Temperature MSB Reg */
-#define BME280_TEMPERATURE_LSB_REG (0xFB) /*Temperature LSB Reg */
-#define BME280_TEMPERATURE_XLSB_REG (0xFC) /*Temperature XLSB Reg */
-#define BME280_HUMIDITY_MSB_REG (0xFD) /*Humidity MSB Reg */
-#define BME280_HUMIDITY_LSB_REG (0xFE) /*Humidity LSB Reg */
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS */
-/***************************************************/
-/* Status Register */
-#define BME280_STAT_REG_MEASURING__POS (3)
-#define BME280_STAT_REG_MEASURING__MSK (0x08)
-#define BME280_STAT_REG_MEASURING__LEN (1)
-#define BME280_STAT_REG_MEASURING__REG (BME280_STAT_REG)
-
-#define BME280_STAT_REG_IM_UPDATE__POS (0)
-#define BME280_STAT_REG_IM_UPDATE__MSK (0x01)
-#define BME280_STAT_REG_IM_UPDATE__LEN (1)
-#define BME280_STAT_REG_IM_UPDATE__REG (BME280_STAT_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR TEMPERATURE OVERSAMPLING */
-/***************************************************/
-/* Control Measurement Register */
-#define BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE__POS (5)
-#define BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE__MSK (0xE0)
-#define BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE__LEN (3)
-#define BME280_CTRL_MEAS_REG_OVERSAMP_TEMPERATURE__REG \
-(BME280_CTRL_MEAS_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR PRESSURE OVERSAMPLING */
-/***************************************************/
-#define BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE__POS (2)
-#define BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE__MSK (0x1C)
-#define BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE__LEN (3)
-#define BME280_CTRL_MEAS_REG_OVERSAMP_PRESSURE__REG \
-(BME280_CTRL_MEAS_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR POWER MODE */
-/***************************************************/
-#define BME280_CTRL_MEAS_REG_POWER_MODE__POS (0)
-#define BME280_CTRL_MEAS_REG_POWER_MODE__MSK (0x03)
-#define BME280_CTRL_MEAS_REG_POWER_MODE__LEN (2)
-#define BME280_CTRL_MEAS_REG_POWER_MODE__REG \
-(BME280_CTRL_MEAS_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR HUMIDITY OVERSAMPLING */
-/***************************************************/
-#define BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY__POS (0)
-#define BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY__MSK (0x07)
-#define BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY__LEN (3)
-#define BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY__REG \
-(BME280_CTRL_HUMIDITY_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR STANDBY TIME */
-/***************************************************/
-/* Configuration Register */
-#define BME280_CONFIG_REG_TSB__POS (5)
-#define BME280_CONFIG_REG_TSB__MSK (0xE0)
-#define BME280_CONFIG_REG_TSB__LEN (3)
-#define BME280_CONFIG_REG_TSB__REG (BME280_CONFIG_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR FILTER */
-/***************************************************/
-#define BME280_CONFIG_REG_FILTER__POS (2)
-#define BME280_CONFIG_REG_FILTER__MSK (0x1C)
-#define BME280_CONFIG_REG_FILTER__LEN (3)
-#define BME280_CONFIG_REG_FILTER__REG (BME280_CONFIG_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR SPI ENABLE */
-/***************************************************/
-#define BME280_CONFIG_REG_SPI3_ENABLE__POS (0)
-#define BME280_CONFIG_REG_SPI3_ENABLE__MSK (0x01)
-#define BME280_CONFIG_REG_SPI3_ENABLE__LEN (1)
-#define BME280_CONFIG_REG_SPI3_ENABLE__REG (BME280_CONFIG_REG)
-/****************************************************/
-/**\name BIT MASK, LENGTH AND POSITION DEFINITIONS
-FOR PRESSURE AND TEMPERATURE DATA */
-/***************************************************/
-/* Data Register */
-#define BME280_PRESSURE_XLSB_REG_DATA__POS (4)
-#define BME280_PRESSURE_XLSB_REG_DATA__MSK (0xF0)
-#define BME280_PRESSURE_XLSB_REG_DATA__LEN (4)
-#define BME280_PRESSURE_XLSB_REG_DATA__REG (BME280_PRESSURE_XLSB_REG)
-
-#define BME280_TEMPERATURE_XLSB_REG_DATA__POS (4)
-#define BME280_TEMPERATURE_XLSB_REG_DATA__MSK (0xF0)
-#define BME280_TEMPERATURE_XLSB_REG_DATA__LEN (4)
-#define BME280_TEMPERATURE_XLSB_REG_DATA__REG (BME280_TEMPERATURE_XLSB_REG)
-/****************************************************/
-/**\name BUS READ AND WRITE FUNCTION POINTERS */
-/***************************************************/
-#define BME280_WR_FUNC_PTR\
- s8 (*bus_write)(u8, u8,\
- u8 *, u8)
-
-#define BME280_RD_FUNC_PTR\
- s8 (*bus_read)(u8, u8,\
- u8 *, u8)
-
-#define BME280_MDELAY_DATA_TYPE u32
-
-#define BME280_3MS_DELAY (3)
-#define BME280_REGISTER_READ_DELAY (1)
-/**************************************************************/
-/**\name STRUCTURE DEFINITIONS */
-/**************************************************************/
-/*!
- * @brief This structure holds all device specific calibration parameters
- */
-struct bme280_calibration_param_t {
- u16 dig_T1;/**<calibration T1 data*/
- s16 dig_T2;/**<calibration T2 data*/
- s16 dig_T3;/**<calibration T3 data*/
- u16 dig_P1;/**<calibration P1 data*/
- s16 dig_P2;/**<calibration P2 data*/
- s16 dig_P3;/**<calibration P3 data*/
- s16 dig_P4;/**<calibration P4 data*/
- s16 dig_P5;/**<calibration P5 data*/
- s16 dig_P6;/**<calibration P6 data*/
- s16 dig_P7;/**<calibration P7 data*/
- s16 dig_P8;/**<calibration P8 data*/
- s16 dig_P9;/**<calibration P9 data*/
-
- u8 dig_H1;/**<calibration H1 data*/
- s16 dig_H2;/**<calibration H2 data*/
- u8 dig_H3;/**<calibration H3 data*/
- s16 dig_H4;/**<calibration H4 data*/
- s16 dig_H5;/**<calibration H5 data*/
- s8 dig_H6;/**<calibration H6 data*/
-
- s32 t_fine;/**<calibration T_FINE data*/
-};
-/*!
- * @brief This structure holds BME280 initialization parameters
- */
-struct bme280_t {
- struct bme280_calibration_param_t cal_param;
- /**< calibration parameters*/
-
- u8 chip_id;/**< chip id of the sensor*/
- u8 dev_addr;/**< device address of the sensor*/
+/* Header includes */
+#include "bme280_defs.h"
- u8 oversamp_temperature;/**< temperature over sampling*/
- u8 oversamp_pressure;/**< pressure over sampling*/
- u8 oversamp_humidity;/**< humidity over sampling*/
- u8 ctrl_hum_reg;/**< status of control humidity register*/
- u8 ctrl_meas_reg;/**< status of control measurement register*/
- u8 config_reg;/**< status of configuration register*/
-
- BME280_WR_FUNC_PTR;/**< bus write function pointer*/
- BME280_RD_FUNC_PTR;/**< bus read function pointer*/
- void (*delay_msec)(BME280_MDELAY_DATA_TYPE);/**< delay function pointer*/
-};
-/**************************************************************/
-/**\name FUNCTION DECLARATIONS */
-/**************************************************************/
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION */
-/**************************************************************/
-/*!
- * @brief This function is used for initialize
- * the bus read and bus write functions
- * and assign the chip id and I2C address of the BME280 sensor
- * chip id is read in the register 0xD0 bit from 0 to 7
- *
- * @param bme280 structure pointer.
- *
- * @note While changing the parameter of the bme280_t
- * @note consider the following point:
- * Changing the reference value of the parameter
- * will changes the local copy or local reference
- * make sure your changes will not
- * affect the reference value of the parameter
- * (Better case don't change the reference value of the parameter)
- *
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_init(struct bme280_t *bme280);
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION UNCOMPENSATED TEMPERATURE */
-/**************************************************************/
-/*!
- * @brief This API is used to read uncompensated temperature
- * in the registers 0xFA, 0xFB and 0xFC
- * @note 0xFA -> MSB -> bit from 0 to 7
- * @note 0xFB -> LSB -> bit from 0 to 7
- * @note 0xFC -> LSB -> bit from 4 to 7
- *
- * @param v_uncomp_temperature_s32 : The value of uncompensated temperature
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_temperature(
-s32 *v_uncomp_temperature_s32);
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION TRUE TEMPERATURE */
-/**************************************************************/
-/*!
- * @brief Reads actual temperature from uncompensated temperature
- * @note Returns the value in 0.01 degree Centigrade
- * Output value of "5123" equals 51.23 DegC.
- *
- *
- *
- * @param v_uncomp_temperature_s32 : value of uncompensated temperature
- *
- *
- * @return Returns the actual temperature
- *
-*/
-s32 bme280_compensate_temperature_int32(s32 v_uncomp_temperature_s32);
-/*!
- * @brief Reads actual temperature from uncompensated temperature
- * @note Returns the value with 500LSB/DegC centred around 24 DegC
- * output value of "5123" equals(5123/500)+24 = 34.246DegC
- *
- *
- * @param v_uncomp_temperature_s32: value of uncompensated temperature
- *
- *
- *
- * @return Return the actual temperature as s16 output
- *
-*/
-s16 bme280_compensate_temperature_int32_sixteen_bit_output(
-s32 v_uncomp_temperature_s32);
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION UNCOMPENSATED PRESSURE */
-/**************************************************************/
-/*!
- * @brief This API is used to read uncompensated pressure.
- * in the registers 0xF7, 0xF8 and 0xF9
- * @note 0xF7 -> MSB -> bit from 0 to 7
- * @note 0xF8 -> LSB -> bit from 0 to 7
- * @note 0xF9 -> LSB -> bit from 4 to 7
- *
- *
- *
- * @param v_uncomp_pressure_s32 : The value of uncompensated pressure
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_pressure(
-s32 *v_uncomp_pressure_s32);
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION TRUE PRESSURE */
-/**************************************************************/
-/*!
- * @brief Reads actual pressure from uncompensated pressure
- * @note Returns the value in Pascal(Pa)
- * Output value of "96386" equals 96386 Pa =
- * 963.86 hPa = 963.86 millibar
- *
- *
- *
- * @param v_uncomp_pressure_s32 : value of uncompensated pressure
- *
- *
- *
- * @return Return the actual pressure output as u32
- *
-*/
-u32 bme280_compensate_pressure_int32(s32 v_uncomp_pressure_s32);
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION UNCOMPENSATED HUMIDITY */
-/**************************************************************/
-/*!
- * @brief This API is used to read uncompensated humidity.
- * in the registers 0xF7, 0xF8 and 0xF9
- * @note 0xFD -> MSB -> bit from 0 to 7
- * @note 0xFE -> LSB -> bit from 0 to 7
- *
- *
- *
- * @param v_uncomp_humidity_s32 : The value of uncompensated humidity
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_humidity(
-s32 *v_uncomp_humidity_s32);
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION RELATIVE HUMIDITY */
-/**************************************************************/
-/*!
- * @brief Reads actual humidity from uncompensated humidity
- * @note Returns the value in %rH as unsigned 32bit integer
- * in Q22.10 format(22 integer 10 fractional bits).
- * @note An output value of 42313
- * represents 42313 / 1024 = 41.321 %rH
- *
- *
- *
- * @param v_uncomp_humidity_s32: value of uncompensated humidity
- *
- * @return Return the actual relative humidity output as u32
- *
-*/
-u32 bme280_compensate_humidity_int32(s32 v_uncomp_humidity_s32);
-/*!
- * @brief Reads actual humidity from uncompensated humidity
- * @note Returns the value in %rH as unsigned 16bit integer
- * @note An output value of 42313
- * represents 42313/512 = 82.643 %rH
- *
- *
- *
- * @param v_uncomp_humidity_s32: value of uncompensated humidity
- *
- *
- * @return Return the actual relative humidity output as u16
- *
-*/
-u16 bme280_compensate_humidity_int32_sixteen_bit_output(
-s32 v_uncomp_humidity_s32);
-/**************************************************************/
-/**\name FUNCTION FOR INTIALIZATION UNCOMPENSATED PRESSURE,
- TEMPERATURE AND HUMIDITY */
-/**************************************************************/
-/*!
- * @brief This API used to read uncompensated
- * pressure,temperature and humidity
- *
- *
- *
- *
- * @param v_uncomp_pressure_s32: The value of uncompensated pressure.
- * @param v_uncomp_temperature_s32: The value of uncompensated temperature
- * @param v_uncomp_humidity_s32: The value of uncompensated humidity.
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_uncomp_pressure_temperature_humidity(
-s32 *v_uncomp_pressure_s32,
-s32 *v_uncomp_temperature_s32, s32 *v_uncomp_humidity_s32);
-/**************************************************************/
-/**\name FUNCTION FOR TRUE UNCOMPENSATED PRESSURE,
- TEMPERATURE AND HUMIDITY */
-/**************************************************************/
-/*!
- * @brief This API used to read true pressure, temperature and humidity
- *
- *
- *
- *
- * @param v_pressure_u32 : The value of compensated pressure.
- * @param v_temperature_s32 : The value of compensated temperature.
- * @param v_humidity_u32 : The value of compensated humidity.
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_pressure_temperature_humidity(
-u32 *v_pressure_u32, s32 *v_temperature_s32, u32 *v_humidity_u32);
-/**************************************************************/
-/**\name FUNCTION FOR CALIBRATION */
-/**************************************************************/
-/*!
- * @brief This API is used to
- * calibration parameters used for calculation in the registers
- *
- * parameter | Register address | bit
- *------------|------------------|----------------
- * dig_T1 | 0x88 and 0x89 | from 0 : 7 to 8: 15
- * dig_T2 | 0x8A and 0x8B | from 0 : 7 to 8: 15
- * dig_T3 | 0x8C and 0x8D | from 0 : 7 to 8: 15
- * dig_P1 | 0x8E and 0x8F | from 0 : 7 to 8: 15
- * dig_P2 | 0x90 and 0x91 | from 0 : 7 to 8: 15
- * dig_P3 | 0x92 and 0x93 | from 0 : 7 to 8: 15
- * dig_P4 | 0x94 and 0x95 | from 0 : 7 to 8: 15
- * dig_P5 | 0x96 and 0x97 | from 0 : 7 to 8: 15
- * dig_P6 | 0x98 and 0x99 | from 0 : 7 to 8: 15
- * dig_P7 | 0x9A and 0x9B | from 0 : 7 to 8: 15
- * dig_P8 | 0x9C and 0x9D | from 0 : 7 to 8: 15
- * dig_P9 | 0x9E and 0x9F | from 0 : 7 to 8: 15
- * dig_H1 | 0xA1 | from 0 to 7
- * dig_H2 | 0xE1 and 0xE2 | from 0 : 7 to 8: 15
- * dig_H3 | 0xE3 | from 0 to 7
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_calib_param(void);
-/**************************************************************/
-/**\name FUNCTION FOR TEMPERATURE OVER SAMPLING */
-/**************************************************************/
-/*!
- * @brief This API is used to get
- * the temperature oversampling setting in the register 0xF4
- * bits from 5 to 7
- *
- * value | Temperature oversampling
- * ---------------------|---------------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of temperature over sampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_oversamp_temperature(
-u8 *v_value_u8);
-/*!
- * @brief This API is used to set
- * the temperature oversampling setting in the register 0xF4
- * bits from 5 to 7
- *
- * value | Temperature oversampling
- * ---------------------|---------------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of temperature over sampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_oversamp_temperature(
-u8 v_value_u8);
-/**************************************************************/
-/**\name FUNCTION FOR PRESSURE OVER SAMPLING */
-/**************************************************************/
-/*!
- * @brief This API is used to get
- * the pressure oversampling setting in the register 0xF4
- * bits from 2 to 4
- *
- * value | Pressure oversampling
- * --------------------|--------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of pressure oversampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_oversamp_pressure(
-u8 *v_value_u8);
-/*!
- * @brief This API is used to set
- * the pressure oversampling setting in the register 0xF4
- * bits from 2 to 4
- *
- * value | Pressure oversampling
- * --------------------|--------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of pressure oversampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_oversamp_pressure(
-u8 v_value_u8);
-/**************************************************************/
-/**\name FUNCTION FOR HUMIDITY OVER SAMPLING */
-/**************************************************************/
-/*!
- * @brief This API is used to get
- * the humidity oversampling setting in the register 0xF2
- * bits from 0 to 2
- *
- * value | Humidity oversampling
- * ---------------------|-------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of humidity over sampling
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_oversamp_humidity(u8 *v_value_u8);
-/*!
- * @brief This API is used to set
- * the humidity oversampling setting in the register 0xF2
- * bits from 0 to 2
- *
- * value | Humidity oversampling
- * ---------------------|-------------------------
- * 0x00 | Skipped
- * 0x01 | BME280_OVERSAMP_1X
- * 0x02 | BME280_OVERSAMP_2X
- * 0x03 | BME280_OVERSAMP_4X
- * 0x04 | BME280_OVERSAMP_8X
- * 0x05,0x06 and 0x07 | BME280_OVERSAMP_16X
- *
- *
- * @param v_value_u8 : The value of humidity over sampling
- *
- *
- *
- * @note The "BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY"
- * register sets the humidity
- * data acquisition options of the device.
- * @note changes to this registers only become
- * effective after a write operation to
- * "BME280_CTRL_MEAS_REG" register.
- * @note In the code automated reading and writing of
- * "BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY"
- * @note register first set the
- * "BME280_CTRL_HUMIDITY_REG_OVERSAMP_HUMIDITY"
- * and then read and write
- * the "BME280_CTRL_MEAS_REG" register in the function.
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_oversamp_humidity(
-u8 v_value_u8);
-/**************************************************************/
-/**\name FUNCTION FOR POWER MODE*/
-/**************************************************************/
-/*!
- * @brief This API used to get the
- * Operational Mode from the sensor in the register 0xF4 bit 0 and 1
- *
- *
- *
- * @param v_power_mode_u8 : The value of power mode
- * value | mode
- * -----------------|------------------
- * 0x00 | BME280_SLEEP_MODE
- * 0x01 and 0x02 | BME280_FORCED_MODE
- * 0x03 | BME280_NORMAL_MODE
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_power_mode(u8 *v_power_mode_u8);
-/*!
- * @brief This API used to set the
- * Operational Mode from the sensor in the register 0xF4 bit 0 and 1
- *
- *
- *
- * @param v_power_mode_u8 : The value of power mode
- * value | mode
- * -----------------|------------------
- * 0x00 | BME280_SLEEP_MODE
- * 0x01 and 0x02 | BME280_FORCED_MODE
- * 0x03 | BME280_NORMAL_MODE
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_power_mode(u8 v_power_mode_u8);
-/**************************************************************/
-/**\name FUNCTION FOR SOFT RESET*/
-/**************************************************************/
-/*!
- * @brief Used to reset the sensor
- * The value 0xB6 is written to the 0xE0
- * register the device is reset using the
- * complete power-on-reset procedure.
- * @note Soft reset can be easily set using bme280_set_softreset().
- * @note Usage Hint : bme280_set_softreset()
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_soft_rst(void);
-/**************************************************************/
-/**\name FUNCTION FOR SPI ENABLE*/
-/**************************************************************/
-/*!
- * @brief This API used to get the sensor
- * SPI mode(communication type) in the register 0xF5 bit 0
- *
- *
- *
- * @param v_enable_disable_u8 : The value of SPI enable
- * value | Description
- * --------|--------------
- * 0 | Disable
- * 1 | Enable
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_spi3(u8 *v_enable_disable_u8);
-/*!
- * @brief This API used to set the sensor
- * SPI mode(communication type) in the register 0xF5 bit 0
- *
- *
- *
- * @param v_enable_disable_u8 : The value of SPI enable
- * value | Description
- * --------|--------------
- * 0 | Disable
- * 1 | Enable
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_spi3(u8 v_enable_disable_u8);
-/**************************************************************/
-/**\name FUNCTION FOR IIR FILTER*/
-/**************************************************************/
-/*!
- * @brief This API is used to reads filter setting
- * in the register 0xF5 bit 3 and 4
- *
- *
- *
- * @param v_value_u8 : The value of IIR filter coefficient
- *
- * value | Filter coefficient
- * -------------|-------------------------
- * 0x00 | BME280_FILTER_COEFF_OFF
- * 0x01 | BME280_FILTER_COEFF_2
- * 0x02 | BME280_FILTER_COEFF_4
- * 0x03 | BME280_FILTER_COEFF_8
- * 0x04 | BME280_FILTER_COEFF_16
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_filter(u8 *v_value_u8);
-/*!
- * @brief This API is used to write filter setting
- * in the register 0xF5 bit 3 and 4
- *
- *
- *
- * @param v_value_u8 : The value of IIR filter coefficient
- *
- * value | Filter coefficient
- * -------------|-------------------------
- * 0x00 | BME280_FILTER_COEFF_OFF
- * 0x01 | BME280_FILTER_COEFF_2
- * 0x02 | BME280_FILTER_COEFF_4
- * 0x03 | BME280_FILTER_COEFF_8
- * 0x04 | BME280_FILTER_COEFF_16
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_filter(u8 v_value_u8);
-/**************************************************************/
-/**\name FUNCTION FOR STANDBY DURATION*/
-/**************************************************************/
/*!
- * @brief This API used to Read the
- * standby duration time from the sensor in the register 0xF5 bit 5 to 7
- *
- * @param v_standby_durn_u8 : The value of standby duration time value.
- * value | standby duration
- * -------------|-----------------------
- * 0x00 | BME280_STANDBY_TIME_1_MS
- * 0x01 | BME280_STANDBY_TIME_63_MS
- * 0x02 | BME280_STANDBY_TIME_125_MS
- * 0x03 | BME280_STANDBY_TIME_250_MS
- * 0x04 | BME280_STANDBY_TIME_500_MS
- * 0x05 | BME280_STANDBY_TIME_1000_MS
- * 0x06 | BME280_STANDBY_TIME_2000_MS
- * 0x07 | BME280_STANDBY_TIME_4000_MS
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_get_standby_durn(u8 *v_standby_durn_u8);
-/*!
- * @brief This API used to write the
- * standby duration time from the sensor in the register 0xF5 bit 5 to 7
- *
- * @param v_standby_durn_u8 : The value of standby duration time value.
- * value | standby duration
- * -------------|-----------------------
- * 0x00 | BME280_STANDBY_TIME_1_MS
- * 0x01 | BME280_STANDBY_TIME_63_MS
- * 0x02 | BME280_STANDBY_TIME_125_MS
- * 0x03 | BME280_STANDBY_TIME_250_MS
- * 0x04 | BME280_STANDBY_TIME_500_MS
- * 0x05 | BME280_STANDBY_TIME_1000_MS
- * 0x06 | BME280_STANDBY_TIME_2000_MS
- * 0x07 | BME280_STANDBY_TIME_4000_MS
- *
- * @note Normal mode comprises an automated perpetual
- * cycling between an (active)
- * Measurement period and an (inactive) standby period.
- * @note The standby time is determined by
- * the contents of the register t_sb.
- * Standby time can be set using BME280_STANDBY_TIME_125_MS.
- *
- * @note Usage Hint : bme280_set_standby_durn(BME280_STANDBY_TIME_125_MS)
- *
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-BME280_RETURN_FUNCTION_TYPE bme280_set_standby_durn(u8 v_standby_durn_u8);
-/**************************************************************/
-/**\name FUNCTION FOR WORK MODE*/
-/**************************************************************/
-/*
- * @brief Writes the working mode to the sensor
- *
- *
- *
- *
- * @param v_work_mode_u8 : Mode to be set
- * value | Working mode
- * ----------|--------------------
- * 0 | BME280_ULTRALOWPOWER_MODE
- * 1 | BME280_LOWPOWER_MODE
- * 2 | BME280_STANDARDRESOLUTION_MODE
- * 3 | BME280_HIGHRESOLUTION_MODE
- * 4 | BME280_ULTRAHIGHRESOLUTION_MODE
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
- *
- *
-*/
-/*BME280_RETURN_FUNCTION_TYPE bme280_set_work_mode(u8 v_work_mode_u8);*/
-/**************************************************************/
-/**\name FUNCTION FOR FORCE MODE DATA READ*/
-/**************************************************************/
-/*!
- * @brief This API used to read uncompensated
- * temperature,pressure and humidity in forced mode
- *
- *
- * @param v_uncom_pressure_s32: The value of uncompensated pressure
- * @param v_uncom_temperature_s32: The value of uncompensated temperature
- * @param v_uncom_humidity_s32: The value of uncompensated humidity
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
+ * @brief This API is the entry point.
+ * It reads the chip-id and calibration data from the sensor.
*
+ * @param[in,out] dev : Structure instance of bme280_dev
*
-*/
-BME280_RETURN_FUNCTION_TYPE
-bme280_get_forced_uncomp_pressure_temperature_humidity(
-s32 *v_uncom_pressure_s32,
-s32 *v_uncom_temperature_s32, s32 *v_uncom_humidity_s32);
-/**************************************************************/
-/**\name FUNCTION FOR COMMON READ AND WRITE */
-/**************************************************************/
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
+ */
+int8_t bme280_init(struct bme280_dev *dev);
+
/*!
- * @brief
- * This API write the data to
- * the given register
- *
- *
- * @param v_addr_u8 -> Address of the register
- * @param v_data_u8 -> The data from the register
- * @param v_len_u8 -> no of bytes to read
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
+ * @brief This API writes the given data to the register address
+ * of the sensor.
*
+ * @param[in] reg_addr : Register address from where the data to be written.
+ * @param[in] reg_data : Pointer to data buffer which is to be written
+ * in the sensor.
+ * @param[in] len : No of bytes of data to write..
+ * @param[in] dev : Structure instance of bme280_dev.
*
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
-BME280_RETURN_FUNCTION_TYPE bme280_write_register(u8 v_addr_u8,
-u8 *v_data_u8, u8 v_len_u8);
+int8_t bme280_set_regs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, const struct bme280_dev *dev);
+
/*!
- * @brief
- * This API reads the data from
- * the given register
- *
- *
- * @param v_addr_u8 -> Address of the register
- * @param v_data_u8 -> The data from the register
- * @param v_len_u8 -> no of bytes to read
- *
- *
- * @return results of bus communication function
- * @retval 0 -> Success
- * @retval -1 -> Error
+ * @brief This API reads the data from the given register address of the sensor.
*
+ * @param[in] reg_addr : Register address from where the data to be read
+ * @param[out] reg_data : Pointer to data buffer to store the read data.
+ * @param[in] len : No of bytes of data to be read.
+ * @param[in] dev : Structure instance of bme280_dev.
*
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
-BME280_RETURN_FUNCTION_TYPE bme280_read_register(u8 v_addr_u8,
-u8 *v_data_u8, u8 v_len_u8);
-/**************************************************************/
-/**\name FUNCTION FOR FLOAT OUTPUT TEMPERATURE*/
-/**************************************************************/
-#ifdef BME280_ENABLE_FLOAT
+int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, const struct bme280_dev *dev);
+
/*!
- * @brief Reads actual temperature from uncompensated temperature
- * @note returns the value in Degree centigrade
- * @note Output value of "51.23" equals 51.23 DegC.
- *
+ * @brief This API sets the oversampling, filter and standby duration
+ * (normal mode) settings in the sensor.
*
+ * @param[in] dev : Structure instance of bme280_dev.
+ * @param[in] desired_settings : Variable used to select the settings which
+ * are to be set in the sensor.
*
- * @param v_uncom_temperature_s32 : value of uncompensated temperature
+ * @note : Below are the macros to be used by the user for selecting the
+ * desired settings. User can do OR operation of these macros for configuring
+ * multiple settings.
*
+ * Macros | Functionality
+ * -----------------------|----------------------------------------------
+ * BME280_OSR_PRESS_SEL | To set pressure oversampling.
+ * BME280_OSR_TEMP_SEL | To set temperature oversampling.
+ * BME280_OSR_HUM_SEL | To set humidity oversampling.
+ * BME280_FILTER_SEL | To set filter setting.
+ * BME280_STANDBY_SEL | To set standby duration setting.
*
- *
- * @return Return the actual temperature in floating point
- *
-*/
-double bme280_compensate_temperature_double(
-s32 v_uncom_temperature_s32);
-/**************************************************************/
-/**\name FUNCTION FOR FLOAT OUTPUT PRESSURE*/
-/**************************************************************/
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
+ */
+int8_t bme280_set_sensor_settings(uint8_t desired_settings, const struct bme280_dev *dev);
+
/*!
- * @brief Reads actual pressure from uncompensated pressure
- * @note Returns pressure in Pa as double.
- * @note Output value of "96386.2"
- * equals 96386.2 Pa = 963.862 hPa.
- *
- *
- * @param v_uncom_pressure_s32 : value of uncompensated pressure
+ * @brief This API gets the oversampling, filter and standby duration
+ * (normal mode) settings from the sensor.
*
+ * @param[in,out] dev : Structure instance of bme280_dev.
*
- * @return Return the actual pressure in floating point
- *
-*/
-double bme280_compensate_pressure_double(s32 v_uncom_pressure_s32);
-/**************************************************************/
-/**\name FUNCTION FOR FLOAT OUTPUT HUMIDITY*/
-/**************************************************************/
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
+ */
+int8_t bme280_get_sensor_settings(struct bme280_dev *dev);
+
/*!
- * @brief Reads actual humidity from uncompensated humidity
- * @note returns the value in relative humidity (%rH)
- * @note Output value of "42.12" equals 42.12 %rH
+ * @brief This API sets the power mode of the sensor.
*
- * @param v_uncom_humidity_s32 : value of uncompensated humidity
+ * @param[in] dev : Structure instance of bme280_dev.
+ * @param[in] sensor_mode : Variable which contains the power mode to be set.
*
+ * sensor_mode | Macros
+ * ---------------------|-------------------
+ * 0 | BME280_SLEEP_MODE
+ * 1 | BME280_FORCED_MODE
+ * 3 | BME280_NORMAL_MODE
*
- *
- * @return Return the actual humidity in floating point
- *
-*/
-double bme280_compensate_humidity_double(s32 v_uncom_humidity_s32);
-#endif
-/**************************************************************/
-/**\name FUNCTION FOR 64BIT OUTPUT PRESSURE*/
-/**************************************************************/
-#if defined(BME280_ENABLE_INT64) && defined(BME280_64BITSUPPORT_PRESENT)
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
+ */
+int8_t bme280_set_sensor_mode(uint8_t sensor_mode,
+ const struct bme280_dev *dev);
+
/*!
- * @brief Reads actual pressure from uncompensated pressure
- * @note Returns the value in Pa as unsigned 32 bit
- * integer in Q24.8 format (24 integer bits and
- * 8 fractional bits).
- * @note Output value of "24674867"
- * represents 24674867 / 256 = 96386.2 Pa = 963.862 hPa
- *
+ * @brief This API gets the power mode of the sensor.
*
+ * @param[in] dev : Structure instance of bme280_dev.
+ * @param[out] sensor_mode : Pointer variable to store the power mode.
*
- * @param v_uncom_pressure_s32 : value of uncompensated temperature
+ * sensor_mode | Macros
+ * ---------------------|-------------------
+ * 0 | BME280_SLEEP_MODE
+ * 1 | BME280_FORCED_MODE
+ * 3 | BME280_NORMAL_MODE
*
- *
- * @return Return the actual pressure in u32
- *
-*/
-u32 bme280_compensate_pressure_int64(s32 v_uncom_pressure_s32);
-/**************************************************************/
-/**\name FUNCTION FOR 24BIT OUTPUT PRESSURE*/
-/**************************************************************/
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
+ */
+int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, const struct bme280_dev *dev);
+
/*!
- * @brief Reads actual pressure from uncompensated pressure
- * @note Returns the value in Pa.
- * @note Output value of "12337434"
- * @note represents 12337434 / 128 = 96386.2 Pa = 963.862 hPa
- *
- *
+ * @brief This API performs the soft reset of the sensor.
*
- * @param v_uncom_pressure_s32 : value of uncompensated pressure
+ * @param[in] dev : Structure instance of bme280_dev.
*
- *
- * @return the actual pressure in u32
- *
-*/
-u32 bme280_compensate_pressure_int64_twentyfour_bit_output(
-s32 v_uncom_pressure_s32);
-#endif
-/**************************************************************/
-/**\name FUNCTION FOR WAIT PERIOD*/
-/**************************************************************/
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
+ */
+int8_t bme280_soft_reset(const struct bme280_dev *dev);
+
/*!
- * @brief Computing waiting time for sensor data read
- *
+ * @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.
*
+ * @param[in] sensor_comp : Variable which selects which data to be read from
+ * the sensor.
*
+ * sensor_comp | Macros
+ * ------------|-------------------
+ * 1 | BME280_PRESS
+ * 2 | BME280_TEMP
+ * 4 | BME280_HUM
+ * 7 | BME280_ALL
*
- * @param v_delaytime_u8 : The value of delay time for force mode
- *
- *
- * @retval 0 -> Success
- *
+ * @param[out] comp_data : Structure instance of bme280_data.
+ * @param[in] dev : Structure instance of bme280_dev.
*
+ * @return Result of API execution status
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
-BME280_RETURN_FUNCTION_TYPE bme280_compute_wait_time(u8
-*v_delaytime_u8);
-#endif
+int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev);
+
+#ifdef __cplusplus
+}
+#endif /* End of CPP guard */
+#endif /* BME280_H_ */
+/** @}*/