API for configuring and manipulating Boost-INV 3 Click driver. More...

Topics
	Boost-INV 3 Registers List
	List of registers of Boost-INV 3 Click driver.

	Boost-INV 3 Registers Settings
	Settings for registers of Boost-INV 3 Click driver.

	Boost-INV 3 MikroBUS Map
	MikroBUS pin mapping of Boost-INV 3 Click driver.

Functions
void	boostinv3_cfg_setup (boostinv3_cfg_t *cfg)
	Boost-INV 3 configuration object setup function.

err_t	boostinv3_init (boostinv3_t ctx, boostinv3_cfg_t cfg)
	Boost-INV 3 initialization function.

err_t	boostinv3_default_cfg (boostinv3_t *ctx)
	Boost-INV 3 default configuration function.

err_t	boostinv3_generic_write (boostinv3_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	Boost-INV 3 I2C writing function.

err_t	boostinv3_generic_read (boostinv3_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	Boost-INV 3 I2C reading function.

void	boostinv3_set_enp (boostinv3_t *ctx, uint8_t out_state)
	Boost-INV 3 set ENP pin state function.

void	boostinv3_set_enn (boostinv3_t *ctx, uint8_t out_state)
	Boost-INV 3 set ENN pin state function.

err_t	boostinv3_write_reg (boostinv3_t *ctx, uint8_t reg, uint8_t data_in)
	Boost-INV 3 register write function.

err_t	boostinv3_set_pos_out (boostinv3_t *ctx, uint8_t out_val)
	Boost-INV 3 set positive output voltage function.

err_t	boostinv3_set_neg_out (boostinv3_t *ctx, uint8_t out_val)
	Boost-INV 3 set negative output voltage function.

Detailed Description

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

◆ boostinv3_cfg_setup()

void boostinv3_cfg_setup ( boostinv3_cfg_t * cfg )

Boost-INV 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ boostinv3_default_cfg()

err_t boostinv3_default_cfg ( boostinv3_t * ctx )

Boost-INV 3 default configuration function.

This function executes a default configuration of Boost-INV 3 click board.

Parameters

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

◆ boostinv3_generic_read()

err_t boostinv3_generic_read	(	boostinv3_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

Boost-INV 3 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 boostinv3_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.

◆ boostinv3_generic_write()

err_t boostinv3_generic_write	(	boostinv3_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

Boost-INV 3 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 boostinv3_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.

◆ boostinv3_init()

err_t boostinv3_init	(	boostinv3_t *	ctx,
		boostinv3_cfg_t *	cfg )

Boost-INV 3 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ boostinv3_set_enn()

void boostinv3_set_enn	(	boostinv3_t *	ctx,
		uint8_t	out_state )

Boost-INV 3 set ENN pin state function.

This function is used to set output level of the ENN pin.

Parameters

[in]	ctx	: Click context object. See boostinv3_t object definition for detailed explanation.
[in]	out_state	: ENN output state.

Returns: Nothing.

Note: None.

◆ boostinv3_set_enp()

void boostinv3_set_enp	(	boostinv3_t *	ctx,
		uint8_t	out_state )

Boost-INV 3 set ENP pin state function.

This function is used to set output level of the ENP pin.

Parameters

[in]	ctx	: Click context object. See boostinv3_t object definition for detailed explanation.
[in]	out_state	: ENP output state.

Returns: Nothing.

Note: None.

◆ boostinv3_set_neg_out()

err_t boostinv3_set_neg_out	(	boostinv3_t *	ctx,
		uint8_t	out_val )

Boost-INV 3 set negative output voltage function.

This function is used to set negative output voltage of the Boost-INV 3 Click.

Parameters

[in]	ctx	: Click context object. See boostinv3_t object definition for detailed explanation.
[in]	out_val	: Output voltage value.

Returns

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

Note: None.

◆ boostinv3_set_pos_out()

err_t boostinv3_set_pos_out	(	boostinv3_t *	ctx,
		uint8_t	out_val )

Boost-INV 3 set positive output voltage function.

This function is used to set positive output voltage of the Boost-INV 3 Click.

Parameters

[in]	ctx	: Click context object. See boostinv3_t object definition for detailed explanation.
[in]	out_val	: Output voltage value.

Returns

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

Note: None.

◆ boostinv3_write_reg()

err_t boostinv3_write_reg	(	boostinv3_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Boost-INV 3 register write function.

This function byte of data to the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See boostinv3_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ boostinv3_cfg_setup()

◆ boostinv3_default_cfg()

◆ boostinv3_generic_read()

◆ boostinv3_generic_write()

◆ boostinv3_init()

◆ boostinv3_set_enn()

◆ boostinv3_set_enp()

◆ boostinv3_set_neg_out()

◆ boostinv3_set_pos_out()

◆ boostinv3_write_reg()