API for configuring and manipulating AnyNet 3G-AA Click driver. More...

Topics
	AnyNet 3G-AA Device Settings
	Settings for registers of AnyNet 3G-AA Click driver.

	AnyNet 3G-AA MikroBUS Map
	MikroBUS pin mapping of AnyNet 3G-AA Click driver.

Functions
void	anynet3gaa_cfg_setup (anynet3gaa_cfg_t *cfg)
	AnyNet 3G-AA configuration object setup function.

err_t	anynet3gaa_init (anynet3gaa_t ctx, anynet3gaa_cfg_t cfg)
	AnyNet 3G-AA initialization function.

err_t	anynet3gaa_generic_write (anynet3gaa_t ctx, uint8_t data_in, uint16_t len)
	AnyNet 3G-AA data writing function.

err_t	anynet3gaa_generic_read (anynet3gaa_t ctx, uint8_t data_out, uint16_t len)
	AnyNet 3G-AA data reading function.

void	anynet3gaa_set_slp_pin (anynet3gaa_t *ctx, uint8_t state)
	AnyNet 3G-AA set slp pin function.

void	anynet3gaa_set_dtr_pin (anynet3gaa_t *ctx, uint8_t state)
	AnyNet 3G-AA set dtr pin function.

void	anynet3gaa_set_iot_pin (anynet3gaa_t *ctx, uint8_t state)
	AnyNet 3G-AA set iot pin function.

uint8_t	anynet3gaa_get_dsr_pin (anynet3gaa_t *ctx)
	AnyNet 3G-AA get dsr pin function.

void	anynet3gaa_send_cmd (anynet3gaa_t ctx, uint8_t cmd)
	Send command function.

void	anynet3gaa_send_cmd_with_par (anynet3gaa_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.

void	anynet3gaa_send_cmd_check (anynet3gaa_t ctx, uint8_t at_cmd_buf)
	Check the sent command.

void	anynet3gaa_send_cmd_par_check (anynet3gaa_t ctx, uint8_t at_cmd_buf)
	Check the command parameters.

Detailed Description

API for configuring and manipulating AnyNet 3G-AA 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

◆ anynet3gaa_cfg_setup()

void anynet3gaa_cfg_setup ( anynet3gaa_cfg_t * cfg )

AnyNet 3G-AA configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ anynet3gaa_generic_read()

err_t anynet3gaa_generic_read	(	anynet3gaa_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

AnyNet 3G-AA data reading function.

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

Parameters

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

◆ anynet3gaa_generic_write()

err_t anynet3gaa_generic_write	(	anynet3gaa_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

AnyNet 3G-AA data writing function.

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

Parameters

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

◆ anynet3gaa_get_dsr_pin()

uint8_t anynet3gaa_get_dsr_pin ( anynet3gaa_t * ctx )

AnyNet 3G-AA get dsr pin function.

This function returns the DSR handshake pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ anynet3gaa_init()

err_t anynet3gaa_init	(	anynet3gaa_t *	ctx,
		anynet3gaa_cfg_t *	cfg )

AnyNet 3G-AA initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ anynet3gaa_send_cmd()

void anynet3gaa_send_cmd	(	anynet3gaa_t *	ctx,
		uint8_t *	cmd )

Send command function.

This function sends a specified command to the click module.

Parameters

[in]	ctx	: Click context object. See anynet3gaa_t object definition for detailed explanation.
[in]	cmd	: Command variable.

Returns: Nothing.

Note: None.

◆ anynet3gaa_send_cmd_check()

void anynet3gaa_send_cmd_check	(	anynet3gaa_t *	ctx,
		uint8_t *	at_cmd_buf )

Check the sent command.

This function checks the command status.

Parameters

[in]	ctx	: Click context object. See anynet3gaa_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ anynet3gaa_send_cmd_par_check()

void anynet3gaa_send_cmd_par_check	(	anynet3gaa_t *	ctx,
		uint8_t *	at_cmd_buf )

Check the command parameters.

This function checks the command parameters.

Parameters

[in]	ctx	: Click context object. See anynet3gaa_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ anynet3gaa_send_cmd_with_par()

void anynet3gaa_send_cmd_with_par	(	anynet3gaa_t *	ctx,
		uint8_t *	at_cmd_buf,
		uint8_t *	param_buf )

Send command function with parameter.

This function sends a command with specified parameter to the click module.

Parameters

[in]	ctx	: Click context object. See anynet3gaa_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.
[in]	param_buf	: Parameter buffer.

Returns: Nothing.

Note: None.

◆ anynet3gaa_set_dtr_pin()

void anynet3gaa_set_dtr_pin	(	anynet3gaa_t *	ctx,
		uint8_t	state )

AnyNet 3G-AA set dtr pin function.

This function sets the DTR handshake pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ anynet3gaa_set_iot_pin()

void anynet3gaa_set_iot_pin	(	anynet3gaa_t *	ctx,
		uint8_t	state )

AnyNet 3G-AA set iot pin function.

This function sets the IoT button pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ anynet3gaa_set_slp_pin()

void anynet3gaa_set_slp_pin	(	anynet3gaa_t *	ctx,
		uint8_t	state )

AnyNet 3G-AA set slp pin function.

This function sets the Sleep mode (SLP) pin logic state.

Parameters

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

Returns: None.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ anynet3gaa_cfg_setup()

◆ anynet3gaa_generic_read()

◆ anynet3gaa_generic_write()

◆ anynet3gaa_get_dsr_pin()

◆ anynet3gaa_init()

◆ anynet3gaa_send_cmd()

◆ anynet3gaa_send_cmd_check()

◆ anynet3gaa_send_cmd_par_check()

◆ anynet3gaa_send_cmd_with_par()

◆ anynet3gaa_set_dtr_pin()

◆ anynet3gaa_set_iot_pin()

◆ anynet3gaa_set_slp_pin()