battman3  2.0.0.0
Main Page

BATT-MAN 3 click

BATT-MAN 3 Click is a compact add-on board representing an advanced battery management solution. This board features the ADP5350, a power management IC with inductive boost LED, and three LDO regulators from Analog Devices. This I2C programmable board supports USB optimized for USB voltage input. It combines one high-performance buck regulator for single Li-Ion/Li-Ion polymer battery charging, a fuel gauge, a highly programmable boost regulator for LED backlight illumination, and three 150mA LDO regulators.

click Product page


Click library

  • Author : Luka Filipovic
  • Date : Oct 2021.
  • Type : I2C type

Software Support

We provide a library for the BATT-MAN3 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for BATT-MAN3 Click driver.

Standard key functions :

Example key functions :

Example Description

This example showcases ability of device to charge battery,

and outputs and supply 4 different devices with 3 LDO's and 1 boost channel.

The demo application is composed of two sections :

Application Init

Initialization of the communication modules(UART, I2C) and 3 additional

input pins(power good, battery ok, and interrupt). Configures device to enable charging, battery voltage monitoring, sets charging termination to 3.7V, charging threshold to 3.1V and dead battery to 2.5V. Enables all 3 LDO's( channel 1 -> 3.3V, channel 2 -> 1.5V, and channel 3 -> 2.5V ).

void application_init ( void )
{
log_cfg_t log_cfg;
battman3_cfg_t battman3_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
battman3_cfg_setup( &battman3_cfg );
BATTMAN3_MAP_MIKROBUS( battman3_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == battman3_init( &battman3, &battman3_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( BATTMAN3_ERROR == battman3_default_cfg ( &battman3 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
uint8_t temp_data = 0;
log_printf( &logger, " > ID: 0x%.2X\r\n", ( uint16_t )temp_data );
log_printf( &logger, " > REV: 0x%.2X\r\n", ( uint16_t )temp_data );
//Charging voltage termination
//Charging voltage threshold
//LDO 1
//LDO 2
//LDO 3
log_info( &logger, " Application Task " );
Delay_ms( 500 );
}

Application Task

Reads battery voltage level and logs it. Besides that reads status and logs

every change on charging and battery status. If power good flag occurs(PGD pin goes low) disables LDO's, and reenables them when battery is full(when battery reaches charging termination voltage).

void application_task ( void )
{
static uint8_t counter = 0;
static uint8_t ldo_enable = 1;
float vbat = 0;
if ( !battman3_get_power_good( &battman3 ) && ldo_enable )
{
battman3_ldo( BATTMAN3_DISABLE );
log_printf( &logger, " > Power is not good - LDO disabled\r\n" );
ldo_enable = 0;
}
else if ( battman3_get_power_good( &battman3 ) && !ldo_enable )
{
battman3_ldo( BATTMAN3_ENABLE );
log_printf( &logger, " > Power is good - LDO enabled\r\n" );
ldo_enable = 1;
}
battman3_charge_status( );
if ( counter >= LOG_THRESHOLD_3SEC )
{
counter = 0;
battman3_get_battery_voltage( &battman3, &vbat );
log_printf( &logger, " > Battery voltage: %.2f\r\n", vbat );
log_printf( &logger, "****************************************************\r\n" );
}
counter++;
Delay_ms( 100 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.BATT-MAN3

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


battman3_ldo_vout_t
battman3_ldo_vout_t
BATT-MAN 3 Click LDO voltage output.
Definition: battman3.h:257
battman3_cfg_setup
void battman3_cfg_setup(battman3_cfg_t *cfg)
BATT-MAN 3 configuration object setup function.
LOG_THRESHOLD_3SEC
#define LOG_THRESHOLD_3SEC
Definition: main.c:38
BATTMAN3_DISABLE
#define BATTMAN3_DISABLE
Definition: battman3.h:169
battman3_default_cfg
err_t battman3_default_cfg(battman3_t *ctx)
BATT-MAN 3 default configuration function.
battman3_get_power_good
uint8_t battman3_get_power_good(battman3_t *ctx)
Get power good.
BATTMAN3_LDO_3p30V
@ BATTMAN3_LDO_3p30V
Definition: battman3.h:260
battman3_init
err_t battman3_init(battman3_t *ctx, battman3_cfg_t *cfg)
BATT-MAN 3 initialization function.
battman3_set_ldo_state
err_t battman3_set_ldo_state(battman3_t *ctx, battman3_ldo_t ldo, uint8_t enable)
Enable/Disable LDO.
application_task
void application_task(void)
Definition: main.c:118
BATTMAN3_LDO_1p50V
@ BATTMAN3_LDO_1p50V
Definition: battman3.h:268
battman3_reg_read
err_t battman3_reg_read(battman3_t *ctx, uint8_t reg, uint8_t *rx_data)
Register reading function.
BATTMAN3_ERROR
@ BATTMAN3_ERROR
Definition: battman3.h:248
battman3_set_ldo_vout
err_t battman3_set_ldo_vout(battman3_t *ctx, battman3_ldo_t ldo, battman3_ldo_vout_t vout)
Set voltage output on LDO.
battman3_t
BATT-MAN 3 Click context object.
Definition: battman3.h:209
BATTMAN3_LDO1
@ BATTMAN3_LDO1
Definition: battman3.h:283
BATTMAN3_REG_SILICON_REVSION
#define BATTMAN3_REG_SILICON_REVSION
Definition: battman3.h:70
BATTMAN3_LDO_2p50V
@ BATTMAN3_LDO_2p50V
Definition: battman3.h:264
BATTMAN3_REG_MANUFACTURE_AND_MODEL_ID
#define BATTMAN3_REG_MANUFACTURE_AND_MODEL_ID
BATT-MAN 3 description register.
Definition: battman3.h:69
battman3_set_charge_termination_voltage
err_t battman3_set_charge_termination_voltage(battman3_t *ctx, float voltage)
Set charge termination voltage.
battman3_set_charge_voltage_threshold
err_t battman3_set_charge_voltage_threshold(battman3_t *ctx, battman3_vtrk_dead_t vtrk_dead, float vweak)
Set charge termination voltage.
application_init
void application_init(void)
Definition: main.c:60
BATTMAN3_MAP_MIKROBUS
#define BATTMAN3_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: battman3.h:194
BATTMAN3_LDO2
@ BATTMAN3_LDO2
Definition: battman3.h:284
battman3_ldo_t
battman3_ldo_t
BATT-MAN 3 Click LDO.
Definition: battman3.h:282
BATTMAN3_LDO3
@ BATTMAN3_LDO3
Definition: battman3.h:285
BATTMAN3_VTRK_DEAD_2p5V
@ BATTMAN3_VTRK_DEAD_2p5V
Definition: battman3.h:296
battman3_get_battery_voltage
err_t battman3_get_battery_voltage(battman3_t *ctx, float *vout)
Read battery voltage level.
battman3_cfg_t
BATT-MAN 3 Click configuration object.
Definition: battman3.h:228
BATTMAN3_ENABLE
#define BATTMAN3_ENABLE
BATT-MAN 3 acitve state.
Definition: battman3.h:168