driver bme688 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_bme688.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	bme688_parallel_data_s
	bme688 parallel data structure definition More...
struct	bme688_parallel_config_s
	bme688 parallel config structure definition More...
struct	bme688_handle_s
	bme688 handle structure definition More...
struct	bme688_info_s
	bme688 information structure definition More...

Macros
#define	DRIVER_BME688_LINK_INIT(HANDLE, STRUCTURE)
	initialize bme688_handle_t structure
#define	DRIVER_BME688_LINK_IIC_INIT(HANDLE, FUC)
	link iic_init function
#define	DRIVER_BME688_LINK_IIC_DEINIT(HANDLE, FUC)
	link iic_deinit function
#define	DRIVER_BME688_LINK_IIC_READ(HANDLE, FUC)
	link iic_read function
#define	DRIVER_BME688_LINK_IIC_WRITE(HANDLE, FUC)
	link iic_write function
#define	DRIVER_BME688_LINK_SPI_INIT(HANDLE, FUC)
	link spi_init function
#define	DRIVER_BME688_LINK_SPI_DEINIT(HANDLE, FUC)
	link spi_deinit function
#define	DRIVER_BME688_LINK_SPI_READ(HANDLE, FUC)
	link spi_read function
#define	DRIVER_BME688_LINK_SPI_WRITE(HANDLE, FUC)
	link spi_write function
#define	DRIVER_BME688_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_BME688_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function
#define	DRIVER_BME688_LINK_RECEIVE_CALLBACK(HANDLE, FUC)
	link receive_callback function

Typedefs
typedef struct bme688_parallel_data_s	bme688_parallel_data_t
	bme688 parallel data structure definition
typedef struct bme688_parallel_config_s	bme688_parallel_config_t
	bme688 parallel config structure definition
typedef struct bme688_handle_s	bme688_handle_t
	bme688 handle structure definition
typedef struct bme688_info_s	bme688_info_t
	bme688 information structure definition

Enumerations
enum	bme688_bool_t { BME688_BOOL_FALSE = 0x00 , BME688_BOOL_TRUE = 0x01 }
	bme688 bool enumeration definition More...
enum	bme688_interface_t { BME688_INTERFACE_IIC = 0x00 , BME688_INTERFACE_SPI = 0x01 }
	bme688 interface enumeration definition More...
enum	bme688_address_t { BME688_ADDRESS_ADO_LOW = (0x76 << 1) , BME688_ADDRESS_ADO_HIGH = (0x77 << 1) }
	bme688 address enumeration definition More...
enum	bme688_oversampling_t { BME688_OVERSAMPLING_SKIP = 0x00 , BME688_OVERSAMPLING_x1 = 0x01 , BME688_OVERSAMPLING_x2 = 0x02 , BME688_OVERSAMPLING_x4 = 0x03 , BME688_OVERSAMPLING_x8 = 0x04 , BME688_OVERSAMPLING_x16 = 0x05 }
	bme688 oversampling enumeration definition More...
enum	bme688_mode_t { BME688_MODE_SLEEP = 0x00 , BME688_MODE_FORCED = 0x01 , BME688_MODE_PARALLEL = 0x02 }
	bme688 mode enumeration definition More...
enum	bme688_filter_t { BME688_FILTER_OFF = 0x00 , BME688_FILTER_COEFF_1 = 0x01 , BME688_FILTER_COEFF_3 = 0x02 , BME688_FILTER_COEFF_7 = 0x03 , BME688_FILTER_COEFF_15 = 0x04 , BME688_FILTER_COEFF_31 = 0x05 , BME688_FILTER_COEFF_63 = 0x06 , BME688_FILTER_COEFF_127 = 0x07 }
	bme688 filter enumeration definition More...
enum	bme688_spi_wire_t { BME688_SPI_WIRE_4 = 0x00 , BME688_SPI_WIRE_3 = 0x01 }
	bme688 spi wire enumeration definition More...
enum	bme688_heater_profile_t { BME688_HEATER_PROFILE_FORCED_STEP_0_PARALLEL_NO_STEP = 0x00 , BME688_HEATER_PROFILE_FORCED_STEP_1_PARALLEL_STEP_0 = 0x01 , BME688_HEATER_PROFILE_FORCED_STEP_2_PARALLEL_STEP_0_1 = 0x02 , BME688_HEATER_PROFILE_FORCED_STEP_3_PARALLEL_STEP_0_2 = 0x03 , BME688_HEATER_PROFILE_FORCED_STEP_4_PARALLEL_STEP_0_3 = 0x04 , BME688_HEATER_PROFILE_FORCED_STEP_5_PARALLEL_STEP_0_4 = 0x05 , BME688_HEATER_PROFILE_FORCED_STEP_6_PARALLEL_STEP_0_5 = 0x06 , BME688_HEATER_PROFILE_FORCED_STEP_7_PARALLEL_STEP_0_6 = 0x07 , BME688_HEATER_PROFILE_FORCED_STEP_8_PARALLEL_STEP_0_7 = 0x08 , BME688_HEATER_PROFILE_FORCED_STEP_9_PARALLEL_STEP_0_8 = 0x09 , BME688_HEATER_PROFILE_FORCED_NO_STEP_PARALLEL_STEP_0_9 = 0x0A }
	bme688 heater profile enumeration definition More...
enum	bme688_section_t { BME688_SECTION_0 = 0x00 , BME688_SECTION_1 = 0x01 , BME688_SECTION_2 = 0x02 }
	bme688 section enumeration definition More...
enum	bme688_status_t { BME688_STATUS_CHANNEL_DATA = 0x00 , BME688_STATUS_ALL_DATA = 0x01 , BME688_STATUS_SEQUENCE_LOST = 0x02 }
	bme688 status enumeration definition More...

Functions
uint8_t	bme688_info (bme688_info_t *info)
	get chip's information
uint8_t	bme688_set_interface (bme688_handle_t *handle, bme688_interface_t interface)
	set the interface
uint8_t	bme688_get_interface (bme688_handle_t handle, bme688_interface_t interface)
	get the interface
uint8_t	bme688_set_addr_pin (bme688_handle_t *handle, bme688_address_t addr_pin)
	set the iic address pin
uint8_t	bme688_get_addr_pin (bme688_handle_t handle, bme688_address_t addr_pin)
	get the iic address pin
uint8_t	bme688_init (bme688_handle_t *handle)
	initialize the chip
uint8_t	bme688_deinit (bme688_handle_t *handle)
	close the chip
uint8_t	bme688_read (bme688_handle_t handle, bme688_section_t section, uint32_t temperature_raw, float temperature_c, uint32_t pressure_raw, float pressure_pa, uint32_t humidity_raw, float humidity_percentage, uint16_t adc_raw, uint8_t adc_range, float ohms, uint8_t *index)
	read the temperature pressure humidity and gas resistance
uint8_t	bme688_read_temperature_pressure_humidity (bme688_handle_t handle, bme688_section_t section, uint32_t temperature_raw, float temperature_c, uint32_t pressure_raw, float pressure_pa, uint32_t humidity_raw, float *humidity_percentage)
	read the temperature pressure and humidity data
uint8_t	bme688_read_pressure (bme688_handle_t handle, bme688_section_t section, uint32_t pressure_raw, float *pressure_pa)
	read the pressure data
uint8_t	bme688_read_temperature (bme688_handle_t handle, bme688_section_t section, uint32_t temperature_raw, float *temperature_c)
	read the temperature data
uint8_t	bme688_read_humidity (bme688_handle_t handle, bme688_section_t section, uint32_t humidity_raw, float *humidity_percentage)
	read the humidity data
uint8_t	bme688_read_gas_resistance (bme688_handle_t handle, bme688_section_t section, uint16_t adc_raw, uint8_t adc_range, float ohms, uint8_t *index)
	read the gas resistance
uint8_t	bme688_parallel_progress (bme688_handle_t *handle)
	parallel progress
uint8_t	bme688_parallel_reset (bme688_handle_t *handle)
	parallel reset
uint8_t	bme688_parallel_config (bme688_handle_t handle, bme688_parallel_config_t config)
	parallel config
uint8_t	bme688_get_new_data_status (bme688_handle_t handle, bme688_section_t section, bme688_bool_t enable)
	get new data status
uint8_t	bme688_get_gas_measuring_status (bme688_handle_t handle, bme688_section_t section, bme688_bool_t enable)
	get gas measuring status
uint8_t	bme688_get_measuring_status (bme688_handle_t handle, bme688_section_t section, bme688_bool_t enable)
	get measuring status
uint8_t	bme688_get_gas_measuring_index (bme688_handle_t handle, bme688_section_t section, uint8_t index)
	get gas measuring index
uint8_t	bme688_get_gas_valid_status (bme688_handle_t handle, bme688_section_t section, bme688_bool_t enable)
	get gas valid status
uint8_t	bme688_get_heater_stability_status (bme688_handle_t handle, bme688_section_t section, bme688_bool_t enable)
	get heater stability status
uint8_t	bme688_get_sub_measurement_index (bme688_handle_t handle, bme688_section_t section, uint8_t ind)
	get sub measurement index
uint8_t	bme688_set_idac_heater (bme688_handle_t *handle, uint8_t index, uint8_t reg)
	set idac heater
uint8_t	bme688_get_idac_heater (bme688_handle_t handle, uint8_t index, uint8_t reg)
	get idac heater
uint8_t	bme688_set_resistance_heater (bme688_handle_t *handle, uint8_t index, uint8_t reg)
	set resistance heater
uint8_t	bme688_get_resistance_heater (bme688_handle_t handle, uint8_t index, uint8_t reg)
	get resistance heater
uint8_t	bme688_set_gas_wait (bme688_handle_t *handle, uint8_t index, uint8_t reg)
	set gas wait
uint8_t	bme688_get_gas_wait (bme688_handle_t handle, uint8_t index, uint8_t reg)
	get gas wait
uint8_t	bme688_set_gas_wait_shared (bme688_handle_t *handle, uint8_t reg)
	set gas wait shared
uint8_t	bme688_get_gas_wait_shared (bme688_handle_t handle, uint8_t reg)
	get gas wait shared
uint8_t	bme688_soft_reset (bme688_handle_t *handle)
	soft reset
uint8_t	bme688_set_spi_wire_3_data_interrupt (bme688_handle_t *handle, bme688_bool_t enable)
	enable or disable spi wire3 data interrupt
uint8_t	bme688_get_spi_wire_3_data_interrupt (bme688_handle_t handle, bme688_bool_t enable)
	get spi wire3 data interrupt status
uint8_t	bme688_set_humidity_oversampling (bme688_handle_t *handle, bme688_oversampling_t oversampling)
	set humidity oversampling
uint8_t	bme688_get_humidity_oversampling (bme688_handle_t handle, bme688_oversampling_t oversampling)
	get humidity oversampling
uint8_t	bme688_set_temperature_oversampling (bme688_handle_t *handle, bme688_oversampling_t oversampling)
	set temperature oversampling
uint8_t	bme688_get_temperature_oversampling (bme688_handle_t handle, bme688_oversampling_t oversampling)
	get temperature oversampling
uint8_t	bme688_set_pressure_oversampling (bme688_handle_t *handle, bme688_oversampling_t oversampling)
	set pressure oversampling
uint8_t	bme688_get_pressure_oversampling (bme688_handle_t handle, bme688_oversampling_t oversampling)
	get pressure oversampling
uint8_t	bme688_set_mode (bme688_handle_t *handle, bme688_mode_t mode)
	set mode
uint8_t	bme688_get_mode (bme688_handle_t handle, bme688_mode_t mode)
	get mode
uint8_t	bme688_set_filter (bme688_handle_t *handle, bme688_filter_t filter)
	set filter
uint8_t	bme688_get_filter (bme688_handle_t handle, bme688_filter_t filter)
	get filter
uint8_t	bme688_set_spi_wire (bme688_handle_t *handle, bme688_spi_wire_t spi)
	set spi wire
uint8_t	bme688_get_spi_wire (bme688_handle_t handle, bme688_spi_wire_t spi)
	get spi wire
uint8_t	bme688_set_heater_off (bme688_handle_t *handle, bme688_bool_t enable)
	enable or disable heater off
uint8_t	bme688_get_heater_off (bme688_handle_t handle, bme688_bool_t enable)
	get heater off status
uint8_t	bme688_set_run_gas (bme688_handle_t *handle, bme688_bool_t enable)
	enable or disable run gas
uint8_t	bme688_get_run_gas (bme688_handle_t handle, bme688_bool_t enable)
	get run gas status
uint8_t	bme688_set_heater_profile (bme688_handle_t *handle, bme688_heater_profile_t profile)
	set heater profile
uint8_t	bme688_get_heater_profile (bme688_handle_t handle, bme688_heater_profile_t profile)
	get heater profile
uint8_t	bme688_resistance_heater_convert_to_register (bme688_handle_t handle, float degree_celsius, uint8_t reg)
	convert the resistance heater to the register raw data
uint8_t	bme688_idac_heater_convert_to_register (bme688_handle_t handle, float ma, uint8_t reg)
	convert the idac heater to the register raw data
uint8_t	bme688_idac_heater_convert_to_data (bme688_handle_t handle, uint8_t reg, float ma)
	convert the register raw data to idac heater
uint8_t	bme688_gas_wait_convert_to_register (bme688_handle_t handle, uint16_t ms, uint8_t reg)
	convert the gas wait to the register raw data
uint8_t	bme688_gas_wait_shared_convert_to_register (bme688_handle_t handle, float m, uint8_t reg)
	convert the gas wait shared to the register raw data
uint8_t	bme688_set_reg (bme688_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	set the chip register
uint8_t	bme688_get_reg (bme688_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	get the chip register

Detailed Description

driver bme688 header file

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version: 1.0.0

Author: Shifeng Li

Date: 2026-03-15

history

Date	Version	Author	Description
2026/03/15	1.0	Shifeng Li	first upload

Definition in file driver_bme688.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

history