charger16 2.0.0.0
Topics | Functions
Charger 16 Click Driver

API for configuring and manipulating Charger 16 Click driver. More...

Topics

 Charger 16 MikroBUS Map
 MikroBUS pin mapping of Charger 16 Click driver.
 

Functions

void charger16_cfg_setup (charger16_cfg_t *cfg)
 Charger 16 configuration object setup function.
 
err_t charger16_init (charger16_t *ctx, charger16_cfg_t *cfg)
 Charger 16 initialization function.
 
err_t charger16_default_cfg (charger16_t *ctx)
 Charger 16 default configuration function.
 
err_t charger16_enable_charging (charger16_t *ctx)
 Charger 16 enable charging function.
 
err_t charger16_disable_charging (charger16_t *ctx)
 Charger 16 disable charging function.
 

Detailed Description

API for configuring and manipulating Charger 16 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ charger16_cfg_setup()

void charger16_cfg_setup ( charger16_cfg_t * cfg)

Charger 16 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See charger16_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ charger16_default_cfg()

err_t charger16_default_cfg ( charger16_t * ctx)

Charger 16 default configuration function.

This function executes a default configuration of Charger 16 click board.

Parameters
[in]ctx: Click context object. See charger16_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ charger16_disable_charging()

err_t charger16_disable_charging ( charger16_t * ctx)

Charger 16 disable charging function.

This function disable charging of the LT1571 Constant-Current/Constant-Voltage Battery Chargers with Preset Voltage and Termination Flag on the Charger 16 click board™.

Parameters
[in]ctx: Click context object. See charger16_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ charger16_enable_charging()

err_t charger16_enable_charging ( charger16_t * ctx)

Charger 16 enable charging function.

This function enable charging of the LT1571 Constant-Current/Constant-Voltage Battery Chargers with Preset Voltage and Termination Flag on the Charger 16 click board™.

Parameters
[in]ctx: Click context object. See charger16_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ charger16_init()

err_t charger16_init ( charger16_t * ctx,
charger16_cfg_t * cfg )

Charger 16 initialization function.

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

Parameters
[out]ctx: Click context object. See charger16_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See charger16_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.