drivers_bme280.h

Go to the documentation of this file.

#pragma once
#include <runtime-hw/hw.h>
#include <stdbool.h>
#include <stdint.h>

// TYPES

typedef enum {
  DRIVER_BME280_OVERSAMPLING_NONE = 0, 
  DRIVER_BME280_OVERSAMPLING_1X = 1,   
  DRIVER_BME280_OVERSAMPLING_2X = 2,   
  DRIVER_BME280_OVERSAMPLING_4X = 3,   
  DRIVER_BME280_OVERSAMPLING_8X = 4,   
  DRIVER_BME280_OVERSAMPLING_16X = 5   
} driver_bme280_oversampling_t;

typedef enum {
  DRIVER_BME280_FILTER_OFF = 0, 
  DRIVER_BME280_FILTER_2 = 1,   
  DRIVER_BME280_FILTER_4 = 2,   
  DRIVER_BME280_FILTER_8 = 3,   
  DRIVER_BME280_FILTER_16 = 4   
} driver_bme280_filter_t;

typedef struct {
  float temperature; 
  float pressure;    
  float humidity;    
} driver_bme280_data_t;

typedef struct {
  hw_i2c_t i2c;          
  uint8_t addr;          
  uint8_t _reserved[64]; 
} driver_bme280_t;

// LIFECYCLE

bool driver_bme280_init_i2c(driver_bme280_t *driver, hw_i2c_t *i2c,
                            uint8_t addr_offset);

bool driver_bme280_init_i2c_with_config(driver_bme280_t *driver, hw_i2c_t *i2c,
                                        uint8_t addr_offset,
                                        driver_bme280_oversampling_t temp_os,
                                        driver_bme280_oversampling_t press_os,
                                        driver_bme280_oversampling_t hum_os,
                                        driver_bme280_filter_t filter);

bool driver_bme280_valid(driver_bme280_t *driver);

void driver_bme280_finalize(driver_bme280_t *driver);

// CONFIGURATION

void driver_bme280_set_temp_offset(driver_bme280_t *driver, float offset);

// DATA ACQUISITION

bool driver_bme280_read_data(driver_bme280_t *driver,
                             driver_bme280_data_t *data);

// UTILITY FUNCTIONS

float driver_bme280_calculate_altitude(const driver_bme280_data_t *data,
                                       float sea_level_pressure);

float driver_bme280_calculate_sea_level_pressure(
    const driver_bme280_data_t *data, float altitude);