driver_bme688.h

Go to the documentation of this file.

 
#ifndef DRIVER_BME688_H
#define DRIVER_BME688_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    BME688_BOOL_FALSE = 0x00,        
    BME688_BOOL_TRUE  = 0x01,        
} bme688_bool_t;

typedef enum
{
    BME688_INTERFACE_IIC = 0x00,        
    BME688_INTERFACE_SPI = 0x01,        
} bme688_interface_t;

typedef enum
{
    BME688_ADDRESS_ADO_LOW  = (0x76 << 1),        
    BME688_ADDRESS_ADO_HIGH = (0x77 << 1),        
} bme688_address_t;

typedef enum
{
    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_t;

typedef enum
{
    BME688_MODE_SLEEP    = 0x00,        
    BME688_MODE_FORCED   = 0x01,        
    BME688_MODE_PARALLEL = 0x02,        
} bme688_mode_t;

typedef enum
{
    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_t;

typedef enum
{
    BME688_SPI_WIRE_4 = 0x00,        
    BME688_SPI_WIRE_3 = 0x01,        
} bme688_spi_wire_t;

typedef enum
{
    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_t;

typedef enum
{
    BME688_SECTION_0 = 0x00,        
    BME688_SECTION_1 = 0x01,        
    BME688_SECTION_2 = 0x02,        
} bme688_section_t;

typedef enum
{
    BME688_STATUS_CHANNEL_DATA  = 0x00,        
    BME688_STATUS_ALL_DATA      = 0x01,        
    BME688_STATUS_SEQUENCE_LOST = 0x02,        
} bme688_status_t;

typedef struct bme688_parallel_data_s
{
    uint8_t channel;                  
    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;                       
} bme688_parallel_data_t;

typedef struct bme688_parallel_config_s
{
    const float *heater_temp_prof;         
    const uint8_t *heater_dur_prof;        
    uint8_t profile_len;                  
    float shared_heater_dur;               
} bme688_parallel_config_t;

typedef struct bme688_handle_s
{
    uint8_t iic_addr;                                                                   
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*spi_init)(void);                                                          
    uint8_t (*spi_deinit)(void);                                                        
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);                       
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);                      
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    void (*receive_callback)(uint8_t status, bme688_parallel_data_t *data, 
                             uint8_t len);                                              
    uint8_t inited;                                                                     
    uint8_t iic_spi;                                                                    
    uint8_t page;                                                                       
    uint16_t par_h1;                                                                    
    uint16_t par_h2;                                                                    
    int8_t par_h3;                                                                      
    int8_t par_h4;                                                                      
    int8_t par_h5;                                                                      
    uint8_t par_h6;                                                                     
    int8_t par_h7;                                                                      
    int8_t par_gh1;                                                                     
    int16_t par_gh2;                                                                    
    int8_t par_gh3;                                                                     
    uint16_t par_t1;                                                                    
    int16_t par_t2;                                                                     
    int8_t par_t3;                                                                      
    uint16_t par_p1;                                                                    
    int16_t par_p2;                                                                     
    int8_t par_p3;                                                                      
    int16_t par_p4;                                                                     
    int16_t par_p5;                                                                     
    int8_t par_p6;                                                                      
    int8_t par_p7;                                                                      
    int16_t par_p8;                                                                     
    int16_t par_p9;                                                                     
    uint8_t par_p10;                                                                    
    uint8_t res_heat_range;                                                             
    int8_t res_heat_val;                                                                
    int8_t range_sw_err;                                                                
    int8_t amb_temp;                                                                    
    float t_fine;                                                                       
    bme688_parallel_data_t parallel_data[10];                                           
    uint8_t parallel_sequence_number[3];                                                
    uint8_t parallel_sequence_trigger[3];                                               
    uint8_t parallel_data_len;                                                          
    uint16_t parallel_data_flag;                                                        
} bme688_handle_t;

typedef struct bme688_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} bme688_info_t;



#define DRIVER_BME688_LINK_INIT(HANDLE, STRUCTURE)          memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_BME688_LINK_IIC_INIT(HANDLE, FUC)           (HANDLE)->iic_init = FUC

#define DRIVER_BME688_LINK_IIC_DEINIT(HANDLE, FUC)         (HANDLE)->iic_deinit = FUC

#define DRIVER_BME688_LINK_IIC_READ(HANDLE, FUC)           (HANDLE)->iic_read = FUC

#define DRIVER_BME688_LINK_IIC_WRITE(HANDLE, FUC)          (HANDLE)->iic_write = FUC

#define DRIVER_BME688_LINK_SPI_INIT(HANDLE, FUC)           (HANDLE)->spi_init = FUC

#define DRIVER_BME688_LINK_SPI_DEINIT(HANDLE, FUC)         (HANDLE)->spi_deinit = FUC

#define DRIVER_BME688_LINK_SPI_READ(HANDLE, FUC)           (HANDLE)->spi_read = FUC

#define DRIVER_BME688_LINK_SPI_WRITE(HANDLE, FUC)          (HANDLE)->spi_write = FUC

#define DRIVER_BME688_LINK_DELAY_MS(HANDLE, FUC)           (HANDLE)->delay_ms = FUC

#define DRIVER_BME688_LINK_DEBUG_PRINT(HANDLE, FUC)        (HANDLE)->debug_print = FUC

#define DRIVER_BME688_LINK_RECEIVE_CALLBACK(HANDLE, FUC)   (HANDLE)->receive_callback = FUC



uint8_t bme688_info(bme688_info_t *info);

uint8_t bme688_set_interface(bme688_handle_t *handle, bme688_interface_t interface);

uint8_t bme688_get_interface(bme688_handle_t *handle, bme688_interface_t *interface);

uint8_t bme688_set_addr_pin(bme688_handle_t *handle, bme688_address_t addr_pin);

uint8_t bme688_get_addr_pin(bme688_handle_t *handle, bme688_address_t *addr_pin);

uint8_t bme688_init(bme688_handle_t *handle);

uint8_t bme688_deinit(bme688_handle_t *handle);

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);

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);

uint8_t bme688_read_pressure(bme688_handle_t *handle, bme688_section_t section, uint32_t *pressure_raw, float *pressure_pa);

uint8_t bme688_read_temperature(bme688_handle_t *handle, bme688_section_t section, uint32_t *temperature_raw, float *temperature_c);

uint8_t bme688_read_humidity(bme688_handle_t *handle, bme688_section_t section, uint32_t *humidity_raw, float *humidity_percentage);

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);

uint8_t bme688_parallel_progress(bme688_handle_t *handle);

uint8_t bme688_parallel_reset(bme688_handle_t *handle);

uint8_t bme688_parallel_config(bme688_handle_t *handle, bme688_parallel_config_t *config);

uint8_t bme688_get_new_data_status(bme688_handle_t *handle, bme688_section_t section, bme688_bool_t *enable);

uint8_t bme688_get_gas_measuring_status(bme688_handle_t *handle, bme688_section_t section, bme688_bool_t *enable);

uint8_t bme688_get_measuring_status(bme688_handle_t *handle, bme688_section_t section, bme688_bool_t *enable);

uint8_t bme688_get_gas_measuring_index(bme688_handle_t *handle, bme688_section_t section, uint8_t *index);

uint8_t bme688_get_gas_valid_status(bme688_handle_t *handle, bme688_section_t section, bme688_bool_t *enable);

uint8_t bme688_get_heater_stability_status(bme688_handle_t *handle, bme688_section_t section, bme688_bool_t *enable);

uint8_t bme688_get_sub_measurement_index(bme688_handle_t *handle, bme688_section_t section, uint8_t *ind);

uint8_t bme688_set_idac_heater(bme688_handle_t *handle, uint8_t index, uint8_t reg);

uint8_t bme688_get_idac_heater(bme688_handle_t *handle, uint8_t index, uint8_t *reg);

uint8_t bme688_set_resistance_heater(bme688_handle_t *handle, uint8_t index, uint8_t reg);

uint8_t bme688_get_resistance_heater(bme688_handle_t *handle, uint8_t index, uint8_t *reg);

uint8_t bme688_set_gas_wait(bme688_handle_t *handle, uint8_t index, uint8_t reg);

uint8_t bme688_get_gas_wait(bme688_handle_t *handle, uint8_t index, uint8_t *reg);

uint8_t bme688_set_gas_wait_shared(bme688_handle_t *handle, uint8_t reg);

uint8_t bme688_get_gas_wait_shared(bme688_handle_t *handle, uint8_t *reg);

uint8_t bme688_soft_reset(bme688_handle_t *handle);

uint8_t bme688_set_spi_wire_3_data_interrupt(bme688_handle_t *handle, bme688_bool_t enable);

uint8_t bme688_get_spi_wire_3_data_interrupt(bme688_handle_t *handle, bme688_bool_t *enable);

uint8_t bme688_set_humidity_oversampling(bme688_handle_t *handle, bme688_oversampling_t oversampling);

uint8_t bme688_get_humidity_oversampling(bme688_handle_t *handle, bme688_oversampling_t *oversampling);

uint8_t bme688_set_temperature_oversampling(bme688_handle_t *handle, bme688_oversampling_t oversampling);

uint8_t bme688_get_temperature_oversampling(bme688_handle_t *handle, bme688_oversampling_t *oversampling);

uint8_t bme688_set_pressure_oversampling(bme688_handle_t *handle, bme688_oversampling_t oversampling);

uint8_t bme688_get_pressure_oversampling(bme688_handle_t *handle, bme688_oversampling_t *oversampling);

uint8_t bme688_set_mode(bme688_handle_t *handle, bme688_mode_t mode);

uint8_t bme688_get_mode(bme688_handle_t *handle, bme688_mode_t *mode);

uint8_t bme688_set_filter(bme688_handle_t *handle, bme688_filter_t filter);

uint8_t bme688_get_filter(bme688_handle_t *handle, bme688_filter_t *filter);

uint8_t bme688_set_spi_wire(bme688_handle_t *handle, bme688_spi_wire_t spi);

uint8_t bme688_get_spi_wire(bme688_handle_t *handle, bme688_spi_wire_t *spi);

uint8_t bme688_set_heater_off(bme688_handle_t *handle, bme688_bool_t enable);

uint8_t bme688_get_heater_off(bme688_handle_t *handle, bme688_bool_t *enable);

uint8_t bme688_set_run_gas(bme688_handle_t *handle, bme688_bool_t enable);

uint8_t bme688_get_run_gas(bme688_handle_t *handle, bme688_bool_t *enable);

uint8_t bme688_set_heater_profile(bme688_handle_t *handle, bme688_heater_profile_t profile);

uint8_t bme688_get_heater_profile(bme688_handle_t *handle, bme688_heater_profile_t *profile);

uint8_t bme688_resistance_heater_convert_to_register(bme688_handle_t *handle, float degree_celsius, uint8_t *reg);

uint8_t bme688_idac_heater_convert_to_register(bme688_handle_t *handle, float ma, uint8_t *reg);

uint8_t bme688_idac_heater_convert_to_data(bme688_handle_t *handle, uint8_t reg, float *ma);

uint8_t bme688_gas_wait_convert_to_register(bme688_handle_t *handle, uint16_t ms, uint8_t *reg);

uint8_t bme688_gas_wait_shared_convert_to_register(bme688_handle_t *handle, float m, uint8_t *reg);



uint8_t bme688_set_reg(bme688_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t bme688_get_reg(bme688_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif