hallcurrent16.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 HALLCURRENT16_H
#define HALLCURRENT16_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_spi_master.h"
#include "spi_specifics.h"
 
#define HALLCURRENT16_ADDR_IN_CH_SEL_1          0x00
#define HALLCURRENT16_ADDR_IN_CH_SEL_2          0x08
 
#define HALLCURRENT16_RESOLUTION_12BIT          0x0FFFu
#define HALLCURRENT16_VREF_3V3                  3.3f
#define HALLCURRENT16_VREF_5V                   5.0f
 
#define HALLCURRENT16_SENS_CALC_GAIN_0          26.4f
#define HALLCURRENT16_SENS_CALC_GAIN_1          33.0f
#define HALLCURRENT16_SENS_CALC_GAIN_2          39.6f
#define HALLCURRENT16_SENS_CALC_GAIN_3          19.8f
 
#define HALLCURRENT16_ADC_NUM_OF_MEASURE        1000u
#define HALLCURRENT16_CONV_TO_MILI              1000.0f
 
#define HALLCURRENT16_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define HALLCURRENT16_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // hallcurrent16_set
 
#define HALLCURRENT16_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.ocf = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hallcurrent16_map
 // hallcurrent16
 
typedef enum
{
    HALLCURRENT16_GAIN_0 = 0,
    HALLCURRENT16_GAIN_1,
    HALLCURRENT16_GAIN_2,
    HALLCURRENT16_GAIN_3
 
} hallcurrent16_gain_t;
 
typedef struct
{
    // Input pins
    digital_in_t ocf;                
    // Modules
    spi_master_t spi;                
    pin_name_t   chip_select;        
    float                   vref;    
    hallcurrent16_gain_t    gain;    
    float                   sens;    
} hallcurrent16_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;    
    pin_name_t mosi;    
    pin_name_t sck;     
    pin_name_t cs;      
    // Additional gpio pins
    pin_name_t ocf;    
    // static variable
    uint32_t                          spi_speed;      
    spi_master_mode_t                 spi_mode;       
    spi_master_chip_select_polarity_t cs_polarity;    
    float                   vref;    
    hallcurrent16_gain_t    gain;    
} hallcurrent16_cfg_t;
 
typedef enum
{
    HALLCURRENT16_OK = 0,
    HALLCURRENT16_ERROR = -1
 
} hallcurrent16_return_value_t;
 
void hallcurrent16_cfg_setup ( hallcurrent16_cfg_t *cfg );
 
err_t hallcurrent16_init ( hallcurrent16_t *ctx, hallcurrent16_cfg_t *cfg );
 
err_t hallcurrent16_default_cfg ( hallcurrent16_t *ctx );
 
void hallcurrent16_set_vref ( hallcurrent16_t *ctx, float vref );
 
void hallcurrent16_set_sens ( hallcurrent16_t *ctx );
 
err_t hallcurrent16_get_voltage ( hallcurrent16_t *ctx, float *voltage );
 
err_t hallcurrent16_get_vout ( hallcurrent16_t *ctx, float *adc_vout );
 
err_t hallcurrent16_get_vref ( hallcurrent16_t *ctx, float *adc_vref );
 
err_t hallcurrent16_get_current ( hallcurrent16_t *ctx, float *current );
 
uint8_t hallcurrent16_get_ovc_fault ( hallcurrent16_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT16_H
 
 // hallcurrent16
 
// ------------------------------------------------------------------------ END