API for configuring and manipulating SPI Isolator 8 Click driver. More...

Topics
	SPI Isolator 8 MikroBUS Map
	MikroBUS pin mapping of SPI Isolator 8 Click driver.

	Spiisolator8_set

Functions
void	spiisolator8_cfg_setup (spiisolator8_cfg_t *cfg)
	SPI Isolator 8 configuration object setup function.

err_t	spiisolator8_init (spiisolator8_t ctx, spiisolator8_cfg_t cfg)
	SPI Isolator 8 initialization function.

void	spiisolator8_default_cfg (spiisolator8_t *ctx)
	SPI Isolator 8 default configuration function.

void	spiisolator8_enc_enable (spiisolator8_t *ctx)
	SPI Isolator 8 enable side 1 function.

void	spiisolator8_enc_disable (spiisolator8_t *ctx)
	SPI Isolator 8 disable side 1 function.

void	spiisolator8_enp_enable (spiisolator8_t *ctx)
	SPI Isolator 8 enable side 2 function.

void	spiisolator8_enp_disable (spiisolator8_t *ctx)
	SPI Isolator 8 disable side 2 function.

uint8_t	spiisolator8_get_fault (spiisolator8_t *ctx)
	SPI Isolator 8 get fault function.

err_t	spiisolator8_write (spiisolator8_t ctx, uint8_t data_in, uint8_t len)
	SPI Isolator 8 data writing function.

err_t	spiisolator8_read (spiisolator8_t ctx, uint8_t data_out, uint8_t len_out)
	SPI Isolator 8 data reading function.

err_t	spiisolator8_write_then_read (spiisolator8_t ctx, uint8_t data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out)
	SPI Isolator 8 write then read function.

err_t	spiisolator8_transfer (spiisolator8_t ctx, uint8_t data_in, uint8_t *data_out, uint8_t len)
	SPI Isolator 8 data transfer function.

Detailed Description

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

◆ spiisolator8_cfg_setup()

void spiisolator8_cfg_setup ( spiisolator8_cfg_t * cfg )

SPI Isolator 8 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ spiisolator8_default_cfg()

void spiisolator8_default_cfg ( spiisolator8_t * ctx )

SPI Isolator 8 default configuration function.

This function executes a default configuration of SPI Isolator 8 click board.

Parameters

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

Returns: Nothing.

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

◆ spiisolator8_enc_disable()

void spiisolator8_enc_disable ( spiisolator8_t * ctx )

SPI Isolator 8 disable side 1 function.

This function performs disabling a channel output pins on side 1 of the ISOW7741FBDFMR, Quad-Channel Digital Isolator with Integrated Low-Emissions, Low-Noise DC-DC Converter on the SPI Isolator 8 Click board™.

Parameters

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

Returns: Nothing.

Note: None.

◆ spiisolator8_enc_enable()

void spiisolator8_enc_enable ( spiisolator8_t * ctx )

SPI Isolator 8 enable side 1 function.

This function performs enabling a channel output pins on side 1 of the ISOW7741FBDFMR, Quad-Channel Digital Isolator with Integrated Low-Emissions, Low-Noise DC-DC Converter on the SPI Isolator 8 Click board™.

Parameters

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

Returns: Nothing.

Note: None.

◆ spiisolator8_enp_disable()

void spiisolator8_enp_disable ( spiisolator8_t * ctx )

SPI Isolator 8 disable side 2 function.

This function performs disabling a channel output pins on side 2 of the ISOW7741FBDFMR, Quad-Channel Digital Isolator with Integrated Low-Emissions, Low-Noise DC-DC Converter on the SPI Isolator 8 Click board™.

Parameters

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

Returns: Nothing.

Note: None.

◆ spiisolator8_enp_enable()

void spiisolator8_enp_enable ( spiisolator8_t * ctx )

SPI Isolator 8 enable side 2 function.

This function performs enabling a channel output pins on side 2 of the ISOW7741FBDFMR, Quad-Channel Digital Isolator with Integrated Low-Emissions, Low-Noise DC-DC Converter on the SPI Isolator 8 Click board™.

Parameters

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

Returns: Nothing.

Note: None.

◆ spiisolator8_get_fault()

uint8_t spiisolator8_get_fault ( spiisolator8_t * ctx )

SPI Isolator 8 get fault function.

This function get fault state, alert signal if power converter is not operating properly of the ISOW7741FBDFMR, Quad-Channel Digital Isolator with Integrated Low-Emissions, Low-Noise DC-DC Converter on the SPI Isolator 8 Click board™.

Parameters

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

Returns

0 - Power converter is not operating properly,
1 - Power converter is operating properly.

Note: None.

◆ spiisolator8_init()

err_t spiisolator8_init	(	spiisolator8_t *	ctx,
		spiisolator8_cfg_t *	cfg )

SPI Isolator 8 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ spiisolator8_read()

err_t spiisolator8_read	(	spiisolator8_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len_out )

SPI Isolator 8 data reading function.

This function reads a desired number of data bytes by using SPI serial interface.

Parameters

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

◆ spiisolator8_transfer()

err_t spiisolator8_transfer	(	spiisolator8_t *	ctx,
		uint8_t *	data_in,
		uint8_t *	data_out,
		uint8_t	len )

SPI Isolator 8 data transfer function.

This function writes and reads a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See spiisolator8_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be transferred (write/read).

Returns

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

Note: None.

◆ spiisolator8_write()

err_t spiisolator8_write	(	spiisolator8_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

SPI Isolator 8 data writing function.

This function writes a desired number of data bytes by using SPI serial interface.

Parameters

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

◆ spiisolator8_write_then_read()

err_t spiisolator8_write_then_read	(	spiisolator8_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len_in,
		uint8_t *	data_out,
		uint8_t	len_out )

SPI Isolator 8 write then read function.

This function writes and then reads a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See spiisolator8_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len_in	: Number of bytes to be written.
[out]	data_out	: Output read data.
[in]	len_out	: Number of bytes to be read.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ spiisolator8_cfg_setup()

◆ spiisolator8_default_cfg()

◆ spiisolator8_enc_disable()

◆ spiisolator8_enc_enable()

◆ spiisolator8_enp_disable()

◆ spiisolator8_enp_enable()

◆ spiisolator8_get_fault()

◆ spiisolator8_init()

◆ spiisolator8_read()

◆ spiisolator8_transfer()

◆ spiisolator8_write()

◆ spiisolator8_write_then_read()