ISO 9141 Click Driver

API for configuring and manipulating ISO 9141 Click driver. More...

Topics
	ISO 9141 Device Settings
	Settings for registers of ISO 9141 Click driver.
	ISO 9141 MikroBUS Map
	MikroBUS pin mapping of ISO 9141 Click driver.

Functions
void	iso9141_cfg_setup (iso9141_cfg_t *cfg)
	ISO 9141 configuration object setup function.
err_t	iso9141_init (iso9141_t *ctx, iso9141_cfg_t *cfg)
	ISO 9141 initialization function.
err_t	iso9141_generic_write (iso9141_t *ctx, uint8_t *data_buf, uint16_t len)
	ISO 9141 data writing function.
err_t	iso9141_generic_read (iso9141_t *ctx, uint8_t *data_buf, uint16_t max_len)
	ISO 9141 data reading function.

Detailed Description

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

iso9141_cfg_setup()

void iso9141_cfg_setup

(

iso9141_cfg_t *

cfg

)

ISO 9141 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

iso9141_generic_read()

err_t iso9141_generic_read	(	iso9141_t *	ctx,
		uint8_t *	data_buf,
		uint16_t	max_len )

ISO 9141 data reading function.

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

Parameters

[in]	ctx	: Click context object. See iso9141_t object definition for detailed explanation.
[out]	data_buf	: Output read data.
[in]	max_len	: Number of bytes to be read.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

iso9141_generic_write()

err_t iso9141_generic_write	(	iso9141_t *	ctx,
		uint8_t *	data_buf,
		uint16_t	len )

ISO 9141 data writing function.

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

Parameters

[in]	ctx	: Click context object. See iso9141_t object definition for detailed explanation.
[in]	data_buf	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

iso9141_init()

err_t iso9141_init	(	iso9141_t *	ctx,
		iso9141_cfg_t *	cfg )

ISO 9141 initialization function.

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

Parameters

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

Returns

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

Note

None.