diffpress3.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 DIFFPRESS3_H
#define DIFFPRESS3_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_analog_in.h"
#include "drv_i2c_master.h"
 
#define DIFFPRESS3_PMIN             -100.0f   // Measurement range minimum
#define DIFFPRESS3_PMAX              1000.0f  // Measurement range maximum
#define DIFFPRESS3_ACCP_ABS_MIN     -0.3f     // Absolute accuracy minimum
#define DIFFPRESS3_ACCP_ABS_TYP      0.1f     // Absolute accuracy typical
#define DIFFPRESS3_ACCP_ABS_MAX      0.3f     // Absolute accuracy minimum
#define DIFFPRESS3_ACCP_TOT_MIN     -0.5f     // Total accuracy minimum
#define DIFFPRESS3_ACCP_TOT_TYP      0.25f    // Total accuracy typical
#define DIFFPRESS3_ACCP_TOT_MAX      0.5f     // Total accuracy minimum
#define DIFFPRESS3_SENP              0.04196f // Sensitivity (digital)
#define DIFFPRESS3_AN_SENP           275.0f   // Sensitivity (analog)
#define DIFFPRESS3_ACCP_REP          0.01f    // Repeatability
#define DIFFPRESS3_ACCP_DRIFT        0.05f    // Long term drift
#define DIFFPRESS3_DIG_OUTOFF        5660.0f  // Digital Zero pressure offset
#define DIFFPRESS3_DIG_FSS           26214.0f // DigitalFull scale span 
#define DIFFPRESS3_DIG_OUTP_MIN      3207.0f  // Digital Output at minimum pressure
#define DIFFPRESS3_DIG_OUTP_MAX      29491.0f // Digital Output at maximum pressure
#define DIFFPRESS3_AN_OUTOFF         0.87f    // Analog Zero pressure offset
#define DIFFPRESS3_AN_FSS            4.0f     // Analog Full scale span 
#define DIFFPRESS3_AN_OUTP_MIN       0.5f     // Analog Output at minimum pressure
#define DIFFPRESS3_AN_OUTP_MAX       4.5f     // Analog Output at maximum pressure
#define DIFFPRESS3_PRES              0x7FFF   // Resolution
 
#define DIFFPRESS3_TRANGE_MIN        0.0f     // Measurement range minimum
#define DIFFPRESS3_TRANGE_MAX        70.0f    // Measurement range maximum
#define DIFFPRESS3_TRES              0x7FFF   // Resolution
#define DIFFPRESS3_SENT              0.004272 // Sensitivity
#define DIFFPRESS3_OUTT_MIN          8192.0   // Output at minimum temperature
#define DIFFPRESS3_OUTT_MAX          24576.0  // Output at maximum temperature
 
#define DIFFPRESS3_ADC_RESOLUTION    0x7FFF
#define DIFFPRESS3_VREF_3V3          3.3
#define DIFFPRESS3_VREF_5V           5.0
 
#define DIFFPRESS3_SET_DEV_ADDR      0x78
 
 // diffpress3_set
 
#define DIFFPRESS3_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // diffpress3_map
 // diffpress3
 
typedef enum
{
    DIFFPRESS3_DRV_SEL_ADC,    
    DIFFPRESS3_DRV_SEL_I2C     
} diffpress3_drv_t;
 
typedef enum
{
    DIFFPRESS3_AN_SEL_5V  = 1,    
    DIFFPRESS3_AN_SEL_2V5 = 2     
} diffpress3_an_sel_t;
 
typedef enum
{
    DIFFPRESS3_RAW_DATA_PRESSURE    = 0,    
    DIFFPRESS3_RAW_DATA_TEMPERATURE = 2     
} diffpress3_d_sel_t;
 
typedef struct
{
    analog_in_t  adc;    
    i2c_master_t i2c;    
    uint8_t      slave_address;    
    float        vref;             
    diffpress3_drv_t drv_sel;      
    diffpress3_an_sel_t an_sel;     
    diffpress3_d_sel_t data_sel;    
} diffpress3_t;
 
typedef struct
{
    pin_name_t an;     
    pin_name_t scl;    
    pin_name_t sda;    
    analog_in_resolution_t resolution;    
    float                  vref;          
    uint32_t               i2c_speed;     
    uint8_t                i2c_address;   
    diffpress3_drv_t drv_sel;       
    diffpress3_an_sel_t an_sel;     
    diffpress3_d_sel_t data_sel;    
} diffpress3_cfg_t;
 
typedef enum
{
    DIFFPRESS3_OK = 0,
    DIFFPRESS3_ERROR = -1
 
} diffpress3_return_value_t;
 
void diffpress3_cfg_setup ( diffpress3_cfg_t *cfg );
 
void diffpress3_drv_interface_selection ( diffpress3_cfg_t *cfg, diffpress3_drv_t drv_sel );
 
err_t diffpress3_init ( diffpress3_t *ctx, diffpress3_cfg_t *cfg );
 
err_t diffpress3_read_raw_adc ( diffpress3_t *ctx, uint16_t *raw_adc, diffpress3_d_sel_t data_sel );
 
err_t diffpress3_read_voltage ( diffpress3_t *ctx, float *voltage );
 
err_t diffpress3_set_vref ( diffpress3_t *ctx, float vref );
 
err_t diffpress3_get_pressure ( diffpress3_t *ctx, float *pressure );
 
err_t diffpress3_get_temperature ( diffpress3_t *ctx, float *temperature );
 
err_t diffpress3_get_digit_out_data ( diffpress3_t *ctx, uint16_t *press_data, uint16_t *temp_data );
 
#ifdef __cplusplus
}
#endif
#endif // DIFFPRESS3_H
 
 // diffpress3
 
// ------------------------------------------------------------------------ END