currentlimit10.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 CURRENTLIMIT10_H
#define CURRENTLIMIT10_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 CURRENTLIMIT10_CMD_VREG              0x11
#define CURRENTLIMIT10_CMD_NVREG             0x21
#define CURRENTLIMIT10_CMD_VREGxNVREG        0x51
#define CURRENTLIMIT10_CMD_NVREGxVREG        0x61
 
 // currentlimit10_reg
 
#define CURRENTLIMIT10_WIPER_POS_MIN         0
#define CURRENTLIMIT10_WIPER_POS_MIDDLE      127
#define CURRENTLIMIT10_WIPER_POS_MAX         255
#define CURRENTLIMIT10_RES_200_KOHM          200.0f
 
#define CURRENTLIMIT10_FAULT_FLAG            0
 
#define CURRENTLIMIT10_COEFF_MULTI           0.37f
#define CURRENTLIMIT10_TYP_V_ILIM_MV         289.0f
#define CURRENTLIMIT10_RES_L_20_KOHM         20.0f
#define CURRENTLIMIT10_LIMIT_MIN             0.5f
#define CURRENTLIMIT10_LIMIT_MAX             5.5f
 
#define CURRENTLIMIT10_DEVICE_ADDRESS        0x28
 
 // currentlimit10_set
 
#define CURRENTLIMIT10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );    \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );    \
    cfg.on  = MIKROBUS( mikrobus, MIKROBUS_RST );    \
    cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // currentlimit10_map
 // currentlimit10
 
typedef struct
{
    // Output pins
    digital_out_t on;    
    // Input pins
    digital_in_t flt;    
    float offset;        
    // Modules
    i2c_master_t i2c;    
    // I2C slave address
    uint8_t slave_address;    
} currentlimit10_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t on;     
    pin_name_t flt;    
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} currentlimit10_cfg_t;
 
typedef enum
{
    CURRENTLIMIT10_OK = 0,
    CURRENTLIMIT10_ERROR = -1
 
} currentlimit10_return_value_t;
 
void currentlimit10_cfg_setup ( currentlimit10_cfg_t *cfg );
 
err_t currentlimit10_init ( currentlimit10_t *ctx, currentlimit10_cfg_t *cfg );
 
err_t currentlimit10_default_cfg ( currentlimit10_t *ctx );
 
void currentlimit10_enable ( currentlimit10_t *ctx );
 
void currentlimit10_disable ( currentlimit10_t *ctx );
 
err_t currentlimit10_write_data ( currentlimit10_t *ctx, uint8_t cmd, uint8_t data_in );
 
err_t currentlimit10_set_wiper_pos ( currentlimit10_t *ctx, uint8_t wiper_pos );
 
err_t currentlimit10_set_resistance ( currentlimit10_t *ctx, float res_kohm );
 
err_t currentlimit10_set_limit ( currentlimit10_t *ctx, float current_limit );
 
uint8_t currentlimit10_get_fault ( currentlimit10_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTLIMIT10_H
 
 // currentlimit10
 
// ------------------------------------------------------------------------ END