hallcurrent13.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 HALLCURRENT13_H
#define HALLCURRENT13_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 HALLCURRENT13_SENSITIVITY_V_TO_A    0.1
#define HALLCURRENT13_ZERO_CURRENT_OFFSET   0.1
#define HALLCURRENT13_NUM_CONVERSIONS       100
 
#define HALLCURRENT13_ADC_RESOLUTION        0x0FFF
#define HALLCURRENT13_VREF_3V3              3.3
#define HALLCURRENT13_VREF_5V               5.0
 
#define HALLCURRENT13_SET_DEV_ADDR      0x4D
 
 // hallcurrent13_set
 
#define HALLCURRENT13_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // hallcurrent13_map
 // hallcurrent13
 
typedef enum
{
    HALLCURRENT13_DRV_SEL_ADC,              
    HALLCURRENT13_DRV_SEL_I2C               
} hallcurrent13_drv_t;
 
typedef struct
{
    analog_in_t         adc;                
    i2c_master_t        i2c;                
    uint8_t             slave_address;      
    pin_name_t          chip_select;        
    float               vref;               
    hallcurrent13_drv_t drv_sel;            
} hallcurrent13_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;    
    hallcurrent13_drv_t drv_sel;            
} hallcurrent13_cfg_t;
 
typedef enum
{
    HALLCURRENT13_OK = 0,
    HALLCURRENT13_ERROR = -1
 
} hallcurrent13_return_value_t;
 
void hallcurrent13_cfg_setup ( hallcurrent13_cfg_t *cfg );
 
void hallcurrent13_drv_interface_selection ( hallcurrent13_cfg_t *cfg, hallcurrent13_drv_t drv_sel );
 
err_t hallcurrent13_init ( hallcurrent13_t *ctx, hallcurrent13_cfg_t *cfg );
 
err_t hallcurrent13_read_raw_adc ( hallcurrent13_t *ctx, uint16_t *raw_adc );
 
err_t hallcurrent13_read_voltage ( hallcurrent13_t *ctx, float *voltage );
 
err_t hallcurrent13_set_vref ( hallcurrent13_t *ctx, float vref );
 
err_t hallcurrent13_read_current ( hallcurrent13_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT13_H
 
 // hallcurrent13
 
// ------------------------------------------------------------------------ END