Public function

Functions
void	boost4_cfg_setup (boost4_cfg_t *cfg)
	Config Object Initialization function.
BOOST4_RETVAL	boost4_init (boost4_t *ctx, boost4_cfg_t *cfg)
	Initialization function.
void	boost4_enable (boost4_t *ctx, uint8_t state)
	Enable device function.
void	boost4_set_out_voltage (boost4_t *ctx, uint16_t value)
	Set output voltage function.

Detailed Description

Function Documentation

boost4_cfg_setup()

void boost4_cfg_setup

(

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

boost4_enable()

void boost4_enable	(	boost4_t *	ctx,
		uint8_t	state )

Enable device function.

Parameters

ctx	Click object.
state	0 - device disabled / 1 - device enabled.

@description Function is used to enabled or disabled the device.

boost4_init()

BOOST4_RETVAL boost4_init	(	boost4_t *	ctx,
		boost4_cfg_t *	cfg )

Initialization function.

Parameters

boost4	Click object.
cfg	Click configuration structure.

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

boost4_set_out_voltage()

void boost4_set_out_voltage	(	boost4_t *	ctx,
		uint16_t	value )

Set output voltage function.

Parameters

ctx	Click object.
value	12-bit data that defines output voltage.

@description Function set output voltage by write 12-bit data to the register on the TPS61230A High Efficiency Step-Up Converter of Boost 4 Click.