barometer3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
 
// ----------------------------------------------------------------------------
 
#ifndef BAROMETER3_H
#define BAROMETER3_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define BAROMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.scl   = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
   cfg.sda   = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ) 
#define BAROMETER3_MASTER_I2C 0
#define BAROMETER3_MASTER_SPI 1
#define BAROMETER3_RETVAL  uint8_t
 
#define BAROMETER3_OK           0x00
#define BAROMETER3_INIT_ERROR   0xFF
#define BAROMETER3_I2C_SLV_ADR_GND          0x76
#define BAROMETER3_I2C_SLV_ADR_VCC          0x77
#define BAROMETER3_READ_BIT_MASK            0x80
#define BAROMETER3_WRITE_BIT_MASK           0x7F
#define BAROMETER3_PSR_B2                   0x00
#define BAROMETER3_PSR_B1                   0x01
#define BAROMETER3_PSR_B0                   0x02
#define BAROMETER3_TMP_B2                   0x03
#define BAROMETER3_TMP_B1                   0x04
#define BAROMETER3_TMP_B0                   0x05
#define BAROMETER3_PRS_CFG                  0x06
#define BAROMETER3_TMP_CFG                  0x07
#define BAROMETER3_MEAS_CFG                 0x08
#define BAROMETER3_CFG_REG                  0x09
#define BAROMETER3_INT_STS                  0x0A
#define BAROMETER3_FIFO_STS                 0x0B
#define BAROMETER3_RESET                    0x0C
#define BAROMETER3_PROD_ID                  0x0D
#define BAROMETER3_COEF_C0                  0x10
#define BAROMETER3_COEF_C0_C1               0x11
#define BAROMETER3_COEF_C1                  0x12
#define BAROMETER3_COEF_C00_MSB             0x13
#define BAROMETER3_COEF_C00_LSB             0x14
#define BAROMETER3_COEF_C00_C10             0x15
#define BAROMETER3_COEF_C10_MSB             0x16
#define BAROMETER3_COEF_C10_LSB             0x17
#define BAROMETER3_COEF_C01_MSB             0x18
#define BAROMETER3_COEF_C01_LSB             0x19
#define BAROMETER3_COEF_C11_MSB             0x1A
#define BAROMETER3_COEF_C11_LSB             0x1B
#define BAROMETER3_COEF_C20_MSB             0x1C
#define BAROMETER3_COEF_C20_LSB             0x1D
#define BAROMETER3_COEF_C21_MSB             0x1E
#define BAROMETER3_COEF_C21_LSB             0x1F
#define BAROMETER3_COEF_C30_MSB             0x20
#define BAROMETER3_COEF_C30_LSB             0x21
#define BAROMETER3_COEF_SRCE                0x28
#define BAROMETER3_PM_RATE_1                0x00
#define BAROMETER3_PM_RATE_2                0x10
#define BAROMETER3_PM_RATE_4                0x20
#define BAROMETER3_PM_RATE_8                0x30
#define BAROMETER3_PM_RATE_16               0x40
#define BAROMETER3_PM_RATE_32               0x50
#define BAROMETER3_PM_RATE_64               0x60
#define BAROMETER3_PM_RATE_128              0x70
#define BAROMETER3_PM_PRC_1                 0x00
#define BAROMETER3_PM_PRC_2                 0x01
#define BAROMETER3_PM_PRC_4                 0x02
#define BAROMETER3_PM_PRC_8                 0x03
#define BAROMETER3_PM_PRC_16                0x04
#define BAROMETER3_PM_PRC_32                0x05
#define BAROMETER3_PM_PRC_64                0x06
#define BAROMETER3_PM_PRC_128               0x07
#define BAROMETER3_TMP_INT                  0x00
#define BAROMETER3_TMP_EXT                  0x80
#define BAROMETER3_TMP_RATE_1               0x00
#define BAROMETER3_TMP_RATE_2               0x10
#define BAROMETER3_TMP_RATE_4               0x20
#define BAROMETER3_TMP_RATE_8               0x30
#define BAROMETER3_TMP_RATE_16              0x40
#define BAROMETER3_TMP_RATE_32              0x50
#define BAROMETER3_TMP_RATE_64              0x60
#define BAROMETER3_TMP_RATE_128             0x70
#define BAROMETER3_TMP_PRC_1                0x00
#define BAROMETER3_TMP_PRC_2                0x01
#define BAROMETER3_TMP_PRC_4                0x02
#define BAROMETER3_TMP_PRC_8                0x03
#define BAROMETER3_TMP_PRC_16               0x04
#define BAROMETER3_TMP_PRC_32               0x05
#define BAROMETER3_TMP_PRC_64               0x06
#define BAROMETER3_TMP_PRC_128              0x07
#define BAROMETER3_COEF_RDY                 0x80
#define BAROMETER3_SENSOR_RDY               0x40
#define BAROMETER3_TMP_RDY                  0x20
#define BAROMETER3_PRS_RDY                  0x10
#define BAROMETER3_MEAS_CTRL_IDLE           0x00
#define BAROMETER3_MEAS_CTRL_CMD_PM         0x01
#define BAROMETER3_MEAS_CTRL_CMD_TM         0x02
#define BAROMETER3_MEAS_CTRL_CONT_PM        0x05
#define BAROMETER3_MEAS_CTRL_CONT_TM        0x06
#define BAROMETER3_MEAS_CTRL_CONT_MEAS      0x07
#define BAROMETER3_INT_HL_ACT_L             0x00
#define BAROMETER3_INT_HL_ACT_H             0x80
#define BAROMETER3_INT_FIFO                 0x40
#define BAROMETER3_INT_TMP                  0x20
#define BAROMETER3_INT_PRS                  0x10
#define BAROMETER3_T_SHIFT                  0x08
#define BAROMETER3_P_SHIFT                  0x04
#define BAROMETER3_FIFO_EN                  0x02
#define BAROMETER3_SPI_MODE_4_WIRE          0x00
#define BAROMETER3_SPI_MODE_3_WIRE          0x01
#define BAROMETER3_INT_FIFO_FULL            0x04
#define BAROMETER3_INT_TMP_FLG              0x02
#define BAROMETER3_INT_PRS_FLG              0x01
#define BAROMETER3_FIFO_FULL                0x02
#define BAROMETER3_FIFO_EMPTY               0x01
#define BAROMETER3_FIFO_SIZE                  32
#define BAROMETER3_FIFO_FLUSH               0x80
#define BAROMETER3_SOFT_RST                 0x09
#define BAROMETER3_TMP_COEF_SRCE            0x80
#define BAROMETER3_SCALE_FCTR_OSR_1         524288
#define BAROMETER3_SCALE_FCTR_OSR_2         1572864
#define BAROMETER3_SCALE_FCTR_OSR_4         3670016
#define BAROMETER3_SCALE_FCTR_OSR_8         7864320
#define BAROMETER3_SCALE_FCTR_OSR_16        253952
#define BAROMETER3_SCALE_FCTR_OSR_32        516096
#define BAROMETER3_SCALE_FCTR_OSR_64        1040384
#define BAROMETER3_SCALE_FCTR_OSR_128       2088960
#define BAROMETER3_SUCCESS                  0
#define BAROMETER3_BUSY                     1
#define BAROMETER3_MAX_BUSYTIME             990
#define BAROMETER3_FAIL                     2
#define BAROMETER3_UNFIN                    3
#define BAROMETER3_SPI_DUMMY                0x00
#define SPI_COMMUNICATION                   1
#define I2C_COMMUNICATION                   2
#define BAROMETER3_PRODUCT_ID               0x10
#define BAROMETER3_PASCAL_TO_MBAR           100
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef uint8_t  barometer3_select_t;
 
typedef void ( *barometer3_master_io_t )( struct barometer3_s*, uint8_t, uint8_t*, uint8_t );
 
typedef struct barometer3_s
{
    // Input pins 
 
    digital_in_t int_pin;
 
    // Output pins 
    
    digital_out_t cs;
    
    // Modules 
 
    i2c_master_t i2c;
    spi_master_t spi;
 
    // ctx variable 
 
    uint8_t slave_address;
    pin_name_t chip_select;
    barometer3_master_io_t  write_f;
    barometer3_master_io_t  read_f;
    barometer3_select_t master_sel;
 
    int32_t coef_c0_half;
    int32_t coef_c1;
    int32_t coef_c00;
    int32_t coef_c10;
    int32_t coef_c01;
    int32_t coef_c11;
    int32_t coef_c20;
    int32_t coef_c21;
    int32_t coef_c30;
    float coef_temp_scal;
    uint8_t cfg_temp_mr;
    uint8_t cfg_temp_osr;
    uint8_t cfg_prs_mr;
    uint8_t cfg_prs_osr;
    uint8_t cfg_temp_sens;
    uint8_t cfg_op_mode;
 
    uint8_t communication_interface;
 
} barometer3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
    
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
   uint32_t i2c_speed;
   uint8_t  i2c_address;
 
   uint32_t spi_speed;
   spi_master_mode_t  spi_mode;
   spi_master_chip_select_polarity_t cs_polarity;
 
   barometer3_select_t sel;
 
} barometer3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void barometer3_cfg_setup ( barometer3_cfg_t *cfg );
 
BAROMETER3_RETVAL barometer3_init ( barometer3_t *ctx, barometer3_cfg_t *cfg );
 
void barometer3_generic_write ( barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void barometer3_generic_read ( barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t barometer3_read_byte ( barometer3_t *ctx, uint8_t reg_adr );
 
void  barometer3_read_coeffs ( barometer3_t *ctx );
 
void barometer3_set_op_mode ( barometer3_t *ctx, uint8_t op_mode );
 
void barometer3_flush_fifo ( barometer3_t *ctx );
 
void barometer3_disable_fifo ( barometer3_t *ctx );
 
void barometer3_standby ( barometer3_t *ctx );
 
void barometer3_cfg_temp ( barometer3_t *ctx, uint8_t temp_mr, uint8_t temp_osr );
 
void  barometer3_cfg_pres ( barometer3_t *ctx, uint8_t prs_mr, uint8_t prs_osr );
 
uint8_t barometer3_st_meas_temp_once ( barometer3_t *ctx, uint8_t temp_osr );
 
uint8_t barometer3_st_meas_pres_once ( barometer3_t *ctx, uint8_t prs_osr );
 
void  barometer3_get_raw_res ( barometer3_t *ctx, uint8_t reg_adr, int32_t *raw );
 
float barometer3_calc_temp ( barometer3_t *ctx, int32_t raw );
 
float barometer3_calc_pres ( barometer3_t *ctx, int32_t raw );
 
uint8_t barometer3_get_single_res ( barometer3_t *ctx, float *result );
 
uint8_t barometer3_meas_temp_once ( barometer3_t *ctx, float *result, uint8_t temp_osr );
 
uint8_t barometer3_meas_prs_once ( barometer3_t *ctx, float *result, uint8_t prs_osr );
 
void barometer3_def_cfg ( barometer3_t *ctx );
 
uint8_t barometer3_get_fifo_val ( barometer3_t *ctx, int32_t *value );
 
uint8_t barometer3_get_cont_res ( barometer3_t *ctx, float *temp_buf, float *prs_buf );
 
uint8_t barometer3_check_int ( barometer3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _BAROMETER3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END