diffpress4.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 DIFFPRESS4_H
#define DIFFPRESS4_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 DIFFPRESS4_REG_COMMAND                     0x22
#define DIFFPRESS4_REG_TEMPERATURE                 0x2E
#define DIFFPRESS4_REG_PRESSURE                    0x30
#define DIFFPRESS4_REG_STATUS_SYNC                 0x32
#define DIFFPRESS4_REG_STATUS                      0x36
#define DIFFPRESS4_REG_SER0                        0x50
#define DIFFPRESS4_REG_SER1                        0x52
 
 // diffpress4_reg
 
#define DIFFPRESS4_P_MIN                          -250.0f
#define DIFFPRESS4_P_MAX                           250.0f
#define DIFFPRESS4_OUT_MIN                        -26215.0f
#define DIFFPRESS4_OUT_MAX                         26214.0f
#define DIFFPRESS4_B_0                            -16881.0f
#define DIFFPRESS4_B_1                             397.2f
 
#define DIFFPRESS4_STATUS_IDLE_CHIP_BUSY           0x00
#define DIFFPRESS4_STATUS_IDLE_CHIP_IDLE           0x01
#define DIFFPRESS4_STATUS_DSP_S_CLEARED            0x00
#define DIFFPRESS4_STATUS_DSP_S_UPDATED            0x01
#define DIFFPRESS4_STATUS_DSP_T_CLEARED            0x00
#define DIFFPRESS4_STATUS_DSP_T_UPDATED            0x01
#define DIFFPRESS4_STATUS_BS_FAIL_NO_FAILURE       0x00
#define DIFFPRESS4_STATUS_BS_FAIL_OCCURRED         0x01
#define DIFFPRESS4_STATUS_BC_FAIL_NO_FAILURE       0x00
#define DIFFPRESS4_STATUS_BC_FAIL_OCCURRED         0x01
#define DIFFPRESS4_STATUS_DSP_SAT_NORMAL           0x00
#define DIFFPRESS4_STATUS_DSP_SAT_OVERFLOW         0x01
#define DIFFPRESS4_STATUS_COM_CRC_OK               0x00
#define DIFFPRESS4_STATUS_COM_CRC_ERROR            0x01
#define DIFFPRESS4_STATUS_DSP_S_MISSED             0x00
#define DIFFPRESS4_STATUS_DSP_S_M_UPDATED          0x01
#define DIFFPRESS4_STATUS_DSP_T_MISSED             0x00
#define DIFFPRESS4_STATUS_DSP_T_M_UPDATED          0x01
 
#define DIFFPRESS4_SET_CMD_SLEEP_MODE              0x32, 0x6C 
#define DIFFPRESS4_SET_CMD_RESET                   0x69, 0xB1 
 
#define DIFFPRESS4_DEVICE_ADDRESS_UNPROTECTED      0x6C
#define DIFFPRESS4_DEVICE_ADDRESS_CRC_PROTECTED    0x6D
 
 // diffpress4_set
 
#define DIFFPRESS4_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // diffpress4_map
 // diffpress4
 
typedef struct
{
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} diffpress4_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} diffpress4_cfg_t;
 
typedef struct
{
    uint8_t idle;             
    uint8_t dsp_s_up;         
    uint8_t dsp_t_up;         
    uint8_t bs_fail;          
    uint8_t bc_fail;          
    uint8_t dsp_sat;          
    uint8_t com_crc_error;    
    uint8_t dsp_s_missed;     
    uint8_t dsp_t_missed;     
} diffpress4_status_t;
 
typedef enum
{
    DIFFPRESS4_OK = 0,
    DIFFPRESS4_ERROR = -1
 
} diffpress4_return_value_t;
 
void diffpress4_cfg_setup ( diffpress4_cfg_t *cfg );
 
err_t diffpress4_init ( diffpress4_t *ctx, diffpress4_cfg_t *cfg );
 
err_t diffpress4_set_slave_address ( diffpress4_t *ctx, uint8_t slave_address );
 
err_t diffpress4_generic_write ( diffpress4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t diffpress4_generic_read ( diffpress4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t diffpress4_set_sleep_mode ( diffpress4_t *ctx );
 
err_t diffpress4_sw_reset ( diffpress4_t *ctx );
 
err_t diffpress4_get_serial_number ( diffpress4_t *ctx, uint32_t *serial_number );
 
err_t diffpress4_get_status ( diffpress4_t *ctx, diffpress4_status_t *status );
 
err_t diffpress4_get_raw_data ( diffpress4_t *ctx, int16_t *temp_data, int16_t *press_data );
 
err_t diffpress4_get_measurement_data ( diffpress4_t *ctx, float *diff_press, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // DIFFPRESS4_H
 
 // diffpress4
 
// ------------------------------------------------------------------------ END