hallcurrent14.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 HALLCURRENT14_H
#define HALLCURRENT14_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 HALLCURRENT14_SENSITIVITY_V_TO_A        0.08
#define HALLCURRENT14_ZERO_CURRENT_OFFSET       0.5
#define HALLCURRENT14_NUM_CONVERSIONS           1000
 
#define HALLCURRENT14_ADC_RESOLUTION            0x0FFF
#define HALLCURRENT14_VREF_5V                   5.0
 
#define HALLCURRENT14_SET_DEV_ADDR              0x4D
 
 // hallcurrent14_set
 
#define HALLCURRENT14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
#define HALLCURRENT14_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // hallcurrent14_map
 // hallcurrent14
 
typedef enum
{
    HALLCURRENT14_DRV_SEL_ADC,      
    HALLCURRENT14_DRV_SEL_I2C       
} hallcurrent14_drv_t;
typedef enum {…};
 
typedef struct
{
    analog_in_t  adc;               
    i2c_master_t i2c;               
    uint8_t     slave_address;      
    pin_name_t  chip_select;        
    float       vref;               
    hallcurrent14_drv_t drv_sel;    
} hallcurrent14_t;
typedef struct {…};
 
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;    
    hallcurrent14_drv_t drv_sel;    
} hallcurrent14_cfg_t;
typedef struct {…};
 
typedef enum
{
    HALLCURRENT14_OK = 0,
    HALLCURRENT14_ERROR = -1
 
} hallcurrent14_return_value_t;
typedef enum {…};
 
void hallcurrent14_cfg_setup ( hallcurrent14_cfg_t *cfg );
 
void hallcurrent14_drv_interface_selection ( hallcurrent14_cfg_t *cfg, hallcurrent14_drv_t drv_sel );
 
err_t hallcurrent14_init ( hallcurrent14_t *ctx, hallcurrent14_cfg_t *cfg );
 
err_t hallcurrent14_read_raw_adc ( hallcurrent14_t *ctx, uint16_t *raw_adc );
 
err_t hallcurrent14_read_voltage ( hallcurrent14_t *ctx, float *voltage );
 
err_t hallcurrent14_set_vref ( hallcurrent14_t *ctx, float vref );
 
err_t hallcurrent14_read_current ( hallcurrent14_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT14_H
 
 // hallcurrent14
 
// ------------------------------------------------------------------------ END