currentlimit5.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 CURRENTLIMIT5_H
#define CURRENTLIMIT5_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 CURRENTLIMIT5_DIGIPOT_MAX_VALUE     5000
#define CURRENTLIMIT5_DIGIPOT_OFFSET        80
#define CURRENTLIMIT5_DIGIPOT_RESOLUTION    257
#define CURRENTLIMIT5_ROUND_TO_NEAREST_INT  0.5
 
#define CURRENTLIMIT5_SET_DEV_ADDR          0x2F
 
 // currentlimit5_set
 
#define CURRENTLIMIT5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.fault = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // currentlimit5_map
 // currentlimit5
 
typedef struct
{
    // Output pins
    digital_out_t  en;          
    // Input pins
    digital_in_t  fault;        
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} currentlimit5_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  en;             
    pin_name_t  fault;          
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} currentlimit5_cfg_t;
 
typedef enum
{
    CURRENTLIMIT5_OK = 0,
    CURRENTLIMIT5_ERROR = -1
 
} currentlimit5_return_value_t;
 
typedef enum
{
    CURRENTLIMIT5_ILIMIT_100mA = 0,
    CURRENTLIMIT5_ILIMIT_200mA,
    CURRENTLIMIT5_ILIMIT_300mA,
    CURRENTLIMIT5_ILIMIT_400mA,
    CURRENTLIMIT5_ILIMIT_500mA,
    CURRENTLIMIT5_ILIMIT_600mA,
    CURRENTLIMIT5_ILIMIT_700mA,
    CURRENTLIMIT5_ILIMIT_800mA,
    CURRENTLIMIT5_ILIMIT_900mA,
    CURRENTLIMIT5_ILIMIT_1000mA,
    CURRENTLIMIT5_ILIMIT_1100mA,
 
} currentlimit5_ilimit_t;
 
void currentlimit5_cfg_setup ( currentlimit5_cfg_t *cfg );
 
err_t currentlimit5_init ( currentlimit5_t *ctx, currentlimit5_cfg_t *cfg );
 
err_t currentlimit5_default_cfg ( currentlimit5_t *ctx );
 
err_t currentlimit5_set_ilimit ( currentlimit5_t *ctx, currentlimit5_ilimit_t ilimit );
 
uint8_t currentlimit5_get_fault_pin ( currentlimit5_t *ctx );
 
void currentlimit5_enable_limit ( currentlimit5_t *ctx );
 
void currentlimit5_disable_limit ( currentlimit5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTLIMIT5_H
 
 // currentlimit5
 
// ------------------------------------------------------------------------ END