411 lines
13 KiB
C
411 lines
13 KiB
C
|
/*
|
||
|
|
* bme280_defs.h
|
||
|
|
*
|
||
|
|
* Created on: 2023年8月15日
|
||
|
|
* Author: wyf
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef INC_BME280_DEFS_H_
|
||
|
|
#define INC_BME280_DEFS_H_
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
#include <stddef.h>
|
||
|
|
|
||
|
|
#ifndef NULL
|
||
|
|
#ifdef __cplusplus
|
||
|
|
#define NULL 0
|
||
|
|
#else
|
||
|
|
#define NULL ((void *) 0)
|
||
|
|
#endif
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef BME280_64BIT_ENABLE /*< Check if 64-bit integer (using BME280_64BIT_ENABLE) is enabled */
|
||
|
|
#ifndef BME280_32BIT_ENABLE /*< Check if 32-bit integer (using BME280_32BIT_ENABLE) is enabled */
|
||
|
|
#ifndef BME280_DOUBLE_ENABLE /*< If any of the integer data types not enabled then enable BME280_DOUBLE_ENABLE */
|
||
|
|
#define BME280_DOUBLE_ENABLE
|
||
|
|
#endif
|
||
|
|
#endif
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef TRUE
|
||
|
|
#define TRUE UINT8_C(1)
|
||
|
|
#endif
|
||
|
|
#ifndef FALSE
|
||
|
|
#define FALSE UINT8_C(0)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* BME280_INTF_RET_TYPE is the read/write interface return type which can be overwritten by the build system.
|
||
|
|
*/
|
||
|
|
#ifndef BME280_INTF_RET_TYPE
|
||
|
|
#define BME280_INTF_RET_TYPE int8_t
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* The last error code from read/write interface is stored in the device structure as intf_rslt.
|
||
|
|
*/
|
||
|
|
#ifndef BME280_INTF_RET_SUCCESS
|
||
|
|
#define BME280_INTF_RET_SUCCESS INT8_C(0)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
/*! @name API success code */
|
||
|
|
#define BME280_OK INT8_C(0)
|
||
|
|
|
||
|
|
/*! @name API error codes */
|
||
|
|
#define BME280_E_NULL_PTR INT8_C(-1)
|
||
|
|
#define BME280_E_COMM_FAIL INT8_C(-2)
|
||
|
|
#define BME280_E_INVALID_LEN INT8_C(-3)
|
||
|
|
#define BME280_E_DEV_NOT_FOUND INT8_C(-4)
|
||
|
|
#define BME280_E_SLEEP_MODE_FAIL INT8_C(-5)
|
||
|
|
#define BME280_E_NVM_COPY_FAILED INT8_C(-6)
|
||
|
|
|
||
|
|
/*! @name API warning codes */
|
||
|
|
#define BME280_W_INVALID_OSR_MACRO INT8_C(1)
|
||
|
|
|
||
|
|
/*! @name BME280 chip identifier */
|
||
|
|
#define BME280_CHIP_ID UINT8_C(0x60)
|
||
|
|
|
||
|
|
/*! @name I2C addresses */
|
||
|
|
#define BME280_I2C_ADDR_PRIM UINT8_C(0x76)
|
||
|
|
#define BME280_I2C_ADDR_SEC UINT8_C(0x77)
|
||
|
|
|
||
|
|
/*! @name Register Address */
|
||
|
|
#define BME280_REG_CHIP_ID UINT8_C(0xD0)
|
||
|
|
#define BME280_REG_RESET UINT8_C(0xE0)
|
||
|
|
#define BME280_REG_TEMP_PRESS_CALIB_DATA UINT8_C(0x88)
|
||
|
|
#define BME280_REG_HUMIDITY_CALIB_DATA UINT8_C(0xE1)
|
||
|
|
#define BME280_REG_CTRL_HUM UINT8_C(0xF2)
|
||
|
|
#define BME280_REG_STATUS UINT8_C(0xF3)
|
||
|
|
#define BME280_REG_PWR_CTRL UINT8_C(0xF4)
|
||
|
|
#define BME280_REG_CTRL_MEAS UINT8_C(0xF4)
|
||
|
|
#define BME280_REG_CONFIG UINT8_C(0xF5)
|
||
|
|
#define BME280_REG_DATA UINT8_C(0xF7)
|
||
|
|
|
||
|
|
/*! @name Macros related to size */
|
||
|
|
#define BME280_LEN_TEMP_PRESS_CALIB_DATA UINT8_C(26)
|
||
|
|
#define BME280_LEN_HUMIDITY_CALIB_DATA UINT8_C(7)
|
||
|
|
#define BME280_LEN_P_T_H_DATA UINT8_C(8)
|
||
|
|
|
||
|
|
/*! @name Sensor power modes */
|
||
|
|
#define BME280_POWERMODE_SLEEP UINT8_C(0x00)
|
||
|
|
#define BME280_POWERMODE_FORCED UINT8_C(0x01)
|
||
|
|
#define BME280_POWERMODE_NORMAL UINT8_C(0x03)
|
||
|
|
|
||
|
|
#define BME280_SENSOR_MODE_MSK UINT8_C(0x03)
|
||
|
|
#define BME280_SENSOR_MODE_POS UINT8_C(0x00)
|
||
|
|
|
||
|
|
/*! @name Soft reset command */
|
||
|
|
#define BME280_SOFT_RESET_COMMAND UINT8_C(0xB6)
|
||
|
|
|
||
|
|
#define BME280_STATUS_IM_UPDATE UINT8_C(0x01)
|
||
|
|
#define BME280_STATUS_MEAS_DONE UINT8_C(0x08)
|
||
|
|
|
||
|
|
/*! @name Sensor component selection macros
|
||
|
|
* These values are internal for API implementation. Don't relate this to
|
||
|
|
* data sheet.
|
||
|
|
*/
|
||
|
|
#define BME280_PRESS UINT8_C(1)
|
||
|
|
#define BME280_TEMP UINT8_C(1 << 1)
|
||
|
|
#define BME280_HUM UINT8_C(1 << 2)
|
||
|
|
#define BME280_ALL UINT8_C(0x07)
|
||
|
|
|
||
|
|
/*! @name Settings selection macros */
|
||
|
|
#define BME280_SEL_OSR_PRESS UINT8_C(1)
|
||
|
|
#define BME280_SEL_OSR_TEMP UINT8_C(1 << 1)
|
||
|
|
#define BME280_SEL_OSR_HUM UINT8_C(1 << 2)
|
||
|
|
#define BME280_SEL_FILTER UINT8_C(1 << 3)
|
||
|
|
#define BME280_SEL_STANDBY UINT8_C(1 << 4)
|
||
|
|
#define BME280_SEL_ALL_SETTINGS UINT8_C(0x1F)
|
||
|
|
|
||
|
|
/*! @name Oversampling macros */
|
||
|
|
#define BME280_NO_OVERSAMPLING UINT8_C(0x00)
|
||
|
|
#define BME280_OVERSAMPLING_1X UINT8_C(0x01)
|
||
|
|
#define BME280_OVERSAMPLING_2X UINT8_C(0x02)
|
||
|
|
#define BME280_OVERSAMPLING_4X UINT8_C(0x03)
|
||
|
|
#define BME280_OVERSAMPLING_8X UINT8_C(0x04)
|
||
|
|
#define BME280_OVERSAMPLING_16X UINT8_C(0x05)
|
||
|
|
#define BME280_OVERSAMPLING_MAX UINT8_C(16)
|
||
|
|
|
||
|
|
#define BME280_CTRL_HUM_MSK UINT8_C(0x07)
|
||
|
|
#define BME280_CTRL_HUM_POS UINT8_C(0x00)
|
||
|
|
#define BME280_CTRL_PRESS_MSK UINT8_C(0x1C)
|
||
|
|
#define BME280_CTRL_PRESS_POS UINT8_C(0x02)
|
||
|
|
#define BME280_CTRL_TEMP_MSK UINT8_C(0xE0)
|
||
|
|
#define BME280_CTRL_TEMP_POS UINT8_C(0x05)
|
||
|
|
|
||
|
|
/*! @name Measurement delay calculation macros */
|
||
|
|
#define BME280_MEAS_OFFSET UINT16_C(1250)
|
||
|
|
#define BME280_MEAS_DUR UINT16_C(2300)
|
||
|
|
#define BME280_PRES_HUM_MEAS_OFFSET UINT16_C(575)
|
||
|
|
#define BME280_MEAS_SCALING_FACTOR UINT16_C(1000)
|
||
|
|
#define BME280_STARTUP_DELAY UINT16_C(2000)
|
||
|
|
|
||
|
|
/*! @name Length macros */
|
||
|
|
#define BME280_MAX_LEN UINT8_C(10)
|
||
|
|
|
||
|
|
/*! @name Standby duration selection macros */
|
||
|
|
#define BME280_STANDBY_TIME_0_5_MS (0x00)
|
||
|
|
#define BME280_STANDBY_TIME_62_5_MS (0x01)
|
||
|
|
#define BME280_STANDBY_TIME_125_MS (0x02)
|
||
|
|
#define BME280_STANDBY_TIME_250_MS (0x03)
|
||
|
|
#define BME280_STANDBY_TIME_500_MS (0x04)
|
||
|
|
#define BME280_STANDBY_TIME_1000_MS (0x05)
|
||
|
|
#define BME280_STANDBY_TIME_10_MS (0x06)
|
||
|
|
#define BME280_STANDBY_TIME_20_MS (0x07)
|
||
|
|
|
||
|
|
#define BME280_STANDBY_MSK UINT8_C(0xE0)
|
||
|
|
#define BME280_STANDBY_POS UINT8_C(0x05)
|
||
|
|
|
||
|
|
/*! @name Bit shift macros */
|
||
|
|
#define BME280_12_BIT_SHIFT UINT8_C(12)
|
||
|
|
#define BME280_8_BIT_SHIFT UINT8_C(8)
|
||
|
|
#define BME280_4_BIT_SHIFT UINT8_C(4)
|
||
|
|
|
||
|
|
/*! @name Filter coefficient selection macros */
|
||
|
|
#define BME280_FILTER_COEFF_OFF (0x00)
|
||
|
|
#define BME280_FILTER_COEFF_2 (0x01)
|
||
|
|
#define BME280_FILTER_COEFF_4 (0x02)
|
||
|
|
#define BME280_FILTER_COEFF_8 (0x03)
|
||
|
|
#define BME280_FILTER_COEFF_16 (0x04)
|
||
|
|
|
||
|
|
#define BME280_FILTER_MSK UINT8_C(0x1C)
|
||
|
|
#define BME280_FILTER_POS UINT8_C(0x02)
|
||
|
|
|
||
|
|
/*! @name Macro to combine two 8 bit data's to form a 16 bit data */
|
||
|
|
#define BME280_CONCAT_BYTES(msb, lsb) (((uint16_t)msb << 8) | (uint16_t)lsb)
|
||
|
|
|
||
|
|
/*! @name Macro to SET and GET BITS of a register */
|
||
|
|
#define BME280_SET_BITS(reg_data, bitname, data) \
|
||
|
|
((reg_data & ~(bitname##_MSK)) | \
|
||
|
|
((data << bitname##_POS) & bitname##_MSK))
|
||
|
|
|
||
|
|
#define BME280_SET_BITS_POS_0(reg_data, bitname, data) \
|
||
|
|
((reg_data & ~(bitname##_MSK)) | \
|
||
|
|
(data & bitname##_MSK))
|
||
|
|
|
||
|
|
#define BME280_GET_BITS(reg_data, bitname) ((reg_data & (bitname##_MSK)) >> \
|
||
|
|
(bitname##_POS))
|
||
|
|
#define BME280_GET_BITS_POS_0(reg_data, bitname) (reg_data & (bitname##_MSK))
|
||
|
|
|
||
|
|
/********************************************************/
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief Interface selection Enums
|
||
|
|
*/
|
||
|
|
enum bme280_intf {
|
||
|
|
/*! SPI interface */
|
||
|
|
BME280_SPI_INTF,
|
||
|
|
/*! I2C interface */
|
||
|
|
BME280_I2C_INTF
|
||
|
|
};
|
||
|
|
|
||
|
|
typedef BME280_INTF_RET_TYPE (*bme280_read_fptr_t)(uint8_t reg_addr, uint8_t *reg_data, uint32_t len, void *intf_ptr);
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief Bus communication function pointer which should be mapped to
|
||
|
|
* the platform specific write functions of the user
|
||
|
|
*
|
||
|
|
* @param[in] reg_addr : Register address to which the data is written.
|
||
|
|
* @param[in] reg_data : Pointer to data buffer in which data to be written
|
||
|
|
* is stored.
|
||
|
|
* @param[in] len : Number of bytes of data to be written.
|
||
|
|
* @param[in, out] intf_ptr : Void pointer that can enable the linking of descriptors
|
||
|
|
* for interface related call backs
|
||
|
|
*
|
||
|
|
* @retval 0 -> Success.
|
||
|
|
* @retval Non zero value -> Fail.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
typedef BME280_INTF_RET_TYPE (*bme280_write_fptr_t)(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len,
|
||
|
|
void *intf_ptr);
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief Delay function pointer which should be mapped to
|
||
|
|
* delay function of the user
|
||
|
|
*
|
||
|
|
* @param[in] period : Delay in microseconds.
|
||
|
|
* @param[in, out] intf_ptr : Void pointer that can enable the linking of descriptors
|
||
|
|
* for interface related call backs
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
typedef void (*bme280_delay_us_fptr_t)(uint32_t period, void *intf_ptr);
|
||
|
|
|
||
|
|
/******************************************************************************/
|
||
|
|
/*! @name Structure Declarations */
|
||
|
|
/******************************************************************************/
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief Calibration data
|
||
|
|
*/
|
||
|
|
struct bme280_calib_data
|
||
|
|
{
|
||
|
|
/*! Calibration coefficient for the temperature sensor */
|
||
|
|
uint16_t dig_t1;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the temperature sensor */
|
||
|
|
int16_t dig_t2;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the temperature sensor */
|
||
|
|
int16_t dig_t3;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
uint16_t dig_p1;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p2;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p3;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p4;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p5;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p6;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p7;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p8;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the pressure sensor */
|
||
|
|
int16_t dig_p9;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the humidity sensor */
|
||
|
|
uint8_t dig_h1;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the humidity sensor */
|
||
|
|
int16_t dig_h2;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the humidity sensor */
|
||
|
|
uint8_t dig_h3;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the humidity sensor */
|
||
|
|
int16_t dig_h4;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the humidity sensor */
|
||
|
|
int16_t dig_h5;
|
||
|
|
|
||
|
|
/*! Calibration coefficient for the humidity sensor */
|
||
|
|
int8_t dig_h6;
|
||
|
|
|
||
|
|
/*! Variable to store the intermediate temperature coefficient */
|
||
|
|
int32_t t_fine;
|
||
|
|
};
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief bme280 sensor structure which comprises of temperature, pressure and
|
||
|
|
* humidity data
|
||
|
|
*/
|
||
|
|
#ifdef BME280_DOUBLE_ENABLE
|
||
|
|
struct bme280_data
|
||
|
|
{
|
||
|
|
/*! Compensated pressure */
|
||
|
|
double pressure;
|
||
|
|
|
||
|
|
/*! Compensated temperature */
|
||
|
|
double temperature;
|
||
|
|
|
||
|
|
/*! Compensated humidity */
|
||
|
|
double humidity;
|
||
|
|
};
|
||
|
|
#else
|
||
|
|
struct bme280_data
|
||
|
|
{
|
||
|
|
/*! Compensated pressure */
|
||
|
|
uint32_t pressure;
|
||
|
|
|
||
|
|
/*! Compensated temperature */
|
||
|
|
int32_t temperature;
|
||
|
|
|
||
|
|
/*! Compensated humidity */
|
||
|
|
uint32_t humidity;
|
||
|
|
};
|
||
|
|
#endif /*! BME280_USE_FLOATING_POINT */
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief bme280 sensor structure which comprises of uncompensated temperature,
|
||
|
|
* pressure and humidity data
|
||
|
|
*/
|
||
|
|
struct bme280_uncomp_data
|
||
|
|
{
|
||
|
|
/*! Un-compensated pressure */
|
||
|
|
uint32_t pressure;
|
||
|
|
|
||
|
|
/*! Un-compensated temperature */
|
||
|
|
uint32_t temperature;
|
||
|
|
|
||
|
|
/*! Un-compensated humidity */
|
||
|
|
uint32_t humidity;
|
||
|
|
};
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief bme280 sensor settings structure which comprises of mode,
|
||
|
|
* oversampling and filter settings.
|
||
|
|
*/
|
||
|
|
struct bme280_settings
|
||
|
|
{
|
||
|
|
/*! Pressure oversampling */
|
||
|
|
uint8_t osr_p;
|
||
|
|
|
||
|
|
/*! Temperature oversampling */
|
||
|
|
uint8_t osr_t;
|
||
|
|
|
||
|
|
/*! Humidity oversampling */
|
||
|
|
uint8_t osr_h;
|
||
|
|
|
||
|
|
/*! Filter coefficient */
|
||
|
|
uint8_t filter;
|
||
|
|
|
||
|
|
/*! Standby time */
|
||
|
|
uint8_t standby_time;
|
||
|
|
};
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief bme280 device structure
|
||
|
|
*/
|
||
|
|
struct bme280_dev
|
||
|
|
{
|
||
|
|
/*! Chip Id */
|
||
|
|
uint8_t chip_id;
|
||
|
|
|
||
|
|
/*! Interface Selection
|
||
|
|
* For SPI, intf = BME280_SPI_INTF
|
||
|
|
* For I2C, intf = BME280_I2C_INTF
|
||
|
|
*/
|
||
|
|
enum bme280_intf intf;
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* The interface pointer is used to enable the user
|
||
|
|
* to link their interface descriptors for reference during the
|
||
|
|
* implementation of the read and write interfaces to the
|
||
|
|
* hardware.
|
||
|
|
*/
|
||
|
|
void *intf_ptr;
|
||
|
|
|
||
|
|
/*! Variable to store result of read/write function */
|
||
|
|
BME280_INTF_RET_TYPE intf_rslt;
|
||
|
|
|
||
|
|
/*! Read function pointer */
|
||
|
|
bme280_read_fptr_t read;
|
||
|
|
|
||
|
|
/*! Write function pointer */
|
||
|
|
bme280_write_fptr_t write;
|
||
|
|
|
||
|
|
/*! Delay function pointer */
|
||
|
|
bme280_delay_us_fptr_t delay_us;
|
||
|
|
|
||
|
|
/*! Trim data */
|
||
|
|
struct bme280_calib_data calib_data;
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
#endif /* INC_BME280_DEFS_H_ */
|