bme680.h

Go to the documentation of this file.

#pragma once

#include <picofuse/hw.h>
#include <stdbool.h>
#include <stdint.h>

// CONSTANTS

#define DEV_BME680_I2C_ADDR_PRIMARY 0x76

#define DEV_BME680_I2C_ADDR_SECONDARY 0x77

#define DEV_BME680_CHIP_ID 0x61

#define DEV_BME680_REG_CHIP_ID 0xD0u

#define DEV_BME680_REG_VARIANT_ID 0xF0u

#define DEV_BME680_REG_SOFT_RESET 0xE0u

#define DEV_BME680_REG_FIELD0 0x1Du

#define DEV_BME680_REG_RES_HEAT0 0x5Au

#define DEV_BME680_REG_GAS_WAIT0 0x64u

#define DEV_BME680_REG_CTRL_GAS_0 0x70u

#define DEV_BME680_REG_CTRL_GAS_1 0x71u

#define DEV_BME680_REG_CTRL_HUM 0x72u

#define DEV_BME680_REG_CTRL_MEAS 0x74u

#define DEV_BME680_REG_CONFIG 0x75u

#define DEV_BME680_REG_COEFF1 0x8Au

#define DEV_BME680_REG_COEFF2 0xE1u

#define DEV_BME680_REG_COEFF3 0x00u

#define DEV_BME680_SOFT_RESET_CMD 0xB6u

#define DEV_BME680_VARIANT_GAS_LOW 0x00u

#define DEV_BME680_VARIANT_GAS_HIGH 0x01u

// TYPES

typedef struct dev_bme680_t dev_bme680_t;

typedef enum {
  dev_bme680_oversampling_skip = 0,
  dev_bme680_oversampling_1x = 1,
  dev_bme680_oversampling_2x = 2,
  dev_bme680_oversampling_4x = 3,
  dev_bme680_oversampling_8x = 4,
  dev_bme680_oversampling_16x = 5,
} dev_bme680_oversampling_t;

typedef enum {
  dev_bme680_iir_filter_off = 0,
  dev_bme680_iir_filter_1 = 1,
  dev_bme680_iir_filter_3 = 2,
  dev_bme680_iir_filter_7 = 3,
  dev_bme680_iir_filter_15 = 4,
  dev_bme680_iir_filter_31 = 5,
  dev_bme680_iir_filter_63 = 6,
  dev_bme680_iir_filter_127 = 7,
} dev_bme680_iir_filter_t;

typedef enum {
  dev_bme680_heater_temp_200c = 200,
  dev_bme680_heater_temp_250c = 250,
  dev_bme680_heater_temp_300c = 300,
  dev_bme680_heater_temp_320c = 320,
  dev_bme680_heater_temp_350c = 350,
  dev_bme680_heater_temp_400c = 400,
} dev_bme680_heater_temp_t;

typedef enum {
  dev_bme680_heater_dur_50ms = 50,
  dev_bme680_heater_dur_100ms = 100,
  dev_bme680_heater_dur_120ms = 120,
  dev_bme680_heater_dur_150ms = 150,
  dev_bme680_heater_dur_200ms = 200,
} dev_bme680_heater_duration_t;

typedef enum {
  dev_bme680_ambient_temp_0c = 0,
  dev_bme680_ambient_temp_10c = 10,
  dev_bme680_ambient_temp_20c = 20,
  dev_bme680_ambient_temp_25c = 25,
  dev_bme680_ambient_temp_30c = 30,
  dev_bme680_ambient_temp_35c = 35,
  dev_bme680_ambient_temp_40c = 40,
} dev_bme680_ambient_temp_t;

typedef enum {
  dev_bme680_gas_disabled = 0,
  dev_bme680_gas_enabled = 1,
} dev_bme680_gas_mode_t;

typedef struct {
  float temperature_c;       
  float pressure_pa;         
  float humidity_pct;        
  float gas_resistance_ohms; 
} dev_bme680_data_t;

typedef struct {
  dev_bme680_oversampling_t os_temp;   
  dev_bme680_oversampling_t os_press;  
  dev_bme680_oversampling_t os_hum;    
  dev_bme680_iir_filter_t iir_filter;  
  dev_bme680_heater_temp_t heater_temp_c;      
  dev_bme680_heater_duration_t heater_duration_ms; 
  dev_bme680_ambient_temp_t ambient_temp_c; 
  dev_bme680_gas_mode_t gas_mode; 
} dev_bme680_config_t;

// LIFECYCLE

void dev_bme680_default_config(dev_bme680_config_t *config);

dev_bme680_t *dev_bme680_init(hw_deviceio_t *device,
                              const dev_bme680_config_t *config);

void dev_bme680_deinit(dev_bme680_t *bme680);

// PROPERTIES

uint8_t dev_bme680_chip_id(const dev_bme680_t *bme680);

uint32_t dev_bme680_measurement_duration_ms(const dev_bme680_config_t *config);

// METHODS

bool dev_bme680_read(dev_bme680_t *bme680, dev_bme680_data_t *data);