API for configuring and manipulating UART to I2C Click driver. More...

Topics
	UART to I2C Device Settings
	Settings for registers of UART to I2C Click driver.

	UART to I2C MikroBUS Map
	MikroBUS pin mapping of UART to I2C Click driver.

Functions
void	uarttoi2c_cfg_setup (uarttoi2c_cfg_t *cfg)
	UART to I2C configuration object setup function.

err_t	uarttoi2c_init (uarttoi2c_t ctx, uarttoi2c_cfg_t cfg)
	UART to I2C initialization function.

err_t	uarttoi2c_default_cfg (uarttoi2c_t *ctx)
	UART to I2C default configuration function.

err_t	uarttoi2c_generic_write (uarttoi2c_t ctx, char data_in, uint16_t len)
	UART to I2C data writing function.

err_t	uarttoi2c_generic_read (uarttoi2c_t ctx, char data_out, uint16_t len)
	UART to I2C data reading function.

void	uarttoi2c_set_rst_pin (uarttoi2c_t *ctx, uint8_t state)
	UART to I2C set rst pin function.

err_t	uarttoi2c_reset_device (uarttoi2c_t *ctx)
	UART to I2C reset device function.

err_t	uarttoi2c_write_register (uarttoi2c_t *ctx, uint8_t reg, uint8_t data_in)
	UART to I2C write register function.

err_t	uarttoi2c_read_register (uarttoi2c_t ctx, uint8_t reg, uint8_t data_out)
	UART to I2C read register function.

void	uarttoi2c_gpio_write (uarttoi2c_t *ctx, uint8_t gpio_data)
	UART to I2C gpio write function.

err_t	uarttoi2c_gpio_read (uarttoi2c_t ctx, uint8_t gpio_data)
	UART to I2C gpio read function.

err_t	uarttoi2c_gpio_config (uarttoi2c_t *ctx, uint8_t direction, uint8_t pin_mask)
	UART to I2C gpio config function.

err_t	uarttoi2c_read_version (uarttoi2c_t ctx, uint8_t version)
	UART to I2C read version function.

err_t	uarttoi2c_i2c_write (uarttoi2c_t ctx, uint8_t slave_addr, uint8_t data_in, uint8_t len)
	UART to I2C i2c write function.

err_t	uarttoi2c_i2c_read (uarttoi2c_t ctx, uint8_t slave_addr, uint8_t data_out, uint8_t len)
	UART to I2C i2c read function.

err_t	uarttoi2c_i2c_write_then_read (uarttoi2c_t ctx, uint8_t slave_addr, uint8_t data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len)
	UART to I2C i2c write then read function.

Detailed Description

API for configuring and manipulating UART to I2C 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

◆ uarttoi2c_cfg_setup()

void uarttoi2c_cfg_setup ( uarttoi2c_cfg_t * cfg )

UART to I2C configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ uarttoi2c_default_cfg()

err_t uarttoi2c_default_cfg ( uarttoi2c_t * ctx )

UART to I2C default configuration function.

This function executes a default configuration of UART to I2C click board.

Parameters

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

◆ uarttoi2c_generic_read()

err_t uarttoi2c_generic_read	(	uarttoi2c_t *	ctx,
		char *	data_out,
		uint16_t	len )

UART to I2C data reading function.

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

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	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.

◆ uarttoi2c_generic_write()

err_t uarttoi2c_generic_write	(	uarttoi2c_t *	ctx,
		char *	data_in,
		uint16_t	len )

UART to I2C data writing function.

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

Parameters

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

◆ uarttoi2c_gpio_config()

err_t uarttoi2c_gpio_config	(	uarttoi2c_t *	ctx,
		uint8_t	direction,
		uint8_t	pin_mask )

UART to I2C gpio config function.

This function sets the gpio direction config for the selected pins.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	direction	: GPIO direction: `0` - Input, `2` - Output push-pull, `3` - Output open-drain.
[in]	pin_mask	: Mask for pins to configure.

Returns

0 - Success,
-1 - Error - wrong direction parameter,
-2 - Timeout error. See #err_t definition for detailed explanation.

Note: None.

◆ uarttoi2c_gpio_read()

err_t uarttoi2c_gpio_read	(	uarttoi2c_t *	ctx,
		uint8_t *	gpio_data )

UART to I2C gpio read function.

This function reads data from the gpio port.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[out]	gpio_data	: GPIO data read.

Returns

0 - Success,
-1 - Error - null pointer,
-2 - Timeout error. See #err_t definition for detailed explanation.

Note: None.

◆ uarttoi2c_gpio_write()

void uarttoi2c_gpio_write	(	uarttoi2c_t *	ctx,
		uint8_t	gpio_data )

UART to I2C gpio write function.

This function writes a desired data to the gpio port.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	gpio_data	: GPIO data to be written.

Returns: None.

Note: The pins should be configured as output in order for this to take effect.

◆ uarttoi2c_i2c_read()

err_t uarttoi2c_i2c_read	(	uarttoi2c_t *	ctx,
		uint8_t	slave_addr,
		uint8_t *	data_out,
		uint8_t	len )

UART to I2C i2c read function.

This function reads a desired number of data bytes from the I2C target device.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	slave_addr	: Target device slave address.
[out]	data_out	: Output data read.
[in]	len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error - parameter error or not enough bytes read,
-2 - Timeout error. See #err_t definition for detailed explanation.

Note: None.

◆ uarttoi2c_i2c_write()

err_t uarttoi2c_i2c_write	(	uarttoi2c_t *	ctx,
		uint8_t	slave_addr,
		uint8_t *	data_in,
		uint8_t	len )

UART to I2C i2c write function.

This function writes a desired number of data bytes to the I2C target device.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	slave_addr	: Target device slave address.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

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

Note: None.

◆ uarttoi2c_i2c_write_then_read()

err_t uarttoi2c_i2c_write_then_read	(	uarttoi2c_t *	ctx,
		uint8_t	slave_addr,
		uint8_t *	data_in,
		uint8_t	in_len,
		uint8_t *	data_out,
		uint8_t	out_len )

UART to I2C i2c write then read function.

This function performs a write then read with a repeated start to the I2C target device.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	slave_addr	: Target device slave address.
[in]	data_in	: Data to be written.
[in]	in_len	: Number of bytes to be written.
[out]	data_out	: Output data read.
[in]	out_len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error - null pointer or not enough bytes read,
-2 - Timeout error. See #err_t definition for detailed explanation.

Note: None.

◆ uarttoi2c_init()

err_t uarttoi2c_init	(	uarttoi2c_t *	ctx,
		uarttoi2c_cfg_t *	cfg )

UART to I2C initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ uarttoi2c_read_register()

err_t uarttoi2c_read_register	(	uarttoi2c_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

UART to I2C read register function.

This function reads data from the specified chip internal register.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	reg	: Chip internal register address.
[out]	data_out	: Output data read.

Returns

0 - Success,
-1 - Error - unknown register or null pointer,
-2 - Timeout error. See #err_t definition for detailed explanation.

Note: None.

◆ uarttoi2c_read_version()

err_t uarttoi2c_read_version	(	uarttoi2c_t *	ctx,
		uint8_t *	version )

UART to I2C read version function.

This function reads the firmware version (16-bytes string ending with a null terminator).

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[out]	version	: Firmware version (16-bytes string ending with a null terminator).

Returns

0 - Success,
-1 - Error - not enough bytes read,
-2 - Timeout error. See #err_t definition for detailed explanation.

Note: None.

◆ uarttoi2c_reset_device()

err_t uarttoi2c_reset_device ( uarttoi2c_t * ctx )

UART to I2C reset device function.

This function resets the device and checks the power up response.

Parameters

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

Returns

0 - Success,
-2 - Timeout error. See #err_t definition for detailed explanation.

Note: None.

◆ uarttoi2c_set_rst_pin()

void uarttoi2c_set_rst_pin	(	uarttoi2c_t *	ctx,
		uint8_t	state )

UART to I2C set rst pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ uarttoi2c_write_register()

err_t uarttoi2c_write_register	(	uarttoi2c_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

UART to I2C write register function.

This function writes a desired data to the specified chip internal register.

Parameters

[in]	ctx	: Click context object. See uarttoi2c_t object definition for detailed explanation.
[in]	reg	: Chip internal register address.
[in]	data_in	: Data to be written.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ uarttoi2c_cfg_setup()

◆ uarttoi2c_default_cfg()

◆ uarttoi2c_generic_read()

◆ uarttoi2c_generic_write()

◆ uarttoi2c_gpio_config()

◆ uarttoi2c_gpio_read()

◆ uarttoi2c_gpio_write()

◆ uarttoi2c_i2c_read()

◆ uarttoi2c_i2c_write()

◆ uarttoi2c_i2c_write_then_read()

◆ uarttoi2c_init()

◆ uarttoi2c_read_register()

◆ uarttoi2c_read_version()

◆ uarttoi2c_reset_device()

◆ uarttoi2c_set_rst_pin()

◆ uarttoi2c_write_register()