IoT ExpressLink Click Driver

API for configuring and manipulating IoT ExpressLink Click driver. More...

Topics
	IoT ExpressLink Device Settings
	Settings for registers of IoT ExpressLink Click driver.
	IoT ExpressLink MikroBUS Map
	MikroBUS pin mapping of IoT ExpressLink Click driver.

Functions
void	iotexpresslink_cfg_setup (iotexpresslink_cfg_t *cfg)
	IoT ExpressLink configuration object setup function.
err_t	iotexpresslink_init (iotexpresslink_t *ctx, iotexpresslink_cfg_t *cfg)
	IoT ExpressLink initialization function.
err_t	iotexpresslink_generic_write (iotexpresslink_t *ctx, uint8_t *data_in, uint16_t len)
	IoT ExpressLink data writing function.
err_t	iotexpresslink_generic_read (iotexpresslink_t *ctx, uint8_t *data_out, uint16_t len)
	IoT ExpressLink data reading function.
void	iotexpresslink_send_cmd (iotexpresslink_t *ctx, uint8_t *cmd)
	IoT ExpressLink send cmd function.
void	iotexpresslink_enable_device (iotexpresslink_t *ctx)
	IoT ExpressLink enable device function.
void	iotexpresslink_disable_device (iotexpresslink_t *ctx)
	IoT ExpressLink disable device function.
void	iotexpresslink_reset_device (iotexpresslink_t *ctx)
	IoT ExpressLink reset device function.
uint8_t	iotexpresslink_get_event_pin (iotexpresslink_t *ctx)
	IoT ExpressLink get event pin function.
uint8_t	iotexpresslink_get_wake_pin (iotexpresslink_t *ctx)
	IoT ExpressLink get wake pin function.

Detailed Description

API for configuring and manipulating IoT ExpressLink 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

iotexpresslink_cfg_setup()

void iotexpresslink_cfg_setup

(

iotexpresslink_cfg_t *

cfg

)

IoT ExpressLink configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

iotexpresslink_disable_device()

void iotexpresslink_disable_device

(

iotexpresslink_t *

ctx

)

IoT ExpressLink disable device function.

This function disables device by setting the RST pin to low logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

iotexpresslink_enable_device()

void iotexpresslink_enable_device

(

iotexpresslink_t *

ctx

)

IoT ExpressLink enable device function.

This function enables device by setting the RST pin to high logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

iotexpresslink_generic_read()

err_t iotexpresslink_generic_read	(	iotexpresslink_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

IoT ExpressLink data reading function.

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

Parameters

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

iotexpresslink_generic_write()

err_t iotexpresslink_generic_write	(	iotexpresslink_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

IoT ExpressLink data writing function.

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

Parameters

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

iotexpresslink_get_event_pin()

uint8_t iotexpresslink_get_event_pin

(

iotexpresslink_t *

ctx

)

IoT ExpressLink get event pin function.

This function returns the event pin logic state.

Parameters

[in]

ctx

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

Returns

Pin logic state.

Note

None.

iotexpresslink_get_wake_pin()

uint8_t iotexpresslink_get_wake_pin

(

iotexpresslink_t *

ctx

)

IoT ExpressLink get wake pin function.

This function returns the wake pin logic state.

Parameters

[in]

ctx

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

Returns

Pin logic state.

Note

None.

iotexpresslink_init()

err_t iotexpresslink_init	(	iotexpresslink_t *	ctx,
		iotexpresslink_cfg_t *	cfg )

IoT ExpressLink initialization function.

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

Parameters

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

Returns

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

Note

None.

iotexpresslink_reset_device()

void iotexpresslink_reset_device

(

iotexpresslink_t *

ctx

)

IoT ExpressLink reset device function.

This function resets device by toggling the RST pin state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

iotexpresslink_send_cmd()

void iotexpresslink_send_cmd	(	iotexpresslink_t *	ctx,
		uint8_t *	cmd )

IoT ExpressLink send cmd function.

This function send command string by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See iotexpresslink_t object definition for detailed explanation.
[in]	cmd	: Command string to send.

Returns

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

Note

None.