currentlimit9.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 CURRENTLIMIT9_H
#define CURRENTLIMIT9_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 CURRENTLIMIT9_CMD_VREG              0x11
#define CURRENTLIMIT9_CMD_NVREG             0x21
#define CURRENTLIMIT9_CMD_VREGxNVREG        0x51
#define CURRENTLIMIT9_CMD_NVREGxVREG        0x61
 
 // currentlimit9_reg
 
#define CURRENTLIMIT9_WIPER_POS_MIN         0
#define CURRENTLIMIT9_WIPER_POS_MIDDLE      127
#define CURRENTLIMIT9_WIPER_POS_MAX         255
#define CURRENTLIMIT9_RES_200_KOHM          200.0f
 
#define CURRENTLIMIT9_FAULT_FLAG            0
 
#define CURRENTLIMIT9_RESISTANCE            200.0f, 39.9f, 10.0f, 5.0f, 2.7f, 2.2f, 1.5f
 
#define CURRENTLIMIT9_DEVICE_ADDRESS        0x28
 
 // currentlimit9_set
 
#define CURRENTLIMIT9_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 )
 
 // currentlimit9_map
 // currentlimit9
 
typedef struct
{
    // Output pins
    digital_out_t on;    
    // Input pins
    digital_in_t flt;    
    // Modules
    i2c_master_t i2c;    
    // I2C slave address
    uint8_t slave_address;    
} currentlimit9_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;     
} currentlimit9_cfg_t;
 
typedef enum
{
    CURRENTLIMIT9_OK = 0,
    CURRENTLIMIT9_ERROR = -1
 
} currentlimit9_return_value_t;
 
typedef enum
{
    CURRENTLIMIT9_LIMIT_0_11_A = 0,
    CURRENTLIMIT9_LIMIT_0_46_A,
    CURRENTLIMIT9_LIMIT_1_17_A,
    CURRENTLIMIT9_LIMIT_1_55_A,
    CURRENTLIMIT9_LIMIT_1_67_A,
    CURRENTLIMIT9_LIMIT_1_84_A,
    CURRENTLIMIT9_LIMIT_1_90_A
 
} currentlimit9_limit_t;
 
void currentlimit9_cfg_setup ( currentlimit9_cfg_t *cfg );
 
err_t currentlimit9_init ( currentlimit9_t *ctx, currentlimit9_cfg_t *cfg );
 
err_t currentlimit9_default_cfg ( currentlimit9_t *ctx );
 
void currentlimit9_enable ( currentlimit9_t *ctx );
 
void currentlimit9_disable ( currentlimit9_t *ctx );
 
err_t currentlimit9_write_data ( currentlimit9_t *ctx, uint8_t cmd, uint8_t data_in );
 
err_t currentlimit9_set_wiper_pos ( currentlimit9_t *ctx, uint8_t wiper_pos );
 
err_t currentlimit9_set_resistance ( currentlimit9_t *ctx, float res_kohm );
 
err_t currentlimit9_set_limit ( currentlimit9_t *ctx, currentlimit9_limit_t current_limit );
 
uint8_t currentlimit9_get_fault ( currentlimit9_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTLIMIT9_H
 
 // currentlimit9
 
// ------------------------------------------------------------------------ END