Boost 8 Click Driver

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

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

Functions
void	boost8_cfg_setup (boost8_cfg_t *cfg)
	Boost 8 configuration object setup function.
err_t	boost8_init (boost8_t *ctx, boost8_cfg_t *cfg)
	Boost 8 initialization function.
void	boost8_default_cfg (boost8_t *ctx)
	Boost 8 default configuration function.
void	boost8_enable_positive_voltage (boost8_t *ctx)
	Boost 8 enable positive voltage output function.
void	boost8_disable_positive_voltage (boost8_t *ctx)
	Boost 8 disable positive voltage output function.
void	boost8_enable_negative_voltage (boost8_t *ctx)
	Boost 8 enable negative voltage output function.
void	boost8_disable_negative_voltage (boost8_t *ctx)
	Boost 8 disable negative voltage output function.
void	boost8_enable_both_outputs (boost8_t *ctx)
	Boost 8 enable both voltage outputs function.
void	boost8_disable_both_outputs (boost8_t *ctx)
	Boost 8 disable both voltage outputs function.

Detailed Description

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

boost8_cfg_setup()

void boost8_cfg_setup

(

boost8_cfg_t *

cfg

)

Boost 8 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

boost8_default_cfg()

void boost8_default_cfg

(

boost8_t *

ctx

)

Boost 8 default configuration function.

This function executes a default configuration of Boost 8 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

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

boost8_disable_both_outputs()

void boost8_disable_both_outputs

(

boost8_t *

ctx

)

Boost 8 disable both voltage outputs function.

This function disables both outputs of Boost 8 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

boost8_disable_negative_voltage()

void boost8_disable_negative_voltage

(

boost8_t *

ctx

)

Boost 8 disable negative voltage output function.

This function disables negative output of Boost 8 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

boost8_disable_positive_voltage()

void boost8_disable_positive_voltage

(

boost8_t *

ctx

)

Boost 8 disable positive voltage output function.

This function disables positive output of Boost 8 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

boost8_enable_both_outputs()

void boost8_enable_both_outputs

(

boost8_t *

ctx

)

Boost 8 enable both voltage outputs function.

This function enables both outputs of Boost 8 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

boost8_enable_negative_voltage()

void boost8_enable_negative_voltage

(

boost8_t *

ctx

)

Boost 8 enable negative voltage output function.

This function enables negative output of Boost 8 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

boost8_enable_positive_voltage()

void boost8_enable_positive_voltage

(

boost8_t *

ctx

)

Boost 8 enable positive voltage output function.

This function enables positive output of Boost 8 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

boost8_init()

err_t boost8_init	(	boost8_t *	ctx,
		boost8_cfg_t *	cfg )

Boost 8 initialization function.

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

Parameters

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

Returns

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

Note

None.