AWS IoT Click Driver

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

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

Functions
void	awsiot_cfg_setup (awsiot_cfg_t *cfg)
	AWS IoT configuration object setup function.
err_t	awsiot_init (awsiot_t *ctx, awsiot_cfg_t *cfg)
	AWS IoT initialization function.
err_t	awsiot_generic_write (awsiot_t *ctx, uint8_t *data_in, uint16_t len)
	AWS IoT data writing function.
err_t	awsiot_generic_read (awsiot_t *ctx, uint8_t *data_out, uint16_t len)
	AWS IoT data reading function.
void	awsiot_send_cmd (awsiot_t *ctx, uint8_t *cmd)
	AWS IoT send cmd function.
void	awsiot_enable_device (awsiot_t *ctx)
	AWS IoT enable device function.
void	awsiot_disable_device (awsiot_t *ctx)
	AWS IoT disable device function.
void	awsiot_reset_device (awsiot_t *ctx)
	AWS IoT reset device function.
void	awsiot_set_boot_pin (awsiot_t *ctx, uint8_t state)
	AWS IoT set boot pin function.
uint8_t	awsiot_get_event_pin (awsiot_t *ctx)
	AWS IoT get event pin function.
uint8_t	awsiot_get_wake_pin (awsiot_t *ctx)
	AWS IoT get wake pin function.

Detailed Description

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

awsiot_cfg_setup()

void awsiot_cfg_setup

(

awsiot_cfg_t *

cfg

)

AWS IoT configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

awsiot_disable_device()

void awsiot_disable_device

(

awsiot_t *

ctx

)

AWS IoT disable device function.

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

Parameters

[in]

ctx

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

Returns

None.

Note

None.

awsiot_enable_device()

void awsiot_enable_device

(

awsiot_t *

ctx

)

AWS IoT enable device function.

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

Parameters

[in]

ctx

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

Returns

None.

Note

None.

awsiot_generic_read()

err_t awsiot_generic_read	(	awsiot_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

AWS IoT data reading function.

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

Parameters

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

awsiot_generic_write()

err_t awsiot_generic_write	(	awsiot_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

AWS IoT data writing function.

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

Parameters

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

awsiot_get_event_pin()

uint8_t awsiot_get_event_pin

(

awsiot_t *

ctx

)

AWS IoT get event pin function.

This function returns the event pin logic state.

Parameters

[in]

ctx

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

Returns

Pin logic state.

Note

None.

awsiot_get_wake_pin()

uint8_t awsiot_get_wake_pin

(

awsiot_t *

ctx

)

AWS IoT get wake pin function.

This function returns the wake pin logic state.

Parameters

[in]

ctx

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

Returns

Pin logic state.

Note

None.

awsiot_init()

err_t awsiot_init	(	awsiot_t *	ctx,
		awsiot_cfg_t *	cfg )

AWS IoT initialization function.

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

Parameters

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

Returns

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

Note

None.

awsiot_reset_device()

void awsiot_reset_device

(

awsiot_t *

ctx

)

AWS IoT reset device function.

This function resets device by toggling the RST pin state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

awsiot_send_cmd()

void awsiot_send_cmd	(	awsiot_t *	ctx,
		uint8_t *	cmd )

AWS IoT send cmd function.

This function send command string by using UART serial interface.

Parameters

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

awsiot_set_boot_pin()

void awsiot_set_boot_pin	(	awsiot_t *	ctx,
		uint8_t	state )

AWS IoT set boot pin function.

This function sets the boot pin logic state.

Parameters

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

Returns

None.

Note

None.