bmx280.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Kees Bakker, SODAQ
 * SPDX-FileCopyrightText: 2017 Inria
 * SPDX-FileCopyrightText: 2018 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include "saul.h"
 
#if defined(MODULE_BME280_SPI) || defined(MODULE_BMP280_SPI)
#define BMX280_USE_SPI
#include "periph/spi.h"
#else
#include "periph/i2c.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

#if defined(MODULE_BME280_SPI) || defined(MODULE_BME280_I2C)
#define BMX280_RAW_LEN      (8U)
#else
#define BMX280_RAW_LEN      (6U)
#endif

typedef struct {
    uint16_t dig_T1;    
    int16_t dig_T2;     
    int16_t dig_T3;     
 
    uint16_t dig_P1;    
    int16_t dig_P2;     
    int16_t dig_P3;     
    int16_t dig_P4;     
    int16_t dig_P5;     
    int16_t dig_P6;     
    int16_t dig_P7;     
    int16_t dig_P8;     
    int16_t dig_P9;     
 
    uint8_t dig_H1;     
    int16_t dig_H2;     
    uint8_t dig_H3;     
    int16_t dig_H4;     
    int16_t dig_H5;     
    int8_t dig_H6;      
} bmx280_calibration_t;

typedef enum {
    BMX280_SB_0_5  = 0x00,
    BMX280_SB_62_5 = 0x20,
    BMX280_SB_125  = 0x40,
    BMX280_SB_250  = 0x60,
    BMX280_SB_500  = 0x80,
    BMX280_SB_1000 = 0xa0,
    BMX280_SB_10   = 0xc0,
    BMX280_SB_20   = 0xe0,
} bmx280_t_sb_t;

typedef enum {
    BMX280_FILTER_OFF = 0x00,
    BMX280_FILTER_2   = 0x04,
    BMX280_FILTER_4   = 0x08,
    BMX280_FILTER_8   = 0x0c,
    BMX280_FILTER_16  = 0x10,
} bmx280_filter_t;

typedef enum {
    BMX280_MODE_SLEEP  = 0x00,
    BMX280_MODE_FORCED = 0x01,
    BMX280_MODE_NORMAL = 0x03,
} bmx280_mode_t;

typedef enum {
    BMX280_OSRS_SKIPPED = 0x00,
    BMX280_OSRS_X1      = 0x01,
    BMX280_OSRS_X2      = 0x02,
    BMX280_OSRS_X4      = 0x03,
    BMX280_OSRS_X8      = 0x04,
    BMX280_OSRS_X16     = 0x05,
} bmx280_osrs_t;

typedef struct {
#ifdef BMX280_USE_SPI
    /* SPI configuration */
    spi_t spi;                          
    spi_clk_t clk;                      
    gpio_t cs;                          
#else
    /* I2C details */
    i2c_t i2c_dev;                      
    uint8_t i2c_addr;                   
#endif
 
    /* Config Register */
    bmx280_t_sb_t t_sb;                 
    bmx280_filter_t filter;             
 
    /* ctrl_meas */
    bmx280_mode_t run_mode;             
    bmx280_osrs_t temp_oversample;      
    bmx280_osrs_t press_oversample;     
 
    /* ctrl_hum */
    bmx280_osrs_t humid_oversample;     
} bmx280_params_t;

typedef struct {
    bmx280_params_t params;             
    bmx280_calibration_t calibration;   
    int32_t t_fine;                     
    uint8_t last_reading[BMX280_RAW_LEN];   
} bmx280_t;

enum {
    BMX280_OK           =  0,     
    BMX280_ERR_BUS      = -1,     
    BMX280_ERR_NODEV    = -2,     
};

extern const saul_driver_t bmx280_temperature_saul_driver;

extern const saul_driver_t bmx280_pressure_saul_driver;
 
#if defined(MODULE_BME280_SPI) || defined(MODULE_BME280_I2C)
extern const saul_driver_t bme280_relative_humidity_saul_driver;
#endif

int bmx280_init(bmx280_t* dev, const bmx280_params_t* params);

int16_t bmx280_read_temperature(bmx280_t* dev);

uint32_t bmx280_read_pressure(bmx280_t *dev);
 
#if defined(MODULE_BME280_SPI) || defined(MODULE_BME280_I2C) || defined(DOXYGEN)
uint16_t bme280_read_humidity(bmx280_t *dev);
#endif
 
#ifdef __cplusplus
}
#endif