batterysource  2.1.0.0
Modules | Functions
Battery Source Click Driver

API for configuring and manipulating Battery Source Click driver. More...

Modules

 Battery Source Registers Settings
 Settings for registers of Battery Source Click driver.
 
 Battery Source MikroBUS Map
 MikroBUS pin mapping of Battery Source Click driver.
 

Functions

void batterysource_cfg_setup (batterysource_cfg_t *cfg)
 Battery Source configuration object setup function. More...
 
err_t batterysource_init (batterysource_t *ctx, batterysource_cfg_t *cfg)
 Battery Source initialization function. More...
 
void batterysource_set_output (batterysource_t *ctx, uint8_t output_state)
 Battery Source set output state function. More...
 

Detailed Description

API for configuring and manipulating Battery Source 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

◆ batterysource_cfg_setup()

void batterysource_cfg_setup ( batterysource_cfg_t cfg)

Battery Source configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ batterysource_init()

err_t batterysource_init ( batterysource_t ctx,
batterysource_cfg_t cfg 
)

Battery Source initialization function.

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

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

◆ batterysource_set_output()

void batterysource_set_output ( batterysource_t ctx,
uint8_t  output_state 
)

Battery Source set output state function.

This function is used to set output state of Battery Source Click board.

Parameters
[in]ctx: Click context object. See batterysource_t object definition for detailed explanation.
[in]output_state: State of the output.
Returns
Nothing.
Note
None.