Step Down 3 Click Driver

API for configuring and manipulating Step Down 3 Click driver. More...

Topics
	Step Down 3 Settings
	Settings of Step Down 3 Click driver.
	Step Down 3 MikroBUS Map
	MikroBUS pin mapping of Step Down 3 Click driver.

Functions
void	stepdown3_cfg_setup (stepdown3_cfg_t *cfg)
	Step Down 3 configuration object setup function.
err_t	stepdown3_init (stepdown3_t *ctx, stepdown3_cfg_t *cfg)
	Step Down 3 initialization function.
void	stepdown3_enable_device (stepdown3_t *ctx)
	Step Down 3 enable device function.
void	stepdown3_disable_device (stepdown3_t *ctx)
	Step Down 3 disable device function.
void	stepdown3_enable_aux_output (stepdown3_t *ctx)
	Step Down 3 enable aux output function.
void	stepdown3_disable_aux_output (stepdown3_t *ctx)
	Step Down 3 disable aux output function.
void	stepdown3_set_output_voltage (stepdown3_t *ctx, uint8_t vout)
	Step Down 3 set output voltage function.

Detailed Description

API for configuring and manipulating Step Down 3 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

stepdown3_cfg_setup()

void stepdown3_cfg_setup

(

stepdown3_cfg_t *

cfg

)

Step Down 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See stepdown3_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

stepdown3_disable_aux_output()

void stepdown3_disable_aux_output

(

stepdown3_t *

ctx

)

Step Down 3 disable aux output function.

This function disables the auxiliary output (VOUT_AUX) by setting the AUX pin to LOW logic state.

Parameters

[in]

ctx

: Click context object. See stepdown3_t object definition for detailed explanation.

Returns

None.

Note

None.

stepdown3_disable_device()

void stepdown3_disable_device

(

stepdown3_t *

ctx

)

Step Down 3 disable device function.

This function disables the device by setting the EN pin to LOW logic state.

Parameters

[in]

ctx

: Click context object. See stepdown3_t object definition for detailed explanation.

Returns

None.

Note

None.

stepdown3_enable_aux_output()

void stepdown3_enable_aux_output

(

stepdown3_t *

ctx

)

Step Down 3 enable aux output function.

This function enables the auxiliary output (VOUT_AUX) by setting the AUX pin to HIGH logic state.

Parameters

[in]

ctx

: Click context object. See stepdown3_t object definition for detailed explanation.

Returns

None.

Note

None.

stepdown3_enable_device()

void stepdown3_enable_device

(

stepdown3_t *

ctx

)

Step Down 3 enable device function.

This function enables the device by setting the EN pin to HIGH logic state.

Parameters

[in]

ctx

: Click context object. See stepdown3_t object definition for detailed explanation.

Returns

None.

Note

None.

stepdown3_init()

err_t stepdown3_init	(	stepdown3_t *	ctx,
		stepdown3_cfg_t *	cfg )

Step Down 3 initialization function.

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

Parameters

[out]	ctx	: Click context object. See stepdown3_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See stepdown3_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

stepdown3_set_output_voltage()

void stepdown3_set_output_voltage	(	stepdown3_t *	ctx,
		uint8_t	vout )

Step Down 3 set output voltage function.

This function sets the output voltage by setting the D2, D1, and D0 pins to a desired state.

Parameters

[in]	ctx	: Click context object. See stepdown3_t object definition for detailed explanation.
[in]	vout	: Voltage output 0 - 1.6 V, 1 - 1.8 V, 2 - 2.1 V, 3 - 2.5 V, 4 - 2.7 V, 5 - 2.8 V, 6 - 3.0 V, 7 - 3.3 V.

Returns

None.

Note

None.