Boost 7 Click Driver

API for configuring and manipulating Boost 7 Click driver. More...

Topics
	Boost 7 MikroBUS Map
	MikroBUS pin mapping of Boost 7 Click driver.

Functions
void	boost7_cfg_setup (boost7_cfg_t *cfg)
	Boost 7 configuration object setup function.
err_t	boost7_init (boost7_t *ctx, boost7_cfg_t *cfg)
	Boost 7 initialization function.
void	boost7_enable_out1 (boost7_t *ctx)
	Boost 7 enable out1 function.
void	boost7_disable_out1 (boost7_t *ctx)
	Boost 7 disable out1 function.
void	boost7_enable_out2 (boost7_t *ctx)
	Boost 7 enable out2 function.
void	boost7_disable_out2 (boost7_t *ctx)
	Boost 7 disable out2 function.

Detailed Description

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

boost7_cfg_setup()

void boost7_cfg_setup

(

boost7_cfg_t *

cfg

)

Boost 7 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

boost7_disable_out1()

void boost7_disable_out1

(

boost7_t *

ctx

)

Boost 7 disable out1 function.

This function disables the OUT1 (V-) by setting the STB1 pin to low logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

boost7_disable_out2()

void boost7_disable_out2

(

boost7_t *

ctx

)

Boost 7 disable out2 function.

This function disables the OUT2 (V+) by setting the STB2 pin to low logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

boost7_enable_out1()

void boost7_enable_out1

(

boost7_t *

ctx

)

Boost 7 enable out1 function.

This function enables the OUT1 (V-) by setting the STB1 pin to high logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

boost7_enable_out2()

void boost7_enable_out2

(

boost7_t *

ctx

)

Boost 7 enable out2 function.

This function enables the OUT2 (V+) by setting the STB2 pin to high logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

boost7_init()

err_t boost7_init	(	boost7_t *	ctx,
		boost7_cfg_t *	cfg )

Boost 7 initialization function.

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

Parameters

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

Returns

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

Note

None.