path: root/include/driver/bme280.h

/**
 * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * 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    26 Aug 2019
 * @version 3.3.7
 * @brief
 *
 */

/*! @file bme280.h
 * @brief Sensor driver for BME280 sensor
 */

/*!
 * @defgroup BME280 SENSOR API
 */
#ifndef BME280_H_
#define BME280_H_

/* Header includes */
#include "driver/bme280_defs.h"

class BME280 {
	private:
		BME280(const BME280 &copy);
		unsigned char txbuf[16];
		unsigned char rxbuf[8];

		/*!
		* @brief This internal API puts the device to sleep mode.
		*
		* @return Result of API execution status.
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t put_device_to_sleep();

		/*!
		* @brief This internal API writes the power mode in the sensor.
		*
		* @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
		*/
		int8_t write_power_mode(uint8_t sensor_mode);

		/*!
		* @brief This internal API is used to validate the device pointer for
		* null conditions.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t null_ptr_check();

		/*!
		* @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.
		*/
		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.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t get_calib_data();

		/*!
		*  @brief This internal API is used to parse the temperature and
		*  pressure calibration data and store it in the device structure.
		*
		*  @param[in] reg_data : Contains the calibration data to be parsed.
		*/
		void parse_temp_press_calib_data(const uint8_t *reg_data);

		/*!
		*  @brief This internal API is used to parse the humidity calibration data
		*  and store it in device structure.
		*
		*  @param[in] reg_data : Contains calibration data to be parsed.
		*/
		void parse_humidity_calib_data(const uint8_t *reg_data);

#ifdef BME280_FLOAT_ENABLE

		/*!
		* @brief This internal API is used to compensate the raw pressure data and
		* return the compensated pressure data in double data type.
		*
		* @param[in] uncomp_data : Contains the uncompensated pressure data.
		* @param[in] calib_data : Pointer to the calibration data structure.
		*
		* @return Compensated pressure data.
		* @retval Compensated pressure data in double.
		*/
		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.
		*/
		double compensate_humidity(const struct bme280_uncomp_data *uncomp_data,
													const struct bme280_calib_data *calib_data);

		/*!
		* @brief This internal API is used to compensate the raw temperature data and
		* return the compensated temperature data in double data type.
		*
		* @param[in] uncomp_data : Contains the uncompensated temperature data.
		* @param[in] calib_data : Pointer to calibration data structure.
		*
		* @return Compensated temperature data.
		* @retval Compensated temperature data in double.
		*/
		double compensate_temperature(const struct bme280_uncomp_data *uncomp_data,
														struct bme280_calib_data *calib_data);

#else

		/*!
		* @brief This internal API is used to compensate the raw temperature data and
		* return the compensated temperature data in integer data type.
		*
		* @param[in] uncomp_data : Contains the uncompensated temperature data.
		* @param[in] calib_data : Pointer to calibration data structure.
		*
		* @return Compensated temperature data.
		* @retval Compensated temperature data in integer.
		*/
		int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_data,
														struct bme280_calib_data *calib_data);

		/*!
		* @brief This internal API is used to compensate the raw pressure data and
		* return the compensated pressure data in integer data type.
		*
		* @param[in] uncomp_data : Contains the uncompensated pressure data.
		* @param[in] calib_data : Pointer to the calibration data structure.
		*
		* @return Compensated pressure data.
		* @retval Compensated pressure data in integer.
		*/
		uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data,
														const struct bme280_calib_data *calib_data);

		/*!
		* @brief This internal API is used to compensate the raw humidity data and
		* return the compensated humidity data in integer data type.
		*
		* @param[in] uncomp_data : Contains the uncompensated humidity data.
		* @param[in] calib_data : Pointer to the calibration data structure.
		*
		* @return Compensated humidity data.
		* @retval Compensated humidity data in integer.
		*/
		uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data,
														const struct bme280_calib_data *calib_data);

#endif

		/*!
		* @brief This internal API is used to identify the settings which the user
		* wants to modify in the sensor.
		*
		* @param[in] sub_settings : Contains the settings subset to identify particular
		* group of settings which the user is interested to change.
		* @param[in] desired_settings : Contains the user specified settings.
		*
		* @return Indicates whether user is interested to modify the settings which
		* are related to sub_settings.
		* @retval True -> User wants to modify this group of settings
		* @retval False -> User does not want to modify this group of settings
		*/
		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 Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t set_osr_humidity_settings(const struct bme280_settings *settings);

		/*!
		* @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.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t set_osr_settings(uint8_t desired_settings,
												const struct bme280_settings *settings);

		/*!
		* @brief This API sets the pressure and/or temperature oversampling settings
		* in the sensor according to the settings selected by the user.
		*
		* @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
		*/
		int8_t set_osr_press_temp_settings(uint8_t desired_settings,
																const struct bme280_settings *settings);

		/*!
		* @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[out] reg_data : Variable which is filled according to the pressure
		* oversampling data provided by the user.
		*/
		void fill_osr_press_settings(uint8_t *reg_data, const struct bme280_settings *settings);

		/*!
		* @brief This internal API fills the temperature oversampling settings provided
		* by the user in the data buffer so as to write in the sensor.
		*
		* @param[out] reg_data : Variable which is filled according to the temperature
		* oversampling data provided by the user.
		*/
		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] desired_settings : variable to select the filter and/or
		* standby duration settings.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t set_filter_standby_settings(uint8_t desired_settings,
																const struct bme280_settings *settings);

		/*!
		* @brief This internal API fills the filter settings provided by the user
		* in the data buffer so as to write in the sensor.
		*
		* @param[out] reg_data : Variable which is filled according to the filter
		* settings data provided by the user.
		*/
		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[out] reg_data : Variable which is filled according to the standby
		* settings data provided by the user.
		*/
		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[in] reg_data : Register data to be parsed.
		*/
		void parse_device_settings(const uint8_t *reg_data, struct bme280_settings *settings);

		/*!
		* @brief This internal API reloads the already existing device settings in the
		* sensor after soft reset.
		*
		* @param[in] settings : Pointer variable which contains the settings to
		* be set in the sensor.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t reload_device_settings(const struct bme280_settings *settings);

	public:

		/*! Chip Id */
		uint8_t chip_id;

		/*! Device Id */
		uint8_t dev_id;

		/*! SPI/I2C interface */
		enum bme280_intf intf;

		/*! Read function pointer */
		bme280_com_fptr_t read;

		/*! Write function pointer */
		bme280_com_fptr_t write;

		/*! Delay function pointer */
		bme280_delay_fptr_t delay_ms;

		/*! Trim data */
		struct bme280_calib_data calib_data;

		/*! Sensor settings */
		struct bme280_settings settings;

		BME280(uint8_t const addr) : dev_id(addr) {}

		/*!
		*  @brief This API is the entry point.
		*  It reads the chip-id and calibration data from the sensor.
		*
		*  @return Result of API execution status
		*  @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t init();

		/*!
		* @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..
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t setRegs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len);

		/*!
		* @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.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t getRegs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len);

		/*!
		* @brief This API sets the oversampling, filter and standby duration
		* (normal mode) settings in the sensor.
		*
		* @param[in] desired_settings : Variable used to select the settings which
		* are to be set in the sensor.
		*
		* @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 Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
		*/
		int8_t setSensorSettings(uint8_t desired_settings);

		/*!
		* @brief This API gets the oversampling, filter and standby duration
		* (normal mode) settings from the sensor.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
		*/
		int8_t getSensorSettings();

		/*!
		* @brief This API sets the power mode of the sensor.
		*
		* @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 Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t setSensorMode(uint8_t sensor_mode);

		/*!
		* @brief This API gets the power mode of the sensor.
		*
		* @param[out] sensor_mode : Pointer variable to store the power mode.
		*
		*   sensor_mode            |   Macros
		* ---------------------|-------------------
		*     0                | BME280_SLEEP_MODE
		*     1                | BME280_FORCED_MODE
		*     3                | BME280_NORMAL_MODE
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t getSensorMode(uint8_t *sensor_mode);

		/*!
		* @brief This API performs the soft reset of the sensor.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error.
		*/
		int8_t softReset();

		/*!
		* @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[out] comp_data : Structure instance of bme280_data.
		*
		* @return Result of API execution status
		* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
		*/
		int8_t getSensorData(uint8_t sensor_comp, struct bme280_data *comp_data);

		/*!
		*  @brief This API is used to parse the pressure, temperature and
		*  humidity data and store it in the bme280_uncomp_data structure instance.
		*
		*  @param[in] reg_data     : Contains register data which needs to be parsed
		*  @param[out] uncomp_data : Contains the uncompensated pressure, temperature
		*  and humidity data.
		*/
		void parseSensorData(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data);

		/*!
		* @brief This 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
		*/
		int8_t compensateSensorData(uint8_t sensor_comp,
												const struct bme280_uncomp_data *uncomp_data,
												struct bme280_data *comp_data,
												struct bme280_calib_data *calib_data);

		inline void configure(uint8_t os_hum, uint8_t os_pres, uint8_t os_temp) {
			settings.osr_h = os_hum;
			settings.osr_p = os_pres;
			settings.osr_t = os_temp;
		}

		inline void setHumidityOversampling(uint8_t os) {
			settings.osr_h = os;
			setSensorSettings(BME280_OSR_HUM_SEL);
		}

		inline void setPressureOversampling(uint8_t os) {
			settings.osr_p = os;
			setSensorSettings(BME280_OSR_PRESS_SEL);
		}

		inline void setTemperatureOversampling(uint8_t os) {
			settings.osr_t = os;
			setSensorSettings(BME280_OSR_TEMP_SEL);
		}

		inline void setStandbyTime(uint8_t standby_time) {
			settings.standby_time = standby_time;
			setSensorSettings(BME280_STANDBY_SEL);
		}

		inline void setFilter(uint8_t filter) {
			settings.filter = filter;
			setSensorSettings(BME280_FILTER_SEL);
		}

		inline void enterSleepMode() {
			setSensorMode(BME280_SLEEP_MODE);
		}

		inline void enterNormalMode() {
			setSensorMode(BME280_NORMAL_MODE);
		}

		inline void enterForcedMode() {
			setSensorMode(BME280_FORCED_MODE);
		}

};

extern BME280 bme280;

#endif /* BME280_H_ */
/** @}*/