hallcurrent15.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 HALLCURRENT15_H
#define HALLCURRENT15_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 HALLCURRENT15_REG_CONVERSION_RESULT         0x00
#define HALLCURRENT15_REG_ALERT_STATUS              0x01
#define HALLCURRENT15_REG_CONFIGURATION             0x02
#define HALLCURRENT15_REG_LOW_LIMIT                 0x03
#define HALLCURRENT15_REG_HIGH_LIMIT                0x04
#define HALLCURRENT15_REG_HYSTERESIS                0x05
#define HALLCURRENT15_REG_LOWEST_CONVERSION         0x06
#define HALLCURRENT15_REG_HIGHEST_CONVERSION        0x07
 
 // hallcurrent15_reg
 
#define HALLCURRENT15_SENSITIVITY_V_TO_A        0.05
#define HALLCURRENT15_ZERO_CURRENT_OFFSET       0.1
#define HALLCURRENT15_NUM_CONVERSIONS           1000
 
#define HALLCURRENT15_ADC_RESOLUTION            0x03FF
#define HALLCURRENT15_VREF_3V3                  3.3
#define HALLCURRENT15_VREF_5V                   5.0
 
#define HALLCURRENT15_SET_DEV_ADDR              0x54
 
 // hallcurrent15_set
 
#define HALLCURRENT15_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hallcurrent15_map
 // hallcurrent15
 
typedef enum
{
    HALLCURRENT15_DRV_SEL_ADC,      
    HALLCURRENT15_DRV_SEL_I2C       
} hallcurrent15_drv_t;
 
typedef struct
{
    digital_in_t alr;               
    analog_in_t  adc;               
    i2c_master_t i2c;               
    uint8_t     slave_address;      
    pin_name_t  chip_select;        
    float       vref;               
    hallcurrent15_drv_t drv_sel;    
} hallcurrent15_t;
 
typedef struct
{
    pin_name_t  an;                 
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  alr;                
    analog_in_resolution_t  resolution;     
    float                   vref;           
    uint32_t                i2c_speed;      
    uint8_t                 i2c_address;    
    hallcurrent15_drv_t drv_sel;    
} hallcurrent15_cfg_t;
 
typedef enum
{
    HALLCURRENT15_OK = 0,
    HALLCURRENT15_ERROR = -1
 
} hallcurrent15_return_value_t;
 
void hallcurrent15_cfg_setup ( hallcurrent15_cfg_t *cfg );
 
void hallcurrent15_drv_interface_selection ( hallcurrent15_cfg_t *cfg, hallcurrent15_drv_t drv_sel );
 
err_t hallcurrent15_init ( hallcurrent15_t *ctx, hallcurrent15_cfg_t *cfg );
 
err_t hallcurrent15_write_register ( hallcurrent15_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t hallcurrent15_read_register ( hallcurrent15_t *ctx, uint8_t reg, uint16_t *data_out );
 
uint8_t hallcurrent15_get_alert_pin ( hallcurrent15_t *ctx );
 
err_t hallcurrent15_read_raw_adc ( hallcurrent15_t *ctx, uint16_t *raw_adc );
 
err_t hallcurrent15_read_voltage ( hallcurrent15_t *ctx, float *voltage );
 
err_t hallcurrent15_set_vref ( hallcurrent15_t *ctx, float vref );
 
err_t hallcurrent15_read_current ( hallcurrent15_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT15_H
 
 // hallcurrent15
 
// ------------------------------------------------------------------------ END