Public function

Functions
void	boost_cfg_setup (boost_cfg_t *cfg)
	Config Object Initialization function.
err_t	boost_init (boost_t *ctx, boost_cfg_t *cfg)
	Initialization function.
void	boost_device_enable (boost_t *ctx)
	Device Enable function.
void	boost_device_disable (boost_t *ctx)
	Device Disable function.
void	boost_dac_setup (boost_t *ctx, boost_dac_cfg_t *cfg)
	DAC Setup function.
err_t	boost_dac_write (boost_t *ctx, uint16_t dac_val)
	DAC Write function.
float	boost_vout_read (boost_t *ctx)
	VOUT Read function.

Detailed Description

Function Documentation

boost_cfg_setup()

void boost_cfg_setup

(

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

boost_dac_setup()

void boost_dac_setup	(	boost_t *	ctx,
		boost_dac_cfg_t *	cfg )

DAC Setup function.

Parameters

ctx	Click object.
cfg	DAC configuration structure.

@description This function performs the setup of the DAC converter of the Boost click.

boost_dac_write()

err_t boost_dac_write	(	boost_t *	ctx,
		uint16_t	dac_val )

DAC Write function.

Parameters

ctx	Click object.
dac_val	DAC writing value [12-bit].

Returns

0 - Ok, (-1) - Error.

@description This function sets the DAC converter to the selected value and allows the output voltage changing.

boost_device_disable()

void boost_device_disable

(

boost_t *

ctx

)

Device Disable function.

Parameters

ctx	Click object.

@description This function puts the device to power OFF state.

boost_device_enable()

void boost_device_enable

(

boost_t *

ctx

)

Device Enable function.

Parameters

ctx	Click object.

@description This function puts the device to power ON state.

boost_init()

err_t boost_init	(	boost_t *	ctx,
		boost_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

Returns

0 - Ok, (-1) - Error.

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

boost_vout_read()

float boost_vout_read

(

boost_t *

ctx

)

VOUT Read function.

Parameters

ctx	Click object.

Returns

Output voltage level [V].

@description This function reads the output voltage level.