battboost2 2.1.0.0
Main Page

BATT Boost 2 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Stefan Ilic
  • Date : Feb 2024.
  • Type : I2C type

Software Support

We provide a library for the BATT Boost 2 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 Boost 2 Click driver.

Standard key functions :

Example key functions :

  • battboost2_set_vset This function is used to control the output voltage levels of the NBM7100ABQX, Coin cell battery life booster with adaptive power optimization on the BATT Boost 2 Click board.
    err_t battboost2_set_vset ( battboost2_t *ctx, float vset );
    err_t battboost2_set_vset(battboost2_t *ctx, float vset)
    BATT Boost 2 sets the output voltage function.
  • battboost2_high_impedance_mode This function is used to configures the VDH high-impedance mode in Standby and Active states of the NBM7100ABQX, Coin cell battery life booster with adaptive power optimization on the BATT Boost 2 Click board.
    err_t battboost2_high_impedance_mode(battboost2_t *ctx)
    BATT Boost 2 sets the high-impedance mode function.
  • battboost2_set_on_pin_state This function sets the desired states of the ON (RST) pin of the NBM7100ABQX, Coin cell battery life booster with adaptive power optimization on the BATT Boost 2 Click board.
    void battboost2_set_on_pin_state ( battboost2_t *ctx, uint8_t start );
    void battboost2_set_on_pin_state(battboost2_t *ctx, uint8_t start)
    BATT Boost 2 sets the ON pin state function.

Example Description

This library contains API for the BATT Boost 2 Click driver.

This driver provides the functions to control battery energy management device designed to maximize usable capacity from non-rechargeable.

The demo application is composed of two sections :

Application Init

Initialization of I2C module and log UART.

After driver initialization, the app executes a default configuration, sets the output voltage to 1.8V, charge current to 16mA, and early warning voltage to 2.6V.

void application_init ( void )
{
log_cfg_t log_cfg;
battboost2_cfg_t battboost2_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
battboost2_cfg_setup( &battboost2_cfg );
BATTBOOST2_MAP_MIKROBUS( battboost2_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == battboost2_init( &battboost2, &battboost2_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( BATTBOOST2_ERROR == battboost2_default_cfg ( &battboost2 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
Delay_ms( 100 );
}
@ BATTBOOST2_ERROR
Definition: battboost2.h:314
#define BATTBOOST2_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: battboost2.h:261
void application_init(void)
Definition: main.c:41

Application Task

This example demonstrates the use of the BATT Boost 2 Click board.

The demo application uses two operations in two states: the charging state and the active state. First, when the device is in a Charge state, the external storage capacitor is charging from VBT using a constant current and displays storage capacitor voltage levels and charge cycle count. Upon completion of a Charge state, the device transitions to the Active state at which time VDH becomes a regulated voltage output of 1.8V (default configuration), displays storage capacitor voltage level, and monitors alarms for low output voltage (below 1.8V) and early warning (below 2.4V). Results are being sent to the UART Terminal, where you can track their changes.

void application_task ( void )
{
float vcap = 0;
uint8_t status = 0;
uint32_t chenergy = 0;
{
{
log_printf( &logger, "\nOperating state: Charge\r\n" );
}
if ( BATTBOOST2_OK == battboost2_get_vcap( &battboost2, &vcap ) )
{
log_printf( &logger, " Capacitor Voltage: %.2f V \r\n", vcap );
}
if ( BATTBOOST2_OK == battboost2_get_chenergy( &battboost2, &chenergy ) )
{
log_printf( &logger, " Charge cycle count: %lu \r\n", chenergy );
}
Delay_ms( 1000 );
}
else
{
{
log_printf( &logger, "\nOperating state: Active\r\n" );
if ( BATTBOOST2_OK == battboost2_get_vcap( &battboost2, &vcap ) )
{
log_printf( &logger, " Capacitor Voltage: %.2f V \r\n", vcap );
}
if ( BATTBOOST2_OK == battboost2_get_status( &battboost2, &status ) )
{
if ( BATTBOOST2_STATUS_EW & status )
{
log_printf( &logger, " Status: Early warning.\r\n" );
}
if ( BATTBOOST2_STATUS_ALRM & status )
{
log_printf( &logger, " Status: Low output voltage in the Active state.\r\n" );
}
}
}
Delay_ms( 1000 );
}
}
@ BATTBOOST2_OK
Definition: battboost2.h:313
#define BATTBOOST2_STATUS_READY
Definition: battboost2.h:235
#define BATTBOOST2_OP_MODE_ACTIVE
Definition: battboost2.h:185
#define BATTBOOST2_STATUS_ALRM
Definition: battboost2.h:102
#define BATTBOOST2_STATUS_EW
Definition: battboost2.h:101
#define BATTBOOST2_OP_MODE_CHARGE
Definition: battboost2.h:182
err_t battboost2_set_op_mode(battboost2_t *ctx, uint8_t op_mode)
BATT Boost 2 sets the operating mode function.
uint8_t battboost2_get_ready(battboost2_t *ctx)
BATT Boost 2 gets ready state function.
err_t battboost2_get_status(battboost2_t *ctx, uint8_t *status)
BATT Boost 2 gets the status function.
err_t battboost2_get_vcap(battboost2_t *ctx, float *vcap)
BATT Boost 2 gets the storage capacitor voltage status function.
err_t battboost2_get_chenergy(battboost2_t *ctx, uint32_t *chenergy)
BATT Boost 2 gets the charge cycle count function.
void application_task(void)
Definition: main.c:78

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.BATTBoost2

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.