altitude5.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 ALTITUDE5_H
#define ALTITUDE5_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_i2c_master.h"
#include "drv_analog_in.h"
 
#define ALTITUDE5_SET_DEV_ADDR                0x4D
 
 // altitude5_set
 
#define ALTITUDE5_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // altitude5_map
 // altitude5
 
typedef enum
{
   ALTITUDE5_DRV_SEL_AN,       
   ALTITUDE5_DRV_SEL_I2C       
} altitude5_drv_t;
 
typedef err_t ( *altitude5_master_io_t )( struct altitude5_s*, uint16_t* ); 
 
typedef struct altitude5_s
{   
    analog_in_t  adc;                   
    // Modules
    i2c_master_t i2c;                   
    // I2C slave address
    uint8_t slave_address;              
    altitude5_drv_t  drv_sel;           
    altitude5_master_io_t  read_adc_f;  
    int16_t offset;                     
    float sea_lvl_pressure;             
    float temperature;                  
} altitude5_t;
 
typedef struct
{
    pin_name_t  an;                         
    analog_in_resolution_t  resolution;     
    float                   vref;           
    pin_name_t  scl;                        
    pin_name_t  sda;                        
    uint32_t  i2c_speed;                    
    uint8_t   i2c_address;                  
    altitude5_drv_t  drv_sel;
    
    int16_t adc_offset;                     
    float sea_level_pressure;               
    float temperature_degree_celsius;       
} altitude5_cfg_t;
 
 
typedef enum
{
   ALTITUDE5_OK = 0,
   ALTITUDE5_ERROR = -1
 
} altitude5_return_value_t;
 
void altitude5_cfg_setup ( altitude5_cfg_t *cfg );
 
err_t altitude5_init ( altitude5_t *ctx, altitude5_cfg_t *cfg );
 
err_t altitude5_default_cfg ( altitude5_t *ctx );
 
err_t altitude5_get_adc ( altitude5_t *ctx, uint16_t *data_out );
 
err_t altitude5_read_an_pin_voltage ( altitude5_t *ctx, float *data_out );
 
err_t altitude5_get_adc_voltage ( altitude5_t *ctx, float *adc_vtg );
 
err_t altitude5_get_pressure ( altitude5_t *ctx, float *pressure );
 
err_t altitude5_get_altitude ( altitude5_t *ctx, float *altitude );
 
#ifdef __cplusplus
}
#endif
#endif // ALTITUDE5_H
 
 // altitude5
 
// ------------------------------------------------------------------------ END