hallcurrent7.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 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 HALLCURRENT7_H
#define HALLCURRENT7_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_i2c_master.h"
 
#define HALLCURRENT7_RESOLUTION                 4096
#define HALLCURRENT7_12_BIT_DATA              0x0FFF
#define HALLCURRENT7_ADC_NUM_OF_MEASURE        100.0
#define HALLCURRENT7_VREF_5000_mV             5000.0
 
#define HALLCURRENT7_ACS770LCB_050B_SENS        0.04
 
#define HALLCURRENT7_ERR_COR_FACTOR             1.05
 
#define HALLCURRENT7_SET_DEV_ADDR              0x4D
 
 // hallcurrent7_set
 
#define HALLCURRENT7_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define HALLCURRENT7_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // hallcurrent7_map
 // hallcurrent7
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} hallcurrent7_t;
typedef struct {…};
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} hallcurrent7_cfg_t;
typedef struct {…};
 
typedef enum
{
   HALLCURRENT7_OK = 0,
   HALLCURRENT7_ERROR = -1
 
} hallcurrent7_return_value_t;
typedef enum {…};
 
void hallcurrent7_cfg_setup ( hallcurrent7_cfg_t *cfg );
 
err_t hallcurrent7_init ( hallcurrent7_t *ctx, hallcurrent7_cfg_t *cfg );
 
err_t hallcurrent7_generic_write ( hallcurrent7_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t hallcurrent7_generic_read ( hallcurrent7_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint16_t hallcurrent7_read_data ( hallcurrent7_t *ctx );
 
uint16_t hallcurrent7_read_voltage ( hallcurrent7_t *ctx, uint16_t v_ref );
 
int16_t hallcurrent7_calc_current ( hallcurrent7_t *ctx, uint16_t v_ref );
 
int16_t hallcurrent7_avg_current ( hallcurrent7_t *ctx, uint16_t v_ref );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT7_H
 
 // hallcurrent7
 
// ------------------------------------------------------------------------ END