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

Topics
	Step Down 9 Registers Settings
	Settings for registers of Step Down 9 Click driver.

	Step Down 9 MikroBUS Map
	MikroBUS pin mapping of Step Down 9 Click driver.

Functions
void	stepdown9_cfg_setup (stepdown9_cfg_t *cfg)
	Step Down 9 configuration object setup function.

err_t	stepdown9_init (stepdown9_t ctx, stepdown9_cfg_t cfg)
	Step Down 9 initialization function.

err_t	stepdown9_default_cfg (stepdown9_t *ctx)
	Step Down 9 default configuration function.

err_t	stepdown9_generic_write (stepdown9_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	Step Down 9 data writing function.

err_t	stepdown9_generic_read (stepdown9_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	Step Down 9 data reading function.

void	stepdown9_set_en_pin (stepdown9_t *ctx, uint8_t pin_state)
	Step Down 9 set EN pin state function.

uint8_t	stepdown9_get_pg_pin (stepdown9_t *ctx)
	Step Down 9 get PG pin state function.

err_t	stepdown9_set_wiper_pos (stepdown9_t *ctx, uint8_t wiper_pos)
	Step Down 9 set wiper position.

err_t	stepdown9_set_resistance (stepdown9_t *ctx, uint32_t res_ohm)
	Step Down 9 set potentiometer resistance.

err_t	stepdown9_set_output (stepdown9_t *ctx, uint8_t voltage)
	Step Down 9 set output voltage.

Detailed Description

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

◆ stepdown9_cfg_setup()

void stepdown9_cfg_setup ( stepdown9_cfg_t * cfg )

Step Down 9 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See stepdown9_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ stepdown9_default_cfg()

err_t stepdown9_default_cfg ( stepdown9_t * ctx )

Step Down 9 default configuration function.

This function executes a default configuration of Step Down 9 click board.

Parameters

[in] ctx : Click context object. See stepdown9_t object definition for detailed explanation.

Returns

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

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ stepdown9_generic_read()

err_t stepdown9_generic_read	(	stepdown9_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

Step Down 9 data reading function.

This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See stepdown9_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

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

Note: None.

◆ stepdown9_generic_write()

err_t stepdown9_generic_write	(	stepdown9_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

Step Down 9 data writing function.

This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See stepdown9_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

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

Note: None.

◆ stepdown9_get_pg_pin()

uint8_t stepdown9_get_pg_pin ( stepdown9_t * ctx )

Step Down 9 get PG pin state function.

This function is used to get state of the PG pin.

Parameters

[out] cfg : Click configuration structure. See stepdown9_t object definition for detailed explanation.

Returns: State of the PG pin.

Note: None.

◆ stepdown9_init()

err_t stepdown9_init	(	stepdown9_t *	ctx,
		stepdown9_cfg_t *	cfg )

Step Down 9 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ stepdown9_set_en_pin()

void stepdown9_set_en_pin	(	stepdown9_t *	ctx,
		uint8_t	pin_state )

Step Down 9 set EN pin state function.

This function sets a EN pin state.

Parameters

[out]	cfg	: Click configuration structure. See stepdown9_t object definition for detailed explanation.
[in]	pin_state	: State of the EN pin.

Returns: Nothing.

Note: None.

◆ stepdown9_set_output()

err_t stepdown9_set_output	(	stepdown9_t *	ctx,
		uint8_t	voltage )

Step Down 9 set output voltage.

This function sets a predefined output level.

Parameters

[in]	ctx	: Click context object. See stepdown9_t object definition for detailed explanation.
[in]	voltage	: Desired output voltage.

Returns

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

Note: None.

◆ stepdown9_set_resistance()

err_t stepdown9_set_resistance	(	stepdown9_t *	ctx,
		uint32_t	res_ohm )

Step Down 9 set potentiometer resistance.

This function sets a resistance of the potentiometer to the desired value.

Parameters

[in]	ctx	: Click context object. See stepdown9_t object definition for detailed explanation.
[in]	resistance	: Desired resistance.

Returns

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

Note: None.

◆ stepdown9_set_wiper_pos()

err_t stepdown9_set_wiper_pos	(	stepdown9_t *	ctx,
		uint8_t	wiper_pos )

Step Down 9 set wiper position.

This function sets a wiper of the potentiometer to the desired position.

Parameters

[in]	ctx	: Click context object. See stepdown9_t object definition for detailed explanation.
[in]	wiper_pos	: Position of the wiper.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ stepdown9_cfg_setup()

◆ stepdown9_default_cfg()

◆ stepdown9_generic_read()

◆ stepdown9_generic_write()

◆ stepdown9_get_pg_pin()

◆ stepdown9_init()

◆ stepdown9_set_en_pin()

◆ stepdown9_set_output()

◆ stepdown9_set_resistance()

◆ stepdown9_set_wiper_pos()