pressure13.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 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 PRESSURE13_H
#define PRESSURE13_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"
 
#define PRESSURE13_V_REF_2_048_mV                                 2.04800
#define PRESSURE13_V_REF_3_0_mV                                   3.00000
#define PRESSURE13_V_REF_3_3_mV                                   3.30000
#define PRESSURE13_V_REF_CALC_FACT                                0.86987
 
#define PRESSURE13_V_DD_3_3_mV                                    3.30000
#define PRESSURE13_V_DD_5_0_mV                                    5.00000
 
#define PRESSURE13_ADC_RES_10_BIT                                 1024.00
#define PRESSURE13_ADC_RES_12_BIT                                 4096.00
#define PRESSURE13_ADC_RES_14_BIT                                 16383.0
 
#define PRESSURE13_GAIN_AND_OFFSET_SYMBOL_A                       0.00293
#define PRESSURE13_GAIN_AND_OFFSET_SYMBOL_B                       0.05069
 
#define PRESSURE13_CONVERT_KPAS_TO_MBAR                           10.0000
 
 // pressure13_set
 
#define PRESSURE13_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // pressure13_map
 // pressure13
 
typedef struct
{
    analog_in_t  adc;       
} pressure13_t;
 
typedef struct
{
    pin_name_t  an;     
    analog_in_resolution_t  resolution;     
    float                   vref;           
} pressure13_cfg_t;
 
typedef enum
{
   PRESSURE13_OK = 0,
   PRESSURE13_ERROR = -1
 
} pressure13_return_value_t;
 
void pressure13_cfg_setup ( pressure13_cfg_t *cfg );
 
err_t pressure13_init ( pressure13_t *ctx, pressure13_cfg_t *cfg );
 
err_t pressure13_read_an_pin_value ( pressure13_t *ctx, uint16_t *data_out );
 
err_t pressure13_read_an_pin_voltage ( pressure13_t *ctx, float *data_out );
 
err_t pressure13_get_pressure ( pressure13_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // PRESSURE13_H
 
 // pressure13
 
// ------------------------------------------------------------------------ END