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

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

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

Functions
void	stepdown7_cfg_setup (stepdown7_cfg_t *cfg)
	Step Down 7 configuration object setup function.

err_t	stepdown7_init (stepdown7_t ctx, stepdown7_cfg_t cfg)
	Step Down 7 initialization function.

err_t	stepdown7_default_cfg (stepdown7_t *ctx)
	Step Down 7 default configuration function.

err_t	stepdown7_generic_write (stepdown7_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	Step Down 7 I2C writing function.

err_t	stepdown7_generic_read (stepdown7_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	Step Down 7 I2C reading function.

void	stepdown7_set_mode (stepdown7_t *ctx, uint8_t mode)
	Step Down 5 mode selection function.

void	stepdown7_set_en (stepdown7_t *ctx, uint8_t en_state)
	Step Down 5 set EN pin state function.

uint8_t	stepdown7_get_pg_state (stepdown7_t *ctx)
	Step Down 5 get PG pin state function.

err_t	stepdown7_set_wiper_pos (stepdown7_t *ctx, uint16_t wiper_pos)
	Step Down 5 set wiper 1 position.

err_t	stepdown7_set_r1_resistance (stepdown7_t *ctx, uint32_t resistance)
	Step Down 7 set potentiometer resistance.

err_t	stepdown7_set_output (stepdown7_t *ctx, uint8_t voltage)
	Step Down 7 set output voltage.

Detailed Description

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

◆ stepdown7_cfg_setup()

void stepdown7_cfg_setup ( stepdown7_cfg_t * cfg )

Step Down 7 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ stepdown7_default_cfg()

err_t stepdown7_default_cfg ( stepdown7_t * ctx )

Step Down 7 default configuration function.

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

Parameters

[in] ctx : Click context object. See stepdown7_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.

◆ stepdown7_generic_read()

err_t stepdown7_generic_read	(	stepdown7_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

Step Down 7 I2C reading function.

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

Parameters

[in]	ctx	: Click context object. See stepdown7_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.

◆ stepdown7_generic_write()

err_t stepdown7_generic_write	(	stepdown7_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

Step Down 7 I2C writing function.

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

Parameters

[in]	ctx	: Click context object. See stepdown7_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.

◆ stepdown7_get_pg_state()

uint8_t stepdown7_get_pg_state ( stepdown7_t * ctx )

Step Down 5 get PG pin state function.

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

Parameters

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

Returns: State of the PG pin.

Note: None.

◆ stepdown7_init()

err_t stepdown7_init	(	stepdown7_t *	ctx,
		stepdown7_cfg_t *	cfg )

Step Down 7 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ stepdown7_set_en()

void stepdown7_set_en	(	stepdown7_t *	ctx,
		uint8_t	en_state )

Step Down 5 set EN pin state function.

This function sets a EN pin state.

Parameters

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

Returns: Nothing.

Note: None.

◆ stepdown7_set_mode()

void stepdown7_set_mode	(	stepdown7_t *	ctx,
		uint8_t	mode )

Step Down 5 mode selection function.

This function sets a desired mode of the PWM.

Parameters

[out]	cfg	: Click configuration structure. See stepdown7_cfg_t object definition for detailed explanation.
[in]	mode	: PWM/Sync mode.

Returns: Nothing.

Note: None.

◆ stepdown7_set_output()

err_t stepdown7_set_output	(	stepdown7_t *	ctx,
		uint8_t	voltage )

Step Down 7 set output voltage.

This function sets a predefined output level.

Parameters

[in]	ctx	: Click context object. See stepdown7_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.

◆ stepdown7_set_r1_resistance()

err_t stepdown7_set_r1_resistance	(	stepdown7_t *	ctx,
		uint32_t	resistance )

Step Down 7 set potentiometer resistance.

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

Parameters

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

Returns

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

Note: None.

◆ stepdown7_set_wiper_pos()

err_t stepdown7_set_wiper_pos	(	stepdown7_t *	ctx,
		uint16_t	wiper_pos )

Step Down 5 set wiper 1 position.

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

Parameters

[in]	ctx	: Click context object. See stepdown7_t object definition for detailed explanation.
[in]	wiper_1_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

◆ stepdown7_cfg_setup()

◆ stepdown7_default_cfg()

◆ stepdown7_generic_read()

◆ stepdown7_generic_write()

◆ stepdown7_get_pg_state()

◆ stepdown7_init()

◆ stepdown7_set_en()

◆ stepdown7_set_mode()

◆ stepdown7_set_output()

◆ stepdown7_set_r1_resistance()

◆ stepdown7_set_wiper_pos()