balancer5  2.0.0.0
Main Page

Balancer 5 click

Balancer 5 Click is an intelligent 2-cell Li-Ion battery charger, system power manager, and a battery fuel gauge Click boardâ„¢. Balancer 5 click is based on BQ25887 controller which has some extra features enabling charging without too much hassle.

click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the Balancer5 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Balancer5 Click driver.

Standard key functions :

  • Config Object Initialization function.

    void balancer5_cfg_setup ( balancer5_cfg_t *cfg );

  • Initialization function.

    BALANCER5_RETVAL balancer5_init ( balancer5_t *ctx, balancer5_cfg_t *cfg );

  • Click Default Configuration function.

    void balancer5_default_cfg ( balancer5_t *ctx );

Example key functions :

  • This function sets charging status.

    void balancer5_charge ( balancer5_t *ctx, uint8_t state );

Examples Description

This demo performs neccessary initializations, reads ADC values from click registers and logs it.

The demo application is composed of two sections :

Application Init

Initializes Click and Driver, Checks Device ID, starts charging, reads charge status registers and configures ADC.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
BALANCER5_MAP_MIKROBUS( cfg, MIKROBUS_1 );
balancer5_init( &balancer5, &cfg );
// Device ID sanity check
temp_data = balancer5_check_id( &balancer5 );
if ( temp_data == BALANCER5_ERROR_ID )
{
log_info( &logger, "ID ERROR!!!" );
for ( ; ; );
}
log_info( &logger, "***** ID OK *****" );
// Switch charger on
// Send configuration info to logger
// Set default configuration
balancer5_default_cfg ( &balancer5 );
}

Application Task

Reads ADC values from registers and logs it.

void application_task ( void )
{
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_IBUS_ADC1 );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_IBUS_ADC0 );
temp_uint_data |= temp_data;
log_printf( &logger, "- IBUS: %umA\r\n", temp_uint_data );
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_ICHG_ADC1 );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_ICHG_ADC0 );
temp_uint_data |= temp_data;
log_printf( &logger, "- ICHG: %umA\r\n", temp_uint_data );
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_VBAT_ADC1 );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_VBAT_ADC0 );
temp_uint_data |= temp_data;
log_printf( &logger, "- VBAT: %umV\r\n", temp_uint_data );
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_VBUS_ADC1 );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_VBUS_ADC0 );
temp_uint_data |= temp_data;
log_printf( &logger, "- VBUS: %umV\r\n", temp_uint_data );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_uint_data |= temp_data;
log_printf( &logger, "- VCELLTOP: %umV\r\n", temp_uint_data );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_uint_data |= temp_data;
log_printf( &logger, "- VCELLBOT: %umV\r\n", temp_uint_data );
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_TS_ADC1 );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_TS_ADC0 );
temp_uint_data |= temp_data;
temp_float_data = temp_uint_data;
temp_float_data *= 0.098;
log_printf( &logger, "- TS: %.2f%%\r\n", temp_float_data );
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_TDIE_ADC1 );
temp_uint_data = temp_data;
temp_uint_data <<= 8;
temp_data = balancer5_read_data( &balancer5, BALANCER5_REG_TDIE_ADC0 );
temp_uint_data |= temp_data;
temp_float_data = temp_uint_data;
temp_float_data *= 0.5;
log_printf( &logger, "- TDIE: %.2f%s\r\n", temp_float_data, log_degree );
log_printf( &logger, "____________________\r\n" );
Delay_ms( 5000 );
}

Note

Additional functions charger_status_1_handler() and charger_status_2_handler() are used to log charger status 1 and 2.

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Balancer5

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


BALANCER5_REG_IBUS_ADC0
#define BALANCER5_REG_IBUS_ADC0
Definition: balancer5.h:99
BALANCER5_REG_IBUS_ADC1
#define BALANCER5_REG_IBUS_ADC1
Definition: balancer5.h:98
balancer5_cfg_t
Click configuration structure definition.
Definition: balancer5.h:245
BALANCER5_REG_TS_ADC1
#define BALANCER5_REG_TS_ADC1
Definition: balancer5.h:108
balancer5_read_data
uint8_t balancer5_read_data(balancer5_t *ctx, uint8_t reg_addr)
Generic function for reading one Byte data from registar.
BALANCER5_REG_ICHG_ADC0
#define BALANCER5_REG_ICHG_ADC0
Definition: balancer5.h:101
BALANCER5_REG_CHARGER_STATUS_1
#define BALANCER5_REG_CHARGER_STATUS_1
Definition: balancer5.h:86
BALANCER5_REG_ICHG_ADC1
#define BALANCER5_REG_ICHG_ADC1
Definition: balancer5.h:100
BALANCER5_REG_TS_ADC0
#define BALANCER5_REG_TS_ADC0
Definition: balancer5.h:109
application_task
void application_task(void)
Definition: main.c:238
BALANCER5_REG_TDIE_ADC0
#define BALANCER5_REG_TDIE_ADC0
Definition: balancer5.h:111
BALANCER5_REG_VBUS_ADC1
#define BALANCER5_REG_VBUS_ADC1
Definition: balancer5.h:102
BALANCER5_REG_TDIE_ADC1
#define BALANCER5_REG_TDIE_ADC1
Definition: balancer5.h:110
BALANCER5_REG_VBUS_ADC0
#define BALANCER5_REG_VBUS_ADC0
Definition: balancer5.h:103
BALANCER5_REG_CHARGER_STATUS_2
#define BALANCER5_REG_CHARGER_STATUS_2
Definition: balancer5.h:87
balancer5_check_id
uint8_t balancer5_check_id(balancer5_t *ctx)
Checks if device ID is good.
BALANCER5_REG_VCELLBOT_ADC1
#define BALANCER5_REG_VCELLBOT_ADC1
Definition: balancer5.h:113
charger_status_1_handler
void charger_status_1_handler(uint8_t cs1_data)
Definition: main.c:41
balancer5_cfg_setup
void balancer5_cfg_setup(balancer5_cfg_t *cfg)
Config Object Initialization function.
balancer5_default_cfg
void balancer5_default_cfg(balancer5_t *ctx)
Click Default Configuration function.
balancer5_init
BALANCER5_RETVAL balancer5_init(balancer5_t *ctx, balancer5_cfg_t *cfg)
Initialization function.
BALANCER5_ERROR_ID
#define BALANCER5_ERROR_ID
Definition: balancer5.h:126
application_init
void application_init(void)
Definition: main.c:184
BALANCER5_REG_VCELLBOT_ADC0
#define BALANCER5_REG_VCELLBOT_ADC0
Definition: balancer5.h:114
charger_status_2_handler
void charger_status_2_handler(uint8_t cs2_data)
Definition: main.c:118
BALANCER5_MAP_MIKROBUS
#define BALANCER5_MAP_MIKROBUS(cfg, mikrobus)
Definition: balancer5.h:53
BALANCER5_REG_VBAT_ADC0
#define BALANCER5_REG_VBAT_ADC0
Definition: balancer5.h:105
BALANCER5_REG_VCELLTOP_ADC0
#define BALANCER5_REG_VCELLTOP_ADC0
Definition: balancer5.h:107
BALANCER5_REG_VBAT_ADC1
#define BALANCER5_REG_VBAT_ADC1
Definition: balancer5.h:104
BALANCER5_CHARGE_ON
#define BALANCER5_CHARGE_ON
Definition: balancer5.h:148
balancer5_charge
void balancer5_charge(balancer5_t *ctx, uint8_t state)
Function for setting charging status.
BALANCER5_REG_VCELLTOP_ADC1
#define BALANCER5_REG_VCELLTOP_ADC1
Definition: balancer5.h:106