pressure22.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 PRESSURE22_H
#define PRESSURE22_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_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define PRESSURE22_CMD_ADC_READ                  0x00
#define PRESSURE22_CMD_RESET                     0x1E
#define PRESSURE22_CMD_PROM_VERSION              0xA0
#define PRESSURE22_CMD_PROM_READ_C1              0xA2
#define PRESSURE22_CMD_PROM_READ_C2              0xA4
#define PRESSURE22_CMD_PROM_READ_C3              0xA6
#define PRESSURE22_CMD_PROM_READ_C4              0xA8
#define PRESSURE22_CMD_PROM_READ_C5              0xAA
#define PRESSURE22_CMD_PROM_READ_C6              0xAC
#define PRESSURE22_CMD_PROM_END                  0xAE
 
 // pressure22_cmd
 
#define PRESSURE22_CRC4_BIT_MASK                 0x000Fu
#define PRESSURE22_VER_DEF_BIT_MASK              0x007Fu
#define PRESSURE22_FCT_DEF_BIT_MASK              0x001Fu
 
#define PRESSURE22_TEMPERATURE_20_C              40.0f
#define PRESSURE22_TEMPERATURE_10_C              10.0f
#define PRESSURE22_TEMP_TYPICAL                  2000.0f
#define PRESSURE22_TEMP_DIV                      100.0f
#define PRESSURE22_OFF_ACT_TEMP_MULTP            131072.0f
#define PRESSURE22_OFF_ACT_TEMP_DIV              64.0f
#define PRESSURE22_SENS_ACT_TEMP_MULTP           65536.0f
#define PRESSURE22_SENS_ACT_TEMP_DIV             128.0f
#define PRESSURE22_TEMP_COMP_PRESS_DIV           2097152.0f
#define PRESSURE22_COMP_PRESS_DIV                32768.0f
#define PRESSURE22_PRESS_CONVERT_PA_MBAR         100.0f
#define PRESSURE22_SEC_COMP_TI_DIV               34359738368.0f
#define PRESSURE22_SEC_COMP_TI_1_MULTP           14.0f
#define PRESSURE22_SEC_COMP_OFFI_1_MULTP         35.0f
#define PRESSURE22_SEC_COMP_SENS_MULTP           63.0f
#define PRESSURE22_SEC_COMP_OFFI_1_DIV           8.0f
#define PRESSURE22_SEC_COMP_TI_2_MULTP           12.0f
#define PRESSURE22_SEC_COMP_OFFI_2_MULTP         30.0f
#define PRESSURE22_SEC_COMP_OFFI_2_DIV           256.0f
#define PRESSURE22_SEC_COMP_SENSI_DIV            32.0f
 
#define PRESSURE22_DEVICE_ADDRESS                0x76
 
 // pressure22_set
 
#define PRESSURE22_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // pressure22_map
 // pressure22
 
typedef enum
{
    PRESSURE22_CMD_PRESS_OSR_256  = 0x40,
    PRESSURE22_CMD_PRESS_OSR_512  = 0x42,
    PRESSURE22_CMD_PRESS_OSR_1024 = 0x44,
    PRESSURE22_CMD_PRESS_OSR_2048 = 0x46,
    PRESSURE22_CMD_PRESS_OSR_4096 = 0x48,
    PRESSURE22_CMD_PRESS_OSR_8192 = 0x4A
 
} pressure22_press_conv_t;
 
typedef enum
{
    PRESSURE22_CMD_TEMP_OSR_256  = 0x50,
    PRESSURE22_CMD_TEMP_OSR_512  = 0x52,
    PRESSURE22_CMD_TEMP_OSR_1024 = 0x54,
    PRESSURE22_CMD_TEMP_OSR_2048 = 0x56,
    PRESSURE22_CMD_TEMP_OSR_4096 = 0x58,
    PRESSURE22_CMD_TEMP_OSR_8192 = 0x5A
 
} pressure22_temp_conv_t;
 
typedef struct
{
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
    // Calibration data (factory calibrated) from PROM
    uint16_t   prom_pt;       
    uint8_t    prom_crc;      
    uint8_t    prom_ver;      
    uint8_t    prom_fct;      
    uint16_t   prom_c1;       
    uint16_t   prom_c2;       
    uint16_t   prom_c3;       
    uint16_t   prom_c4;       
    uint16_t   prom_c5;       
    uint16_t   prom_c6;       
    // Conversions
    pressure22_press_conv_t    press_conv;    
    pressure22_temp_conv_t     temp_conv;     
} pressure22_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} pressure22_cfg_t;
 
typedef enum
{
    PRESSURE22_OK = 0,
    PRESSURE22_ERROR = -1
 
} pressure22_return_value_t;
 
void pressure22_cfg_setup ( pressure22_cfg_t *cfg );
 
err_t pressure22_init ( pressure22_t *ctx, pressure22_cfg_t *cfg );
 
err_t pressure22_default_cfg ( pressure22_t *ctx );
 
err_t pressure22_generic_write ( pressure22_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
 
err_t pressure22_generic_read ( pressure22_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
 
err_t pressure22_set_command ( pressure22_t *ctx, uint8_t cmd );
 
err_t pressure22_sw_reset ( pressure22_t *ctx );
 
err_t pressure22_get_adc_data ( pressure22_t *ctx, uint32_t *adc );
 
err_t pressure22_get_prom_data ( pressure22_t *ctx, uint8_t cmd_prom, uint16_t *prom );
 
err_t pressure22_get_calibration_data ( pressure22_t *ctx );
 
err_t pressure22_check_data_validity ( pressure22_t *ctx );
 
void pressure22_set_conversion ( pressure22_t *ctx, pressure22_press_conv_t press_conv, 
                                                    pressure22_temp_conv_t temp_conv );
 
err_t pressure22_get_measurement_data ( pressure22_t *ctx, float *temperature, float *pressure );
 
 
 
#ifdef __cplusplus
}
#endif
#endif // PRESSURE22_H
 
 // pressure22
 
// ------------------------------------------------------------------------ END