charger5  2.0.0.0
Main Page

Charger 5 click

Charger 5 click is designed to charge Lithium-Ion and Lithium-Polymer batteries.

click Product page


Click library

  • Author : Nemanja Medakovic
  • Date : Nov 2019.
  • Type : SPI type

Software Support

We provide a library for the Charger5 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 Charger 5 Click driver.

Standard key functions :

Example key functions :

Examples Description

This example demonstrates the use of the Charger 5 click board.

The demo application is composed of two sections :

Application Init

Initializes peripherals and pins used for the Charger 5 click and prepares the Charger 5 click for properly working.

void application_init( void )
{
charger5_cfg_t charger5_cfg;
log_cfg_t console_cfg;
// Click initialization.
charger5_cfg_setup( &charger5_cfg );
CHARGER5_MAP_MIKROBUS( charger5_cfg, MIKROBUS_1 );
charger5_init( &charger5, &charger5_cfg );
charger5_default_cfg( &charger5 );
LOG_MAP_USB_UART( console_cfg );
log_init( &console, &console_cfg );
log_write( &console, "*** Charger 5 initialization done ***",
LOG_FORMAT_LINE );
log_write( &console, "***************************************",
LOG_FORMAT_LINE );
}

Application Task

Demonstrates the use of driver functions. It will set charging current to 500 mA, then will increment that value by 10 steps, and after that will decrement it by 5 steps.

void application_task( void )
{
log_write( &console, "Output current is set to 500 mA.",
LOG_FORMAT_LINE );
Delay_ms( 3000 );
log_write( &console, "Output current value is incremented by 10 steps.",
LOG_FORMAT_LINE );
Delay_ms( 3000 );
log_write( &console, "Output current value is decremented by 5 steps.",
LOG_FORMAT_LINE );
Delay_ms( 3000 );
}

Note

Increment/decrement command can only be issued to volatile memory locations.

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

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.


charger5_init
charger5_err_t charger5_init(charger5_t *ctx, charger5_cfg_t *cfg)
Click Initialization function.
charger5_cfg_t
Click configuration structure definition.
Definition: charger5.h:155
CHARGER5_CURRENT_500MA
#define CHARGER5_CURRENT_500MA
Definition: charger5.h:86
charger5_decrement_wiper
charger5_err_t charger5_decrement_wiper(charger5_t *ctx, uint8_t reg_addr, uint8_t n_steps)
Decrement Wiper function.
CHARGER5_STEPS_5
#define CHARGER5_STEPS_5
Definition: charger5.h:100
application_task
void application_task(void)
Definition: main.c:64
CHARGER5_STEPS_10
#define CHARGER5_STEPS_10
Definition: charger5.h:101
charger5_increment_wiper
charger5_err_t charger5_increment_wiper(charger5_t *ctx, uint8_t reg_addr, uint8_t n_steps)
Increment Wiper function.
charger5_generic_write
charger5_err_t charger5_generic_write(charger5_t *ctx, uint8_t reg_addr, uint16_t transfer_data)
Generic Write function.
charger5_cfg_setup
void charger5_cfg_setup(charger5_cfg_t *cfg)
Configuration Object Setup function.
application_init
void application_init(void)
Definition: main.c:38
CHARGER5_MAP_MIKROBUS
#define CHARGER5_MAP_MIKROBUS(cfg, mikrobus)
Definition: charger5.h:113
charger5_default_cfg
void charger5_default_cfg(charger5_t *ctx)
Click Default Configuration function.
CHARGER5_REG_WIPER0_VOL
#define CHARGER5_REG_WIPER0_VOL
Definition: charger5.h:60