barometer10.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 BAROMETER10_H
#define BAROMETER10_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define BAROMETER10_REG_INTERRUPT_CFG              0x0B
#define BAROMETER10_REG_THS_P_L                    0x0C
#define BAROMETER10_REG_THS_P_H                    0x0D
#define BAROMETER10_REG_IF_CTRL                    0x0E
#define BAROMETER10_REG_WHO_AM_I                   0x0F
#define BAROMETER10_REG_CTRL_REG1                  0x10
#define BAROMETER10_REG_CTRL_REG2                  0x11
#define BAROMETER10_REG_CTRL_REG3                  0x12
#define BAROMETER10_REG_CTRL_REG4                  0x13
#define BAROMETER10_REG_FIFO_CTRL                  0x14
#define BAROMETER10_REG_FIFO_WTM                   0x15
#define BAROMETER10_REG_REF_P_L                    0x16
#define BAROMETER10_REG_REF_P_H                    0x17
#define BAROMETER10_REG_I3C_IF_CTRL_ADD            0x19
#define BAROMETER10_REG_RPDS_L                     0x1A
#define BAROMETER10_REG_RPDS_H                     0x1B
#define BAROMETER10_REG_INT_SOURCE                 0x24
#define BAROMETER10_REG_FIFO_STATUS1               0x25
#define BAROMETER10_REG_FIFO_STATUS2               0x26
#define BAROMETER10_REG_STATUS                     0x27
#define BAROMETER10_REG_PRESS_OUT_XL               0x28
#define BAROMETER10_REG_PRESS_OUT_L                0x29
#define BAROMETER10_REG_PRESS_OUT_H                0x2A
#define BAROMETER10_REG_TEMP_OUT_L                 0x2B
#define BAROMETER10_REG_TEMP_OUT_H                 0x2C
#define BAROMETER10_REG_FIFO_DATA_OUT_PRESS_XL     0x78
#define BAROMETER10_REG_FIFO_DATA_OUT_PRESS_L      0x79
#define BAROMETER10_REG_FIFO_DATA_OUT_PRESS_H      0x7A
 
 // barometer10_reg
 
#define BAROMETER10_DEVICE_ID                      0xB4
 
#define BAROMETER10_ODR_ONE_SHOT                   0x00
#define BAROMETER10_ODR_1_Hz                       0x01
#define BAROMETER10_ODR_4_Hz                       0x02
#define BAROMETER10_ODR_10_Hz                      0x03
#define BAROMETER10_ODR_25_Hz                      0x04
#define BAROMETER10_ODR_50_Hz                      0x05
#define BAROMETER10_ODR_75_Hz                      0x06
#define BAROMETER10_ODR_100_Hz                     0x07
#define BAROMETER10_ODR_200_Hz                     0x08
#define BAROMETER10_AVG_4                          0x00
#define BAROMETER10_AVG_8                          0x01
#define BAROMETER10_AVG_16                         0x02
#define BAROMETER10_AVG_32                         0x03
#define BAROMETER10_AVG_64                         0x04
#define BAROMETER10_AVG_128                        0x05
#define BAROMETER10_AVG_512                        0x07
 
#define BAROMETER10_FS_MODE_1260_hPa               0x00
#define BAROMETER10_FS_MODE_4060_hPa               0x01
#define BAROMETER10_LFPF_CFG_ODR4                  0x00
#define BAROMETER10_LFPF_CFG_ODR9                  0x01
#define BAROMETER10_EN_LPFP_DISABLE                0x00
#define BAROMETER10_EN_LPFP_ENABLE                 0x01
#define BAROMETER10_BDU_CONTINUOUS_UPDATE          0x00
#define BAROMETER10_BDU_NO_UPDATE_UNTIL_READ       0x01
#define BAROMETER10_SWRESET_BIT_MASK               0x02
#define BAROMETER10_ONESHOT_IDLE_MODE              0x00
#define BAROMETER10_ONESHOT_NEW_SET_ACQUIRED       0x01
 
#define BAROMETER10_INT_H_L_ACTIVE_HIGH            0x00
#define BAROMETER10_INT_H_L_ACTIVE_LOW             0x01
#define BAROMETER10_IF_ADD_INC_DISABLE             0x00
#define BAROMETER10_IF_ADD_INC_ENABLE              0x01
 
#define BAROMETER10_DRDY_PLS_DISABLE               0x00
#define BAROMETER10_DRDY_PLS_ENABLE                0x01
#define BAROMETER10_DRDY_DISABLE                   0x00
#define BAROMETER10_DRDY_ENABLE                    0x01
#define BAROMETER10_INT_EN_DISABLE                 0x00
#define BAROMETER10_INT_EN_ENABLE                  0x01
 
#define BAROMETER10_DEVICE_ADDRESS_GND             0x5C
#define BAROMETER10_DEVICE_ADDRESS_VCC             0x5D
 
 // barometer10_set
 
#define BAROMETER10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // barometer10_map
 // barometer10
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;     
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} barometer10_t;
 
typedef struct
{
    pin_name_t scl;            
    pin_name_t sda;            
    pin_name_t int_pin;        
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} barometer10_cfg_t;
 
typedef struct
{
    uint8_t odr;           
    uint8_t avg;           
    uint8_t fs_mode;       
    uint8_t lfpf_cfg;      
    uint8_t en_lpfp;       
    uint8_t bdu;           
    uint8_t oneshot;       
    uint8_t int_h_l;       
    uint8_t if_add_inc;    
    uint8_t drdy_pls;      
    uint8_t drdy;          
    uint8_t int_en;        
} barometer10_sensor_cfg_t;
 
typedef enum
{
    BAROMETER10_OK = 0,
    BAROMETER10_ERROR = -1
 
} barometer10_return_value_t;
 
void barometer10_cfg_setup ( barometer10_cfg_t *cfg );
 
err_t barometer10_init ( barometer10_t *ctx, barometer10_cfg_t *cfg );
 
err_t barometer10_default_cfg ( barometer10_t *ctx );
 
err_t barometer10_generic_write ( barometer10_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t barometer10_generic_read ( barometer10_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t barometer10_sw_reset ( barometer10_t *ctx );
 
err_t barometer10_get_device_id ( barometer10_t *ctx, uint8_t *device_id );
 
err_t barometer10_get_config ( barometer10_t *ctx, barometer10_sensor_cfg_t *config );
 
err_t barometer10_set_config ( barometer10_t *ctx, barometer10_sensor_cfg_t config );
 
err_t barometer10_trigger_one_shot ( barometer10_t *ctx );
 
err_t barometer10_get_pressure_output ( barometer10_t *ctx, int32_t *pressure_raw );
 
err_t barometer10_get_temperature_output ( barometer10_t *ctx, int16_t *temperature_raw );
 
err_t barometer10_get_pressure ( barometer10_t *ctx, float *pressure );
 
err_t barometer10_get_temperature ( barometer10_t *ctx, float *temperature );
 
uint8_t barometer10_get_int_pin ( barometer10_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BAROMETER10_H
 
 // barometer10
 
// ------------------------------------------------------------------------ END