hallcurrent11.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 HALLCURRENT11_H
#define HALLCURRENT11_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_i2c_master.h"
#include "drv_analog_in.h"
 
#define HALLCURRENT11_SET_DEV_ADDR  0x4D
 
 // hallcurrent11_set
 
#define HALLCURRENT11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );   \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );   \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 
 // hallcurrent11_map
 // hallcurrent11
 
typedef enum
{
   HALLCURRENT11_DRV_SEL_AN,       
   HALLCURRENT11_DRV_SEL_I2C       
} hallcurrent11_drv_t;
 
typedef err_t ( *hallcurrent11_master_io_t )( struct hallcurrent11_s*, uint16_t* ); 
 
typedef struct hallcurrent11_s
{   
    analog_in_t  adc;                           
    i2c_master_t i2c;                           
    uint8_t slave_address;                      
    hallcurrent11_drv_t  drv_sel;               
    hallcurrent11_master_io_t  read_adc_f;      
} hallcurrent11_t;
 
typedef struct
{
    pin_name_t  an;                         
    analog_in_resolution_t  resolution;     
    float                   vref;           
    pin_name_t  scl;                        
    pin_name_t  sda;                        
    uint32_t  i2c_speed;                    
    uint8_t   i2c_address;                  
    hallcurrent11_drv_t  drv_sel;            
} hallcurrent11_cfg_t;
 
typedef enum
{
   HALLCURRENT11_OK = 0,
   HALLCURRENT11_ERROR = -1
 
} hallcurrent11_return_value_t;
 
void hallcurrent11_cfg_setup ( hallcurrent11_cfg_t *cfg );
 
err_t hallcurrent11_init ( hallcurrent11_t *ctx, hallcurrent11_cfg_t *cfg );
 
err_t hallcurrent11_default_cfg ( hallcurrent11_t *ctx );
 
err_t hallcurrent11_get_adc ( hallcurrent11_t *ctx, uint16_t *data_out );
 
err_t hallcurrent11_get_adc_voltage ( hallcurrent11_t *ctx, float *adc_vtg );
 
err_t hallcurrent11_get_current ( hallcurrent11_t *ctx, float *current );
 
err_t hallcurrent11_read_an_pin_voltage ( hallcurrent11_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT11_H
 
 // hallcurrent11
 
// ------------------------------------------------------------------------ END