hallcurrent18.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 HALLCURRENT18_H
#define HALLCURRENT18_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 HALLCURRENT18_ADC_RESOLUTION        0x0FFFu
#define HALLCURRENT18_VREF_3V3              3.3f
#define HALLCURRENT18_VREF_5V               5.0f
#define HALLCURRENT18_HALF_SCALE_3V3        1.65f
 
#define HALLCURRENT18_SENSITIVITY_MV_A      33.0f
#define HALLCURRENT18_CONV_TO_MILI          1000.0f
#define HALLCURRENT18_ADC_NUM_OF_MEASURE    500u
 
#define HALLCURRENT18_SET_DEV_ADDR          0x4D
 
 // hallcurrent18_set
 
#define HALLCURRENT18_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN );    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );   \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // hallcurrent18_map
 // hallcurrent18
 
typedef enum
{
    HALLCURRENT18_DRV_SEL_ADC,    
    HALLCURRENT18_DRV_SEL_I2C     
} hallcurrent18_drv_t;
 
typedef struct
{
    analog_in_t  adc;               
    i2c_master_t i2c;               
    uint8_t      slave_address;     
    float        vref;              
    float        zero_vref;         
    hallcurrent18_drv_t drv_sel;    
} hallcurrent18_t;
 
typedef struct
{
    pin_name_t an;     
    pin_name_t scl;    
    pin_name_t sda;    
    analog_in_resolution_t resolution;     
    float                  vref;           
    float                  zero_vref;      
    uint32_t               i2c_speed;      
    uint8_t                i2c_address;    
    hallcurrent18_drv_t drv_sel;           
} hallcurrent18_cfg_t;
 
typedef enum
{
    HALLCURRENT18_OK = 0,
    HALLCURRENT18_ERROR = -1
 
} hallcurrent18_return_value_t;
 
void hallcurrent18_cfg_setup ( hallcurrent18_cfg_t *cfg );
 
void hallcurrent18_drv_interface_selection ( hallcurrent18_cfg_t *cfg, hallcurrent18_drv_t drv_sel );
 
err_t hallcurrent18_init ( hallcurrent18_t *ctx, hallcurrent18_cfg_t *cfg );
 
err_t hallcurrent18_default_cfg ( hallcurrent18_t *ctx );
 
err_t hallcurrent18_read_raw_adc ( hallcurrent18_t *ctx, uint16_t *raw_adc );
 
err_t hallcurrent18_read_voltage ( hallcurrent18_t *ctx, float *voltage );
 
err_t hallcurrent18_set_vref ( hallcurrent18_t *ctx, float vref );
 
err_t hallcurrent18_read_current ( hallcurrent18_t *ctx, float *current );
 
err_t hallcurrent18_set_zero_ref ( hallcurrent18_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT18_H
 
 // hallcurrent18
 
// ------------------------------------------------------------------------ END