C

This page includes guidelines and documentation for installing the BME280 C library in VS Code.

Installation

Installation guidelines are coming soon.

Library Overview

This section includes data types, library initialization, configuration, and readouts.

Data Types

TPHDData

Defines sensor readout variables.

Struct

typedef struct
{
    float temperature;
    float humidity;
    float pressure;
    float dewPoint;
    float vpd;
} TPHDVData;

Initialization

BME280_Init

Initializes the BME280 sensor.

Prototype

void BME280_Init(
    I2C_HandleTypeDef *_i2c,
    bme280_i2c_address_types_t _i2cAddress)

Parameters

• _i2c: I2C Handle

• _i2cAddress: I2C Address

Returns

• None

Sample

// Sample code is coming soon.

Configuration

BME280_Config

Configures the BME280 sensor.

Prototype

ErrorStatus BME280_Config(
    bme280_ctrl_meas_osrs_t_types_t _temperatureSensorOversampling,
    bme280_ctrl_hum_osrs_h_types_t _humiditySensorOversampling,
    bme280_ctrl_meas_osrs_p_types_t _pressureSensorOversampling,
    bme280_config_filter_iir_types_t _iirFilter,
    bme280_config_standby_time_types_t _standbyTime,
    bme280_ctrl_meas_mode_types_t _measurementMode)

Parameters

• _temperatureSensorOversampling: Oversampling setting for the temperature sensor.

• _humiditySensorOversampling: Oversampling setting for the humidity sensor.

• _pressureSensorOversampling: Oversampling setting for the pressure sensor.

• _iirFilter: IIR filter setting.

• _standbyTime: Standby time setting.

• _measurementMode: Measurement mode setting.

Returns

• ErrorStatus: Error status.

Sample

// Sample code is coming soon.

BME280_SetMeasurementMode

Sets the BME280 sensor's measurement mode.

Prototype

ErrorStatus BME280_SetMeasurementMode(
    bme280_ctrl_meas_mode_types_t _measurementMode)

Parameters

• _measurementMode: Measurement mode setting.

Returns

• ErrorStatus: Error status.

Sample

// Sample code is coming soon.

Readouts

BME280_ReadTPH

Measures temperature, pressure, and humidity using the BME280 sensor.

Prototype

ErrorStatus BME280_ReadTPH(
    bool _forceRead,
    TPHDVData *tphdvData)

Parameters

• _forceRead (bool): Force sensor to measure one sample.

• *tphdvData (TPHDVData): Pointer to the TPHDVData struct

Returns

• ErrorStatus: Error status.

Sample

// Sample code is coming soon.

BME280_ReadTPHDV

Measures temperature, pressure, and relative humidity using the BME280 sensor & calculates dew point and vapor pressure deficit.

Prototype

ErrorStatus BME280_ReadTPHDV(
    bool _forceRead,
    TPHDVData *tphdvData)

Parameters

• _forceRead (bool): Force sensor to measure one sample.

• *tphdvData (TPHDVData): Pointer to the TPHDVData struct

Returns

• ErrorStatus: Error status.

Sample

// Sample code is coming soon.

BME280_ReadTemperature

Reads temperature using the BME280 sensor.

Prototype

ErrorStatus BME280_ReadTemperature(
    bool _forceRead,
    TPHDVData *tphdvData)

Parameters

• _forceRead (bool): Force sensor to measure one sample.

• *tphdvData (TPHDVData): Pointer to the TPHDVData struct

Returns

• ErrorStatus: Error status.

Sample

// Sample code is coming soon.

BME280_ReadPressure

Reads pressure using the BME280 sensor.

Prototype

ErrorStatus BME280_ReadPressure(
    bool _forceRead,
    TPHDVData *tphdvData)

Parameters

• _forceRead (bool): Force sensor to measure one sample.

• *tphdvData (TPHDVData): Pointer to the TPHDVData struct

Returns

• ErrorStatus: Error status.

Sample

// Sample code is coming soon.

BME280_ReadHumidity

Reads humidity using the BME280 sensor.

Prototype

ErrorStatus BME280_ReadHumidity(
    bool _forceRead,
    TPHDVData *tphdvData)

Parameters

• _forceRead (bool): Force sensor to measure one sample.

• *tphdvData (TPHDVData): Pointer to the TPHDVData struct

Returns

• ErrorStatus: Error status.

Sample

// Sample code is coming soon.

BME280_CalculateAltitude

Calculates altitude using sea level pressure and measured pressure data.

Prototype

float BME280_CalculateAltitude(
    float pressure,
    float meanSeaLevelPressure)

Parameters

• pressure (float): Measured pressure in hectoPascals (hPa)

• meanSeaLevelPressure (float): Mean sea level pressure in bar

Returns

• float: Altitude in meters

Sample

// Sample code is coming soon.

Sample

A complete code sample will be available soon.