Public function

Functions
void	battman_cfg_setup (battman_cfg_t *cfg)
	Config Object Initialization function.
BATTMAN_RETVAL	battman_init (battman_t *ctx, battman_cfg_t *cfg)
	Initialization function.
void	battman_set_enable (battman_t *ctx, uint8_t state)
	Enable/Disable control.
uint8_t	battman_get_charging_indicator (battman_t *ctx)
	Charging indicator status.
uint8_t	battman_get_fault_indicator (battman_t *ctx)
	Fault indicator status.

Detailed Description

Function Documentation

battman_cfg_setup()

void battman_cfg_setup

(

battman_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

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

Note

All used pins will be set to unconnected state.

battman_get_charging_indicator()

uint8_t battman_get_charging_indicator

(

battman_t *

ctx

)

Charging indicator status.

Parameters

ctx	Click object.

Returns

status ( 0 or 1 )

@description Function for getting charging indicator status.

battman_get_fault_indicator()

uint8_t battman_get_fault_indicator

(

battman_t *

ctx

)

Fault indicator status.

Parameters

ctx	Click object.

Returns

status ( 0 or 1 )

@description Function for getting fault indicator status.

battman_init()

BATTMAN_RETVAL battman_init	(	battman_t *	ctx,
		battman_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

battman_set_enable()

void battman_set_enable	(	battman_t *	ctx,
		uint8_t	state )

Enable/Disable control.

Parameters

ctx	Click object.
state	1 = enable, 0 = disable

@description Controls the operation of the click.