drivers_bme280.h

Go to the documentation of this file.

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

// TYPES

#define DRIVER_BME280_RESERVED_SIZE 96 


typedef struct driver_bme280_t {
  hw_i2c_t *i2c;       
  uint8_t address;     
  uint8_t timeout_ms;  
  uint8_t _padding[6]; 
  uint8_t reserved[DRIVER_BME280_RESERVED_SIZE]
      __attribute__((aligned(8))); 
} driver_bme280_t;

typedef enum {
  DRIVER_BME280_MODE_SLEEP = 1, 
  DRIVER_BME280_MODE_FORCED,    
  DRIVER_BME280_MODE_NORMAL     
} driver_bme280_mode_t;

// LIFECYCLE

driver_bme280_t driver_bme280_i2c_init(hw_i2c_t *i2c, uint8_t address);

void driver_bme280_finalize(driver_bme280_t *bme280);

// PROPERTIES

static inline bool driver_bme280_valid(driver_bme280_t *bme280) {
  return bme280 && bme280->i2c && hw_i2c_valid(bme280->i2c) && bme280->address;
}

bool driver_bme280_set_mode(driver_bme280_t *bme280, driver_bme280_mode_t mode);

driver_bme280_mode_t driver_bme280_get_mode(driver_bme280_t *bme280);

// METHODS

bool driver_bme280_reset(driver_bme280_t *bme280);

bool driver_bme280_read_data(driver_bme280_t *bme280, float *temperature,
                             float *pressure, float *humidity);

float driver_bme280_read_temperature(driver_bme280_t *bme280);

float driver_bme280_read_pressure(driver_bme280_t *bme280);

float driver_bme280_read_humidity(driver_bme280_t *bme280);

float driver_bme280_calculate_altitude(float pressure_pa, float sea_level_pa);

float driver_bme280_calculate_sea_level_pressure(float pressure_pa,
                                                 float altitude_m);

// Default sea level pressure constant
#define DRIVER_BME280_SEA_LEVEL_PRESSURE_PA                                    \
  101325.0f