batterysource  2.1.0.0
Main Page

Battery Source click

Battery Source Click is a compact add-on board designed to boost power from a battery for portable applications. This board features the TPS81256, a high-efficiency step-up converter from Texas Instruments. The board boosts input voltage (2.5V to 5.5V) to 5V/1A on a USB Type-C connector. It operates at a 4MHz switching frequency, enters Power-Save mode at light loads, and reduces supply current to 43μA during light load operation. The board supports over 3W output power and has an input current of less than 1µA in shutdown mode, maximizing battery life.

click Product page


Click library

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

Software Support

We provide a library for the Battery Source 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 Battery Source Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of Battery Source Click board,

by changing state of the output.

The demo application is composed of two sections :

Application Init

Initializes the driver and disables the output.

void application_init ( void )
{
log_cfg_t log_cfg;
batterysource_cfg_t batterysource_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
batterysource_cfg_setup( &batterysource_cfg );
BATTERYSOURCE_MAP_MIKROBUS( batterysource_cfg, MIKROBUS_1 );
if ( DIGITAL_OUT_UNSUPPORTED_PIN == batterysource_init( &batterysource, &batterysource_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Enabling output for 5 seconds, then disabling it for 5 seconds.

void application_task ( void )
{
log_printf( &logger, " Output is enabled \r\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
log_printf( &logger, " Output is disabled \r\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}

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

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.


BATTERYSOURCE_DISABLE_OUTPUT
#define BATTERYSOURCE_DISABLE_OUTPUT
Definition: batterysource.h:73
batterysource_t
Battery Source Click context object.
Definition: batterysource.h:102
application_task
void application_task(void)
Definition: main.c:60
BATTERYSOURCE_ENABLE_OUTPUT
#define BATTERYSOURCE_ENABLE_OUTPUT
Battery Source description setting.
Definition: batterysource.h:72
batterysource_cfg_t
Battery Source Click configuration object.
Definition: batterysource.h:112
BATTERYSOURCE_MAP_MIKROBUS
#define BATTERYSOURCE_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: batterysource.h:91
batterysource_set_output
void batterysource_set_output(batterysource_t *ctx, uint8_t output_state)
Battery Source set output state function.
batterysource_cfg_setup
void batterysource_cfg_setup(batterysource_cfg_t *cfg)
Battery Source configuration object setup function.
application_init
void application_init(void)
Definition: main.c:28
batterysource_init
err_t batterysource_init(batterysource_t *ctx, batterysource_cfg_t *cfg)
Battery Source initialization function.