driver_bme680.h

Go to the documentation of this file.

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



typedef enum
{
    BME680_BOOL_FALSE = 0x00,        
    BME680_BOOL_TRUE  = 0x01,        
} bme680_bool_t;

typedef enum
{
    BME680_INTERFACE_IIC = 0x00,        
    BME680_INTERFACE_SPI = 0x01,        
} bme680_interface_t;

typedef enum
{
    BME680_ADDRESS_ADO_LOW  = (0x76 << 1),        
    BME680_ADDRESS_ADO_HIGH = (0x77 << 1),        
} bme680_address_t;

typedef enum
{
    BME680_OVERSAMPLING_SKIP = 0x00,        
    BME680_OVERSAMPLING_x1   = 0x01,        
    BME680_OVERSAMPLING_x2   = 0x02,        
    BME680_OVERSAMPLING_x4   = 0x03,        
    BME680_OVERSAMPLING_x8   = 0x04,        
    BME680_OVERSAMPLING_x16  = 0x05,        
} bme680_oversampling_t;

typedef enum
{
    BME680_MODE_SLEEP  = 0x00,        
    BME680_MODE_FORCED = 0x01,        
} bme680_mode_t;

typedef enum
{
    BME680_FILTER_OFF       = 0x00,        
    BME680_FILTER_COEFF_1   = 0x01,        
    BME680_FILTER_COEFF_3   = 0x02,        
    BME680_FILTER_COEFF_7   = 0x03,        
    BME680_FILTER_COEFF_15  = 0x04,        
    BME680_FILTER_COEFF_31  = 0x05,        
    BME680_FILTER_COEFF_63  = 0x06,        
    BME680_FILTER_COEFF_127 = 0x07,        
} bme680_filter_t;

typedef enum
{
    BME680_SPI_WIRE_4 = 0x00,        
    BME680_SPI_WIRE_3 = 0x01,        
} bme680_spi_wire_t;

typedef struct bme680_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, ...);                                    
    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;                                                                       
} bme680_handle_t;

typedef struct bme680_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;           
} bme680_info_t;



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

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

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

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

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

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

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

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

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

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

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



uint8_t bme680_info(bme680_info_t *info);

uint8_t bme680_set_interface(bme680_handle_t *handle, bme680_interface_t interface);

uint8_t bme680_get_interface(bme680_handle_t *handle, bme680_interface_t *interface);

uint8_t bme680_set_addr_pin(bme680_handle_t *handle, bme680_address_t addr_pin);

uint8_t bme680_get_addr_pin(bme680_handle_t *handle, bme680_address_t *addr_pin);

uint8_t bme680_init(bme680_handle_t *handle);

uint8_t bme680_deinit(bme680_handle_t *handle);

uint8_t bme680_read(bme680_handle_t *handle, 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 bme680_read_temperature_pressure_humidity(bme680_handle_t *handle, uint32_t *temperature_raw, float *temperature_c,
                                                  uint32_t *pressure_raw, float *pressure_pa,
                                                  uint32_t *humidity_raw, float *humidity_percentage);

uint8_t bme680_read_pressure(bme680_handle_t *handle, uint32_t *pressure_raw, float *pressure_pa);

uint8_t bme680_read_temperature(bme680_handle_t *handle, uint32_t *temperature_raw, float *temperature_c);

uint8_t bme680_read_humidity(bme680_handle_t *handle, uint32_t *humidity_raw, float *humidity_percentage);

uint8_t bme680_read_gas_resistance(bme680_handle_t *handle, uint16_t *adc_raw, uint8_t *adc_range, float *ohms, uint8_t *index);

uint8_t bme680_soft_reset(bme680_handle_t *handle);

uint8_t bme680_set_humidity_oversampling(bme680_handle_t *handle, bme680_oversampling_t oversampling);

uint8_t bme680_get_humidity_oversampling(bme680_handle_t *handle, bme680_oversampling_t *oversampling);

uint8_t bme680_set_temperature_oversampling(bme680_handle_t *handle, bme680_oversampling_t oversampling);

uint8_t bme680_get_temperature_oversampling(bme680_handle_t *handle, bme680_oversampling_t *oversampling);

uint8_t bme680_set_pressure_oversampling(bme680_handle_t *handle, bme680_oversampling_t oversampling);

uint8_t bme680_get_pressure_oversampling(bme680_handle_t *handle, bme680_oversampling_t *oversampling);

uint8_t bme680_set_mode(bme680_handle_t *handle, bme680_mode_t mode);

uint8_t bme680_get_mode(bme680_handle_t *handle, bme680_mode_t *mode);

uint8_t bme680_set_filter(bme680_handle_t *handle, bme680_filter_t filter);

uint8_t bme680_get_filter(bme680_handle_t *handle, bme680_filter_t *filter);

uint8_t bme680_set_spi_wire(bme680_handle_t *handle, bme680_spi_wire_t spi);

uint8_t bme680_get_spi_wire(bme680_handle_t *handle, bme680_spi_wire_t *spi);

uint8_t bme680_set_spi_wire_3_data_interrupt(bme680_handle_t *handle, bme680_bool_t enable);

uint8_t bme680_get_spi_wire_3_data_interrupt(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_get_new_data_status(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_get_gas_measuring_status(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_get_measuring_status(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_get_gas_measuring_index(bme680_handle_t *handle, uint8_t *index);

uint8_t bme680_get_gas_valid_status(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_get_heater_stability_status(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_set_heat_off(bme680_handle_t *handle, bme680_bool_t enable);

uint8_t bme680_get_heat_off(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_set_run_gas(bme680_handle_t *handle, bme680_bool_t enable);

uint8_t bme680_get_run_gas(bme680_handle_t *handle, bme680_bool_t *enable);

uint8_t bme680_set_convert_index(bme680_handle_t *handle, uint8_t index);

uint8_t bme680_get_convert_index(bme680_handle_t *handle, uint8_t *index);

uint8_t bme680_set_idac_heat(bme680_handle_t *handle, uint8_t index, uint8_t reg);

uint8_t bme680_get_idac_heat(bme680_handle_t *handle, uint8_t index, uint8_t *reg);

uint8_t bme680_set_resistance_heat(bme680_handle_t *handle, uint8_t index, uint8_t reg);

uint8_t bme680_get_resistance_heat(bme680_handle_t *handle, uint8_t index, uint8_t *reg);

uint8_t bme680_set_gas_wait(bme680_handle_t *handle, uint8_t index, uint8_t reg);

uint8_t bme680_get_gas_wait(bme680_handle_t *handle, uint8_t index, uint8_t *reg);

uint8_t bme680_resistance_heat_convert_to_register(bme680_handle_t *handle, float degree_celsius, uint8_t *reg);

uint8_t bme680_gas_wait_convert_to_register(bme680_handle_t *handle, uint16_t ms, uint8_t *reg);

uint8_t bme680_idac_heat_convert_to_register(bme680_handle_t *handle, float ma, uint8_t *reg);

uint8_t bme680_idac_heat_convert_to_data(bme680_handle_t *handle, uint8_t reg, float *ma);



uint8_t bme680_set_reg(bme680_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t bme680_get_reg(bme680_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif