vavpress.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 VAVPRESS_H
#define VAVPRESS_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 VAVPRESS_SET_CMD_RESET_FIRMWARE                   0x11
#define VAVPRESS_SET_CMD_START_PRESSURE_CONVERSION        0x21
#define VAVPRESS_SET_CMD_RETRIEVE_ELECTRONIC_SIGNATURE    0x23
 
#define VAVPRESS_SET_DEV_ADDR_0                           0x5C
#define VAVPRESS_SET_DEV_ADDR_1                           0x5D
#define VAVPRESS_SET_DEV_ADDR_2                           0x5E
#define VAVPRESS_SET_DEV_ADDR_3                           0x5F
 
 // vavpress_set
 
#define VAVPRESS_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // vavpress_map
 // vavpress
 
typedef struct
{
    // Modules
 
    i2c_master_t i2c;         
    // I2C slave address      
                              
    uint8_t slave_address;    
} vavpress_t;
 
typedef struct
{
    pin_name_t  scl;          
    pin_name_t  sda;          
    uint32_t  i2c_speed;      
    uint8_t   i2c_address;    
} vavpress_cfg_t;
 
typedef enum
{
   VAVPRESS_OK = 0,
   VAVPRESS_ERROR = -1
 
} vavpress_return_value_t;
 
typedef struct
{
   float firmware_version;
   char part_number[ 12 ];
   char lot_number[ 7 ];
   uint16_t pressure_range;
   char output_type;
   uint16_t scale_factor;
   char calibration_id[ 2 ];
   uint8_t week_number;
   uint8_t year_number;
   uint16_t sequence_number;
 
} vavpress_el_signature_data_t;
 
typedef struct
{
   uint16_t scale_factor_temp;
   uint16_t scale_factor_press;
   uint16_t readout_at_known_temperature;
   float known_temperature_c;
 
} vavpress_sensor_param_data_t;
 
void vavpress_cfg_setup ( vavpress_cfg_t *cfg );
 
err_t vavpress_init ( vavpress_t *ctx, vavpress_cfg_t *cfg );
 
err_t vavpress_default_cfg ( vavpress_t *ctx );
 
err_t vavpress_set_command ( vavpress_t *ctx, uint8_t cmd );
 
err_t vavpress_generic_write ( vavpress_t *ctx, uint8_t *tx_buf, uint8_t tx_len );
 
err_t vavpress_generic_read ( vavpress_t *ctx, uint8_t *rx_buf, uint8_t rx_len );
 
err_t vavpress_set_default_sensor_param ( vavpress_t *ctx, vavpress_sensor_param_data_t *param_data );
 
err_t vavpress_get_readout_data ( vavpress_t *ctx, int16_t *press_data, int16_t *temp_data );
 
err_t vavpress_get_dif_press_and_temp ( vavpress_t *ctx, vavpress_sensor_param_data_t *param_data, float *diff_press, float *temperature );
 
err_t vavpress_retrieve_electronic_signature ( vavpress_t *ctx, vavpress_el_signature_data_t *el_signature_data );
 
 
#ifdef __cplusplus
}
#endif
#endif // VAVPRESS_H
 
 // vavpress
 
// ------------------------------------------------------------------------ END