Kevin Braun / bme280

Multi environmental sensor

Embed: (wiki syntax)

« Back to documentation index

bme280 Class Reference
Data Structures | Public Types | Public Member Functions

bme280 Class Reference

Create bme280 controller class. More...

#include <bme280.h>

Data Structures

struct  bme_cal
 Public data structure for CME280 correction values. More...
struct  bme_data
 Public data structure to obtain CME280 data. More...

Public Types

enum  CSBpolarity
 

Public enum for selecting polarity of I2C address pin.

More...

Public Member Functions

 bme280 (PinName sda, PinName scl, CSBpolarity CSBpin)
 Create a BME280 object using the specified I2C object

  • User defined use of the CSB pin
  • CSB pin = 0, user set I2C address to 0xEC
  • CSB pin = 1, user set I2C address to 0xEE.

 ~bme280 ()
 Destructor.
uint8_t getBmeID ()
 Get BME280 ID Register.
uint8_t resetBme ()
 Soft Reset the BME280.
uint8_t getBmeStatus ()
 Get BME280 Status Register.
uint8_t getBmeRawData (bme_data &bmed)
 Get BME280 Raw Data.
void convertBmeRawData (bme_data &bmed, bme_cal &bmec)
 Convert BME280 Raw Data using integer based routines.
void convertBmeRawDataFloat (bme_data &bmed, bme_cal &bmec)
 Convert BME280 Raw Data using all floating routines.
uint8_t initBme (bme_cal &bmec)
 Initialize the BME280.
float getAltitudeFT (bme_data &bmed, float sea_pressure)
 Corrected altitude (feet) from barometer at seal level (mB)
float getSeaLevelBaroFT (bme_data &bmed, float known_alt)
 Altitude corrected barometer (feet)
float getSeaLevelBaroM (bme_data &bmed, float known_alt)
 Altitude corrected barometer (meters)
float getDewPt (bme_data &bmed)
 Return the dew point based on T & H.
float getDewPtFast (bme_data &bmed)
 Return the dew point based on T & H.

Detailed Description

Create bme280 controller class.

Parameters:
bme280class

Definition at line 116 of file bme280.h.

Member Enumeration Documentation

enum CSBpolarity

Public enum for selecting polarity of I2C address pin.

  • CSB pin = 0, user set I2C address to 0xEC
  • CSB pin = 1, user set I2C address to 0xEE

Definition at line 176 of file bme280.h.

Constructor & Destructor Documentation

bme280 ( PinName  sda,
PinName  scl,
CSBpolarity  CSBpin 
)

Create a BME280 object using the specified I2C object

  • User defined use of the CSB pin
  • CSB pin = 0, user set I2C address to 0xEC
  • CSB pin = 1, user set I2C address to 0xEE.

Parameters:
sda- mbed I2C interface pin
scl- mbed I2C interface pin
bme280::CSBpin_0- CSB pin tied to ground
bme280::CSBpin_1- CSB pin tied to VDD

Definition at line 8 of file bme280.cpp.

~bme280 (  )

Destructor.

Parameters:
--none--

Definition at line 23 of file bme280.cpp.

Member Function Documentation

void convertBmeRawData ( bme_data &  bmed,
bme_cal &  bmec 
)

Convert BME280 Raw Data using integer based routines.

Parameters:
pointerto struct bme_data
pointerto struct bme_cal
Returns:
converted data put into struct bme_data

Definition at line 156 of file bme280.cpp.

void convertBmeRawDataFloat ( bme_data &  bmed,
bme_cal &  bmec 
)

Convert BME280 Raw Data using all floating routines.

Parameters:
pointerto struct bme_data
pointerto struct bme_cal
Returns:
converted data put into struct bme_data

Definition at line 203 of file bme280.cpp.

float getAltitudeFT ( bme_data &  bmed,
float  sea_pressure 
)

Corrected altitude (feet) from barometer at seal level (mB)

Parameters:
pointerto struct bme_data
pressureat sea level (in mB)
Returns:
corrected altimeter (in feet)

Definition at line 375 of file bme280.cpp.

uint8_t getBmeID (  )

Get BME280 ID Register.

Parameters:
--none--
Returns:
ID Register value

Definition at line 70 of file bme280.cpp.

uint8_t getBmeRawData ( bme_data &  bmed )

Get BME280 Raw Data.

Parameters:
pointerto struct bme_data
Returns:
Status Register value. Pass-thru from getBmeStatus()
raw data put into struct bme_data

Definition at line 127 of file bme280.cpp.

uint8_t getBmeStatus (  )

Get BME280 Status Register.

Parameters:
--none--
Returns:
Status Register value

Definition at line 108 of file bme280.cpp.

float getDewPt ( bme_data &  bmed )

Return the dew point based on T & H.

Slower but more accurate.

Parameters:
pointerto struct bme_data
Returns:
dew point in degrees C

Definition at line 396 of file bme280.cpp.

float getDewPtFast ( bme_data &  bmed )

Return the dew point based on T & H.

Faster but less accurate.

Parameters:
pointerto struct bme_data
Returns:
dew point in degrees C

Definition at line 413 of file bme280.cpp.

float getSeaLevelBaroFT ( bme_data &  bmed,
float  known_alt 
)

Altitude corrected barometer (feet)

Parameters:
pointerto struct bme_data
known_altin feet
Returns:
corrected barometer

Definition at line 382 of file bme280.cpp.

float getSeaLevelBaroM ( bme_data &  bmed,
float  known_alt 
)

Altitude corrected barometer (meters)

Parameters:
pointerto struct bme_data
known_altin meters
Returns:
corrected barometer

Definition at line 389 of file bme280.cpp.

uint8_t initBme ( bme_cal &  bmec )

Initialize the BME280.

  • Sets up the command registers
  • Loads up the calibration data
Parameters:
pointerto struct bme_data
Returns:
0

Definition at line 255 of file bme280.cpp.

uint8_t resetBme (  )

Soft Reset the BME280.

Parameters:
--none--
Returns:
ACK/NACK status

Definition at line 90 of file bme280.cpp.

Generated on Wed Jul 13 2022 03:46:20 by  doxygen 1.7.2