battmon4.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 BATTMON4_H
#define BATTMON4_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 BATTMON4_REG_A                      0x01
#define BATTMON4_REG_B                      0x02
#define BATTMON4_REG_C                      0x03
#define BATTMON4_REG_D                      0x04
#define BATTMON4_REG_E                      0x05
#define BATTMON4_REG_F                      0x06
#define BATTMON4_REG_G                      0x07
#define BATTMON4_REG_H                      0x08
 
 // battmon4_reg
 
#define BATTMON4_TEMPERATURE_LSB            0.784
#define BATTMON4_TEMPERATURE_OFFSET         41.0
#define BATTMON4_TEMPERATURE_RESOLUTION     0x00FF
#define BATTMON4_VOLTAGE_LSB                1.465
#define BATTMON4_VOLTAGE_RESOLUTION         0x0FFF
 
#define BATTMON4_DEVICE_ADDRESS             0x64
 
 // battmon4_set
 
#define BATTMON4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.bok = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // battmon4_map
 // battmon4
 
typedef struct
{
    // Input pins
    digital_in_t  bok;              
    digital_in_t  int_pin;          
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} battmon4_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  bok;                
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} battmon4_cfg_t;
 
typedef enum
{
    BATTMON4_OK = 0,
    BATTMON4_ERROR = -1
 
} battmon4_return_value_t;
 
void battmon4_cfg_setup ( battmon4_cfg_t *cfg );
 
err_t battmon4_init ( battmon4_t *ctx, battmon4_cfg_t *cfg );
 
err_t battmon4_write_register ( battmon4_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t battmon4_read_register ( battmon4_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t battmon4_get_die_temperature ( battmon4_t *ctx, float *temperature );
 
err_t battmon4_get_batt_in_voltage ( battmon4_t *ctx, float *v_ipeak_on, float *v_ipeak_off );
 
err_t battmon4_get_batt_out_voltage ( battmon4_t *ctx, float *v_ipeak_on, float *v_ipeak_off );
 
uint8_t battmon4_get_bok_pin ( battmon4_t *ctx );
 
uint8_t battmon4_get_int_pin ( battmon4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BATTMON4_H
 
 // battmon4
 
// ------------------------------------------------------------------------ END