LibDriver BME688
Loading...
Searching...
No Matches
bme688 example driver function
bme688 driver function

bme688 example driver modules More...

Collaboration diagram for bme688 example driver function:

Macros

#define BME688_BASIC_DEFAULT_TEMPERATURE_OVERSAMPLING   BME688_OVERSAMPLING_x2
 bme688 basic example default definition
#define BME688_BASIC_DEFAULT_PRESSURE_OVERSAMPLING   BME688_OVERSAMPLING_x16
#define BME688_BASIC_DEFAULT_HUMIDITY_OVERSAMPLING   BME688_OVERSAMPLING_x1
#define BME688_BASIC_DEFAULT_FILTER   BME688_FILTER_COEFF_15
#define BME688_BASIC_DEFAULT_SPI_WIRE   BME688_SPI_WIRE_4
#define BME688_GAS_DEFAULT_TEMPERATURE_OVERSAMPLING   BME688_OVERSAMPLING_x2
 bme688 gas example default definition
#define BME688_GAS_DEFAULT_PRESSURE_OVERSAMPLING   BME688_OVERSAMPLING_x16
#define BME688_GAS_DEFAULT_HUMIDITY_OVERSAMPLING   BME688_OVERSAMPLING_x1
#define BME688_GAS_DEFAULT_FILTER   BME688_FILTER_COEFF_15
#define BME688_GAS_DEFAULT_SPI_WIRE   BME688_SPI_WIRE_4
#define BME688_PARALLEL_DEFAULT_TEMPERATURE_OVERSAMPLING   BME688_OVERSAMPLING_x2
 bme688 parallel example default definition
#define BME688_PARALLEL_DEFAULT_PRESSURE_OVERSAMPLING   BME688_OVERSAMPLING_x16
#define BME688_PARALLEL_DEFAULT_HUMIDITY_OVERSAMPLING   BME688_OVERSAMPLING_x1
#define BME688_PARALLEL_DEFAULT_FILTER   BME688_FILTER_COEFF_15
#define BME688_PARALLEL_DEFAULT_SPI_WIRE   BME688_SPI_WIRE_4

Functions

uint8_t bme688_basic_init (bme688_interface_t interface, bme688_address_t addr_pin)
 basic example init
uint8_t bme688_basic_deinit (void)
 basic example deinit
uint8_t bme688_basic_read (float *temperature, float *pressure, float *humidity_percentage)
 basic example read
uint8_t bme688_gas_init (bme688_interface_t interface, bme688_address_t addr_pin)
 gas example init
uint8_t bme688_gas_deinit (void)
 gas example deinit
uint8_t bme688_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
uint8_t bme688_parallel_init (bme688_interface_t interface, bme688_address_t addr_pin, bme688_parallel_config_t *config, void(*callback)(uint8_t status, bme688_parallel_data_t *data, uint8_t len))
 parallel example init
uint8_t bme688_parallel_deinit (void)
 parallel example deinit
uint8_t bme688_parallel_server (void)
 parallel example server
uint8_t bme688_parallel_server_reset (void)
 parallel example server reset

Detailed Description

bme688 example driver modules

Macro Definition Documentation

◆ BME688_BASIC_DEFAULT_FILTER

#define BME688_BASIC_DEFAULT_FILTER   BME688_FILTER_COEFF_15

filter coeff 15

Definition at line 59 of file driver_bme688_basic.h.

◆ BME688_BASIC_DEFAULT_HUMIDITY_OVERSAMPLING

#define BME688_BASIC_DEFAULT_HUMIDITY_OVERSAMPLING   BME688_OVERSAMPLING_x1

humidity oversampling x1

Definition at line 58 of file driver_bme688_basic.h.

◆ BME688_BASIC_DEFAULT_PRESSURE_OVERSAMPLING

#define BME688_BASIC_DEFAULT_PRESSURE_OVERSAMPLING   BME688_OVERSAMPLING_x16

pressure oversampling x16

Definition at line 57 of file driver_bme688_basic.h.

◆ BME688_BASIC_DEFAULT_SPI_WIRE

#define BME688_BASIC_DEFAULT_SPI_WIRE   BME688_SPI_WIRE_4

spi wire 4

Definition at line 60 of file driver_bme688_basic.h.

◆ BME688_BASIC_DEFAULT_TEMPERATURE_OVERSAMPLING

#define BME688_BASIC_DEFAULT_TEMPERATURE_OVERSAMPLING   BME688_OVERSAMPLING_x2

bme688 basic example default definition

temperature oversampling x2

Definition at line 56 of file driver_bme688_basic.h.

◆ BME688_GAS_DEFAULT_FILTER

#define BME688_GAS_DEFAULT_FILTER   BME688_FILTER_COEFF_15

filter coeff 15

Definition at line 57 of file driver_bme688_gas.h.

◆ BME688_GAS_DEFAULT_HUMIDITY_OVERSAMPLING

#define BME688_GAS_DEFAULT_HUMIDITY_OVERSAMPLING   BME688_OVERSAMPLING_x1

humidity oversampling x1

Definition at line 56 of file driver_bme688_gas.h.

◆ BME688_GAS_DEFAULT_PRESSURE_OVERSAMPLING

#define BME688_GAS_DEFAULT_PRESSURE_OVERSAMPLING   BME688_OVERSAMPLING_x16

pressure oversampling x16

Definition at line 55 of file driver_bme688_gas.h.

◆ BME688_GAS_DEFAULT_SPI_WIRE

#define BME688_GAS_DEFAULT_SPI_WIRE   BME688_SPI_WIRE_4

spi wire 4

Definition at line 58 of file driver_bme688_gas.h.

◆ BME688_GAS_DEFAULT_TEMPERATURE_OVERSAMPLING

#define BME688_GAS_DEFAULT_TEMPERATURE_OVERSAMPLING   BME688_OVERSAMPLING_x2

bme688 gas example default definition

temperature oversampling x2

Definition at line 54 of file driver_bme688_gas.h.

◆ BME688_PARALLEL_DEFAULT_FILTER

#define BME688_PARALLEL_DEFAULT_FILTER   BME688_FILTER_COEFF_15

filter coeff 15

Definition at line 57 of file driver_bme688_parallel.h.

◆ BME688_PARALLEL_DEFAULT_HUMIDITY_OVERSAMPLING

#define BME688_PARALLEL_DEFAULT_HUMIDITY_OVERSAMPLING   BME688_OVERSAMPLING_x1

humidity oversampling x1

Definition at line 56 of file driver_bme688_parallel.h.

◆ BME688_PARALLEL_DEFAULT_PRESSURE_OVERSAMPLING

#define BME688_PARALLEL_DEFAULT_PRESSURE_OVERSAMPLING   BME688_OVERSAMPLING_x16

pressure oversampling x16

Definition at line 55 of file driver_bme688_parallel.h.

◆ BME688_PARALLEL_DEFAULT_SPI_WIRE

#define BME688_PARALLEL_DEFAULT_SPI_WIRE   BME688_SPI_WIRE_4

spi wire 4

Definition at line 58 of file driver_bme688_parallel.h.

◆ BME688_PARALLEL_DEFAULT_TEMPERATURE_OVERSAMPLING

#define BME688_PARALLEL_DEFAULT_TEMPERATURE_OVERSAMPLING   BME688_OVERSAMPLING_x2

bme688 parallel example default definition

temperature oversampling x2

Definition at line 54 of file driver_bme688_parallel.h.

Function Documentation

◆ bme688_basic_deinit()

uint8_t bme688_basic_deinit ( void )

basic example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 212 of file driver_bme688_basic.c.

Here is the call graph for this function:

◆ bme688_basic_init()

uint8_t bme688_basic_init ( bme688_interface_t interface,
bme688_address_t addr_pin )

basic example init

Parameters
[in]interfacechip interface
[in]addr_pinchip address pin
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 50 of file driver_bme688_basic.c.

Here is the call graph for this function:

◆ bme688_basic_read()

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

basic example read

Parameters
[out]*temperaturepointer to a converted temperature buffer
[out]*pressurepointer to a converted pressure buffer
[out]*humidity_percentagepointer to a converted humidity percentage buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 188 of file driver_bme688_basic.c.

Here is the call graph for this function:

◆ bme688_gas_deinit()

uint8_t bme688_gas_deinit ( void )

gas example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 321 of file driver_bme688_gas.c.

Here is the call graph for this function:

◆ bme688_gas_init()

uint8_t bme688_gas_init ( bme688_interface_t interface,
bme688_address_t addr_pin )

gas example init

Parameters
[in]interfacechip interface
[in]addr_pinchip address pin
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 50 of file driver_bme688_gas.c.

Here is the call graph for this function:

◆ bme688_gas_read()

uint8_t bme688_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_celsiusinput degree celsius
[in]gas_wait_msgas wait ms
[in]indexconvert index
[out]*temperaturepointer to a converted temperature buffer
[out]*pressurepointer to a converted pressure buffer
[out]*humidity_percentagepointer to a converted humidity percentage buffer
[out]*ohmspointer to an ohms buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 192 of file driver_bme688_gas.c.

Here is the call graph for this function:

◆ bme688_parallel_deinit()

uint8_t bme688_parallel_deinit ( void )

parallel example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 209 of file driver_bme688_parallel.c.

Here is the call graph for this function:

◆ bme688_parallel_init()

uint8_t bme688_parallel_init ( bme688_interface_t interface,
bme688_address_t addr_pin,
bme688_parallel_config_t * config,
void(* callback )(uint8_t status, bme688_parallel_data_t *data, uint8_t len) )

parallel example init

Parameters
[in]interfacechip interface
[in]addr_pinchip address pin
[in]*configpointer to a parallel config structure
[in]*callbackpointer to a callback address
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 52 of file driver_bme688_parallel.c.

Here is the call graph for this function:

◆ bme688_parallel_server()

uint8_t bme688_parallel_server ( void )

parallel example server

Returns
status code
  • 0 success
  • 1 server failed
Note
none

Definition at line 239 of file driver_bme688_parallel.c.

Here is the call graph for this function:

◆ bme688_parallel_server_reset()

uint8_t bme688_parallel_server_reset ( void )

parallel example server reset

Returns
status code
  • 0 success
  • 1 reset failed
Note
none

Definition at line 256 of file driver_bme688_parallel.c.

Here is the call graph for this function: