current5.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 CURRENT5_H
#define CURRENT5_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 CURRENT5_VOLTAGE_GAIN               200.0
#define CURRENT5_VREF_mV                    3300.0
#define CURRENT5_RESOLUTION                 4096.0
#define CURRENT5_RSHUNT_mOHM                2.0
#define CURRENT5_GAIN_ERROR_PERCENTS        6.0
 
#define CURRENT5_SET_DATA_SAMPLE_EDGE       SET_SPI_DATA_SAMPLE_EDGE
#define CURRENT5_SET_DATA_SAMPLE_MIDDLE     SET_SPI_DATA_SAMPLE_MIDDLE
 
 // current5_set
 
#define CURRENT5_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.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.alert = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // current5_map
 // current5
 
typedef struct
{
    // Output pins
    digital_out_t  rst;         
    // Input pins
    digital_in_t  alert;        
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} current5_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  rst;    
    pin_name_t  alert;  
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} current5_cfg_t;
 
typedef enum
{
   CURRENT5_OK = 0,
   CURRENT5_ERROR = -1
 
} current5_return_value_t;
 
void current5_cfg_setup ( current5_cfg_t *cfg );
 
err_t current5_init ( current5_t *ctx, current5_cfg_t *cfg );
 
err_t current5_default_cfg ( current5_t *ctx );
 
err_t current5_generic_read ( current5_t *ctx, uint8_t *data_out, uint8_t len );
 
uint8_t current5_get_alert ( current5_t *ctx );
 
void current5_set_rst ( current5_t *ctx, uint8_t state );
 
err_t current5_get_adc ( current5_t *ctx, uint16_t *adc_data );
 
err_t current5_get_voltage ( current5_t *ctx, float *vout );
 
err_t current5_get_current ( current5_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENT5_H
 
 // current5
 
// ------------------------------------------------------------------------ END