current9.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 CURRENT9_H
#define CURRENT9_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 CURRENT9_SENSITIVITY_V_TO_A         0.1333
#define CURRENT9_ZERO_CURRENT_OFFSET        0.500
#define CURRENT9_NUM_CONVERSIONS            200
#define CURRENT9_SENSOR_OUT_DIVIDER_2       2.0
#define CURRENT9_90PCT_VCC                  4.5
 
#define CURRENT9_ADC_RESOLUTION             0x0FFF
#define CURRENT9_VREF_3V3                   3.3
#define CURRENT9_VREF_5V                    5.0
 
#define CURRENT9_SET_DEV_ADDR               0x4D
 
 // current9_set
 
#define CURRENT9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // current9_map
 // current9
 
typedef enum
{
    CURRENT9_DRV_SEL_ADC,           
    CURRENT9_DRV_SEL_I2C            
} current9_drv_t;
 
typedef struct
{
    analog_in_t  adc;               
    i2c_master_t i2c;               
    uint8_t      slave_address;     
    pin_name_t   chip_select;       
    float        vref;              
    current9_drv_t drv_sel;         
} current9_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;     
    current9_drv_t drv_sel;         
} current9_cfg_t;
 
typedef enum
{
    CURRENT9_OK = 0,
    CURRENT9_ERROR = -1
 
} current9_return_value_t;
 
void current9_cfg_setup ( current9_cfg_t *cfg );
 
void current9_drv_interface_selection ( current9_cfg_t *cfg, current9_drv_t drv_sel );
 
err_t current9_init ( current9_t *ctx, current9_cfg_t *cfg );
 
err_t current9_read_raw_adc ( current9_t *ctx, uint16_t *raw_adc );
 
err_t current9_read_voltage ( current9_t *ctx, float *voltage );
 
err_t current9_set_vref ( current9_t *ctx, float vref );
 
err_t current9_read_current ( current9_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENT9_H
 
 // current9
 
// ------------------------------------------------------------------------ END