Public function

Functions
void	stepup_cfg_setup (stepup_cfg_t *cfg)
	Config Object Initialization function.
STEPUP_RETVAL	stepup_init (stepup_t *ctx, stepup_cfg_t *cfg)
	Initialization function.
void	stepup_default_cfg (stepup_t *ctx)
	Click Default Configuration function.
void	stepup_mod_set (stepup_t *ctx, uint8_t pin_state)
	Mod Pin set function.
void	stepup_en_set (stepup_t *ctx, uint8_t pin_state)
	En Pin set function.
void	stepup_dac_setup (stepup_t *ctx, stepup_dac_cfg_t *cfg)
	DAC Setup function.
err_t	stepup_dac_write (stepup_t *ctx, uint16_t dac_val)
	DAC Write function.
err_t	stepup_set_percentage (stepup_t *ctx, float percentage)
	Set DAC precetage up.

Detailed Description

Function Documentation

stepup_cfg_setup()

void stepup_cfg_setup

(

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

stepup_dac_setup()

void stepup_dac_setup	(	stepup_t *	ctx,
		stepup_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 Step up click.

stepup_dac_write()

err_t stepup_dac_write	(	stepup_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.

stepup_default_cfg()

void stepup_default_cfg

(

stepup_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.
out_value	Output value (range : 0 to 4095)

@description This function executes default configuration for Step Up click.

stepup_en_set()

void stepup_en_set	(	stepup_t *	ctx,
		uint8_t	pin_state )

En Pin set function.

Parameters

ctx	Click object.
pin_state	EN pin state (0 for LOW and 1 for HIGH)

@description This function sets the EN pin state

stepup_init()

STEPUP_RETVAL stepup_init	(	stepup_t *	ctx,
		stepup_cfg_t *	cfg )

Initialization function.

Parameters

stepup	Click object.
cfg	Click configuration structure.

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

stepup_mod_set()

void stepup_mod_set	(	stepup_t *	ctx,
		uint8_t	pin_state )

Mod Pin set function.

Parameters

ctx	Click object.
pin_state	MOD pin state (0 for LOW and 1 for HIGH)

@description This function sets the MOD pin state

stepup_set_percentage()

err_t stepup_set_percentage	(	stepup_t *	ctx,
		float	percentage )

Set DAC precetage up.

Parameters

ctx	Click object.
percentage	Percentage boost ( 0 - 100% )

Returns

0 - Ok, (-1) - Error.

@description This function sets the DAC percentage boost.