solarenergy 2.0.0.0

Functions

void solarenergy_cfg_setup (solarenergy_cfg_t *cfg)
 Config Object Initialization function.
 
SOLARENERGY_RETVAL solarenergy_init (solarenergy_t *ctx, solarenergy_cfg_t *cfg)
 Initialization function.
 
void solarenergy_charge_enable (solarenergy_t *ctx)
 Charge enable function.
 
void solarenergy_charge_disable (solarenergy_t *ctx)
 Charge disable functions.
 
uint8_t solarenergy_check_indicator (solarenergy_t *ctx)
 Battery good indicator functions.
 

Detailed Description

Function Documentation

◆ solarenergy_cfg_setup()

void solarenergy_cfg_setup ( solarenergy_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ solarenergy_charge_disable()

void solarenergy_charge_disable ( solarenergy_t * ctx)

Charge disable functions.

Parameters
ctxClick object.

@description Function disable charging by clear CS ( EN ) pin, disable BQ25570 Nano Power Boost Charger on Solar Energy click board.

◆ solarenergy_charge_enable()

void solarenergy_charge_enable ( solarenergy_t * ctx)

Charge enable function.

Parameters
ctxClick object.

@description Function enable charging by set CS ( EN ) pin, enable BQ25570 Nano Power Boost Charger on Solar Energy click board.

◆ solarenergy_check_indicator()

uint8_t solarenergy_check_indicator ( solarenergy_t * ctx)

Battery good indicator functions.

Parameters
ctxClick object.
Returns
battery good indicator state:
  • 0 : battery empty status;
  • 1 : battery full status;

@description Function get state of INT pin by check battery good indicator from BQ25570 Nano Power Boost Charger on Solar Energy click board.

◆ solarenergy_init()

SOLARENERGY_RETVAL solarenergy_init ( solarenergy_t * ctx,
solarenergy_cfg_t * cfg )

Initialization function.

Parameters
solarenergyClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.