hallcurrent9.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 HALLCURRENT9_H
#define HALLCURRENT9_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 HALLCURRENT9_SET_DEV_ADDR    0x4D
 
 // hallcurrent9_set
 
#define HALLCURRENT9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // hallcurrent9_map
 // hallcurrent9
 
typedef struct
{
    // Input pins
 
    digital_in_t  an;         
    // Modules
 
    i2c_master_t i2c;         
    // I2C slave address
 
    uint8_t slave_address;    
} hallcurrent9_t;
 
typedef struct
{
    pin_name_t  scl;          
    pin_name_t  sda;          
    pin_name_t  an;           
    uint32_t  i2c_speed;      
    uint8_t   i2c_address;    
} hallcurrent9_cfg_t;
 
typedef struct
{
    uint16_t zero_adc_val;
    
} hallcurrent9_calibration_data_t;
 
typedef enum
{
    HALLCURRENT9_OK = 0,
    HALLCURRENT9_ERROR = -1
 
} hallcurrent9_return_value_t;
 
void hallcurrent9_cfg_setup ( hallcurrent9_cfg_t *cfg );
 
err_t hallcurrent9_init ( hallcurrent9_t *ctx, hallcurrent9_cfg_t *cfg );
 
err_t hallcurrent9_read_adc ( hallcurrent9_t *ctx, uint16_t *read_adc );
 
err_t hallcurrent9_set_calibration ( hallcurrent9_t *ctx, hallcurrent9_calibration_data_t *adc_val );
 
float hallcurrent9_get_current ( hallcurrent9_t *ctx, hallcurrent9_calibration_data_t *adc_val );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT9_H
 
 // hallcurrent9
 
// ------------------------------------------------------------------------ END