BME280 Driver 2.0.x
Driver for BME280 sensor
Loading...
Searching...
No Matches

Read sensor's settings. More...

Collaboration diagram for Get Functions:

Functions

int8_t BME280_GetMode (BME280_t *Dev, uint8_t *Mode)
 Function gets current Operating Mode from sensor.
 
int8_t BME280_GetPOvs (BME280_t *Dev, uint8_t *POvs)
 Function gets current pressure Oversampling from sensor.
 
int8_t BME280_GetTOvs (BME280_t *Dev, uint8_t *TOvs)
 Function gets current temperature Oversampling from sensor.
 
int8_t BME280_GetHOvs (BME280_t *Dev, uint8_t *HOvs)
 Function gets current humidity Oversampling from sensor.
 
int8_t BME280_GetTStby (BME280_t *Dev, uint8_t *TStby)
 Function gets current Standby Time from sensor.
 
int8_t BME280_GetTFilter (BME280_t *Dev, uint8_t *Filter)
 Function gets current IIR Filter coeficient from sensor.
 
int8_t BME280_Is3WireSPIEnabled (BME280_t *Dev, uint8_t *Result)
 Function checks if 3-wire SPI is enabled.
 

Detailed Description

Read sensor's settings.

Note
USE_GETTERS in Library Configuration must be uncommented tu use these functions

Function Documentation

◆ BME280_GetHOvs()

int8_t BME280_GetHOvs ( BME280_t Dev,
uint8_t *  HOvs 
)

Function gets current humidity Oversampling from sensor.

Parameters
[in]*Devpointer to sensor's BME280_t structure
[out]*HOvspointer to vartiable where result will be stored
Returns
BME280_OK success
BME280_PARAM_ERR wrong parameter passed
BME280_NO_INIT_ERR sensor was not initialized before
BME280_INTERFACE_ERR user defined read/write function returned non-zero value
Here is the call graph for this function:

◆ BME280_GetMode()

int8_t BME280_GetMode ( BME280_t Dev,
uint8_t *  Mode 
)

Function gets current Operating Mode from sensor.

Function updates current operating mode inside *Dev structure as well.

Parameters
[in]*Devpointer to sensor's BME280_t structure
[out]*Modepointer to vartiable where result will be stored
Returns
BME280_OK success
BME280_PARAM_ERR wrong parameter passed
BME280_NO_INIT_ERR sensor was not initialized before
BME280_INTERFACE_ERR user defined read/write function returned non-zero value
Here is the call graph for this function:

◆ BME280_GetPOvs()

int8_t BME280_GetPOvs ( BME280_t Dev,
uint8_t *  POvs 
)

Function gets current pressure Oversampling from sensor.

Parameters
[in]*Devpointer to sensor's BME280_t structure
[out]*POvspointer to vartiable where result will be stored
Returns
BME280_OK success
BME280_PARAM_ERR wrong parameter passed
BME280_NO_INIT_ERR sensor was not initialized before
BME280_INTERFACE_ERR user defined read/write function returned non-zero value
Here is the call graph for this function:

◆ BME280_GetTFilter()

int8_t BME280_GetTFilter ( BME280_t Dev,
uint8_t *  Filter 
)

Function gets current IIR Filter coeficient from sensor.

Parameters
[in]*Devpointer to sensor's BME280_t structure
[out]*Filterpointer to vartiable where result will be stored
Returns
BME280_OK success
BME280_PARAM_ERR wrong parameter passed
BME280_NO_INIT_ERR sensor was not initialized before
BME280_INTERFACE_ERR user defined read/write function returned non-zero value
Here is the call graph for this function:

◆ BME280_GetTOvs()

int8_t BME280_GetTOvs ( BME280_t Dev,
uint8_t *  TOvs 
)

Function gets current temperature Oversampling from sensor.

Parameters
[in]*Devpointer to sensor's BME280_t structure
[out]*TOvspointer to vartiable where result will be stored
Returns
BME280_OK success
BME280_PARAM_ERR wrong parameter passed
BME280_NO_INIT_ERR sensor was not initialized before
BME280_INTERFACE_ERR user defined read/write function returned non-zero value
Here is the call graph for this function:

◆ BME280_GetTStby()

int8_t BME280_GetTStby ( BME280_t Dev,
uint8_t *  TStby 
)

Function gets current Standby Time from sensor.

Parameters
[in]*Devpointer to sensor's BME280_t structure
[out]*TStbypointer to vartiable where result will be stored
Returns
BME280_OK success
BME280_PARAM_ERR wrong parameter passed
BME280_NO_INIT_ERR sensor was not initialized before
BME280_INTERFACE_ERR user defined read/write function returned non-zero value
Here is the call graph for this function:

◆ BME280_Is3WireSPIEnabled()

int8_t BME280_Is3WireSPIEnabled ( BME280_t Dev,
uint8_t *  Result 
)

Function checks if 3-wire SPI is enabled.

Parameters
[in]*Devpointer to sensor's BME280_t structure
[out]*Resultpointer to vartiable where result will be stored, 0 - disabled, 1 - enabled
Returns
BME280_OK success
BME280_PARAM_ERR wrong parameter passed
BME280_NO_INIT_ERR sensor was not initialized before
BME280_INTERFACE_ERR user defined read/write function returned non-zero value
Here is the call graph for this function: