bme680 example driver function

bme680 example driver modules More...

Collaboration diagram for bme680 example driver function:

Macros
#define	BME680_BASIC_DEFAULT_TEMPERATURE_OVERSAMPLING   BME680_OVERSAMPLING_x2
	bme680 basic example default definition
#define	BME680_BASIC_DEFAULT_PRESSURE_OVERSAMPLING   BME680_OVERSAMPLING_x16
#define	BME680_BASIC_DEFAULT_HUMIDITY_OVERSAMPLING   BME680_OVERSAMPLING_x1
#define	BME680_BASIC_DEFAULT_FILTER   BME680_FILTER_COEFF_15
#define	BME680_BASIC_DEFAULT_SPI_WIRE   BME680_SPI_WIRE_4
#define	BME680_GAS_DEFAULT_TEMPERATURE_OVERSAMPLING   BME680_OVERSAMPLING_x2
	bme680 gas example default definition
#define	BME680_GAS_DEFAULT_PRESSURE_OVERSAMPLING   BME680_OVERSAMPLING_x16
#define	BME680_GAS_DEFAULT_HUMIDITY_OVERSAMPLING   BME680_OVERSAMPLING_x1
#define	BME680_GAS_DEFAULT_FILTER   BME680_FILTER_COEFF_15
#define	BME680_GAS_DEFAULT_SPI_WIRE   BME680_SPI_WIRE_4

Functions
uint8_t	bme680_basic_init (bme680_interface_t interface, bme680_address_t addr_pin)
	basic example init
uint8_t	bme680_basic_deinit (void)
	basic example deinit
uint8_t	bme680_basic_read (float *temperature, float *pressure, float *humidity_percentage)
	basic example read
uint8_t	bme680_gas_init (bme680_interface_t interface, bme680_address_t addr_pin)
	gas example init
uint8_t	bme680_gas_deinit (void)
	gas example deinit
uint8_t	bme680_gas_read (float degree_celsius, uint16_t gas_wait_ms, uint8_t index, float *temperature, float *pressure, float *humidity_percentage, float *ohms)
	gas example read

Detailed Description

bme680 example driver modules

Macro Definition Documentation

BME680_BASIC_DEFAULT_FILTER

#define BME680_BASIC_DEFAULT_FILTER   BME680_FILTER_COEFF_15

filter coeff 15

Definition at line 59 of file driver_bme680_basic.h.

BME680_BASIC_DEFAULT_HUMIDITY_OVERSAMPLING

#define BME680_BASIC_DEFAULT_HUMIDITY_OVERSAMPLING   BME680_OVERSAMPLING_x1

humidity oversampling x1

Definition at line 58 of file driver_bme680_basic.h.

BME680_BASIC_DEFAULT_PRESSURE_OVERSAMPLING

#define BME680_BASIC_DEFAULT_PRESSURE_OVERSAMPLING   BME680_OVERSAMPLING_x16

pressure oversampling x16

Definition at line 57 of file driver_bme680_basic.h.

BME680_BASIC_DEFAULT_SPI_WIRE

#define BME680_BASIC_DEFAULT_SPI_WIRE   BME680_SPI_WIRE_4

spi wire 4

Definition at line 60 of file driver_bme680_basic.h.

BME680_BASIC_DEFAULT_TEMPERATURE_OVERSAMPLING

#define BME680_BASIC_DEFAULT_TEMPERATURE_OVERSAMPLING   BME680_OVERSAMPLING_x2

bme680 basic example default definition

temperature oversampling x2

Definition at line 56 of file driver_bme680_basic.h.

BME680_GAS_DEFAULT_FILTER

#define BME680_GAS_DEFAULT_FILTER   BME680_FILTER_COEFF_15

filter coeff 15

Definition at line 57 of file driver_bme680_gas.h.

BME680_GAS_DEFAULT_HUMIDITY_OVERSAMPLING

#define BME680_GAS_DEFAULT_HUMIDITY_OVERSAMPLING   BME680_OVERSAMPLING_x1

humidity oversampling x1

Definition at line 56 of file driver_bme680_gas.h.

BME680_GAS_DEFAULT_PRESSURE_OVERSAMPLING

#define BME680_GAS_DEFAULT_PRESSURE_OVERSAMPLING   BME680_OVERSAMPLING_x16

pressure oversampling x16

Definition at line 55 of file driver_bme680_gas.h.

BME680_GAS_DEFAULT_SPI_WIRE

#define BME680_GAS_DEFAULT_SPI_WIRE   BME680_SPI_WIRE_4

spi wire 4

Definition at line 58 of file driver_bme680_gas.h.

BME680_GAS_DEFAULT_TEMPERATURE_OVERSAMPLING

#define BME680_GAS_DEFAULT_TEMPERATURE_OVERSAMPLING   BME680_OVERSAMPLING_x2

bme680 gas example default definition

temperature oversampling x2

Definition at line 54 of file driver_bme680_gas.h.

Function Documentation

bme680_basic_deinit()

uint8_t bme680_basic_deinit

(

void

)

basic example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 211 of file driver_bme680_basic.c.

Here is the call graph for this function:

bme680_basic_init()

uint8_t bme680_basic_init	(	bme680_interface_t	interface,
		bme680_address_t	addr_pin )

basic example init

Parameters

[in]	interface	chip interface
[in]	addr_pin	chip address pin

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 50 of file driver_bme680_basic.c.

Here is the call graph for this function:

bme680_basic_read()

uint8_t bme680_basic_read	(	float *	temperature,
		float *	pressure,
		float *	humidity_percentage )

basic example read

Parameters

[out]	*temperature	pointer to a converted temperature buffer
[out]	*pressure	pointer to a converted pressure buffer
[out]	*humidity_percentage	pointer to a converted humidity percentage buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 187 of file driver_bme680_basic.c.

Here is the call graph for this function:

bme680_gas_deinit()

uint8_t bme680_gas_deinit

(

void

)

gas example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 263 of file driver_bme680_gas.c.

Here is the call graph for this function:

bme680_gas_init()

uint8_t bme680_gas_init	(	bme680_interface_t	interface,
		bme680_address_t	addr_pin )

gas example init

Parameters

[in]	interface	chip interface
[in]	addr_pin	chip address pin

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 50 of file driver_bme680_gas.c.

Here is the call graph for this function:

bme680_gas_read()

uint8_t bme680_gas_read	(	float	degree_celsius,
		uint16_t	gas_wait_ms,
		uint8_t	index,
		float *	temperature,
		float *	pressure,
		float *	humidity_percentage,
		float *	ohms )

gas example read

Parameters

[in]	degree_celsius	input degree celsius
[in]	gas_wait_ms	gas wait ms
[in]	index	convert index
[out]	*temperature	pointer to a converted temperature buffer
[out]	*pressure	pointer to a converted pressure buffer
[out]	*humidity_percentage	pointer to a converted humidity percentage buffer
[out]	*ohms	pointer to an ohms buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 191 of file driver_bme680_gas.c.

Here is the call graph for this function: