current7.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 CURRENT7_H
#define CURRENT7_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 CURRENT7_NUM_CONVERSIONS        100
#define CURRENT7_SENSITIVITY_V_TO_A     0.8f
 
#define CURRENT7_ADC_RESOLUTION         0x0FFF
#define CURRENT7_VREF_3V3               3.3
#define CURRENT7_VREF_5V                5.0
 
#define CURRENT7_SET_DEV_ADDR           0x4D
 
 // current7_set
 
#define CURRENT7_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // current7_map
 // current7
 
typedef enum
{
    CURRENT7_DRV_SEL_ADC,               
    CURRENT7_DRV_SEL_I2C                
} current7_drv_t;
 
typedef struct current7_s
{
    analog_in_t  adc;                               
    i2c_master_t i2c;                               
    uint8_t      slave_address;                     
    float        vref;                              
    current7_drv_t drv_sel;                         
} current7_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;             
    current7_drv_t drv_sel;                
} current7_cfg_t;
 
typedef enum
{
    CURRENT7_OK = 0,
    CURRENT7_ERROR = -1
 
} current7_return_value_t;
 
void current7_cfg_setup ( current7_cfg_t *cfg );
 
void current7_drv_interface_selection ( current7_cfg_t *cfg, current7_drv_t drv_sel );
 
err_t current7_init ( current7_t *ctx, current7_cfg_t *cfg );
 
err_t current7_read_raw_adc ( current7_t *ctx, uint16_t *raw_adc );
 
err_t current7_read_voltage ( current7_t *ctx, float *voltage );
 
err_t current7_set_vref ( current7_t *ctx, float vref );
 
err_t current7_get_current ( current7_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENT7_H
 
 // current7
 
// ------------------------------------------------------------------------ END