API for configuring and manipulating 4G LTE-NA Click driver. More...

Topics
	4G LTE-NA Device Settings
	Settings for registers of 4G LTE-NA Click driver.

	4G LTE-NA MikroBUS Map
	MikroBUS pin mapping of 4G LTE-NA Click driver.

Functions
void	c4gltena_cfg_setup (c4gltena_cfg_t *cfg)
	4G LTE-NA configuration object setup function.

err_t	c4gltena_init (c4gltena_t ctx, c4gltena_cfg_t cfg)
	4G LTE-NA initialization function.

void	c4gltena_module_power_on (c4gltena_t *ctx)
	Power ON the module function.

err_t	c4gltena_generic_write (c4gltena_t ctx, char data_buf, uint16_t len)
	4G LTE-NA data writing function.

err_t	c4gltena_generic_read (c4gltena_t ctx, char data_buf, uint16_t max_len)
	4G LTE-NA data reading function.

void	c4gltena_set_rts_pin (c4gltena_t *ctx, uint8_t state)
	Sets state of the RTS pin.

void	c4gltena_set_pwk_pin (c4gltena_t *ctx, uint8_t state)
	Sets state of the PWK pin.

uint8_t	c4gltena_get_cts_pin (c4gltena_t *ctx)
	CTS Pin Get function.

uint8_t	c4gltena_get_sta_pin (c4gltena_t *ctx)
	STA Pin Get function.

uint8_t	c4gltena_get_ring_pin (c4gltena_t *ctx)
	RING Pin Get function.

void	c4gltena_send_cmd (c4gltena_t ctx, char cmd)
	Send command function.

void	c4gltena_send_cmd_with_parameter (c4gltena_t ctx, char at_cmd_buf, char *param_buf)
	Send command function with parameter.

void	c4gltena_send_cmd_check (c4gltena_t ctx, char at_cmd_buf)
	Check the sent command.

void	c4gltena_send_cmd_parameter_check (c4gltena_t ctx, char at_cmd_buf)
	Check the command parameters.

void	c4gltena_set_sim_apn (c4gltena_t ctx, char sim_apn)
	Set sim card APN.

void	c4gltena_send_sms_text (c4gltena_t ctx, char phone_number, char *sms_text)
	4G LTE-NA send SMS in text mode.

err_t	c4gltena_send_sms_pdu (c4gltena_t ctx, char service_center_number, char phone_number, char sms_text)
	4G LTE-NA send SMS in PDU mode.

Detailed Description

API for configuring and manipulating 4G LTE-NA 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

◆ c4gltena_cfg_setup()

void c4gltena_cfg_setup ( c4gltena_cfg_t * cfg )

4G LTE-NA configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ c4gltena_generic_read()

err_t c4gltena_generic_read	(	c4gltena_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

4G LTE-NA data reading function.

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

Parameters

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

◆ c4gltena_generic_write()

err_t c4gltena_generic_write	(	c4gltena_t *	ctx,
		char *	data_buf,
		uint16_t	len )

4G LTE-NA data writing function.

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

Parameters

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

◆ c4gltena_get_cts_pin()

uint8_t c4gltena_get_cts_pin ( c4gltena_t * ctx )

CTS Pin Get function.

This function allows user to check state of the CTS pin.

Parameters

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

Returns

0 logical low.
1 logical high.

Note: None.

◆ c4gltena_get_ring_pin()

uint8_t c4gltena_get_ring_pin ( c4gltena_t * ctx )

RING Pin Get function.

This function allows user to check state of the RING pin.

Parameters

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

Returns

0 logical low.
1 logical high.

Note: None.

◆ c4gltena_get_sta_pin()

uint8_t c4gltena_get_sta_pin ( c4gltena_t * ctx )

STA Pin Get function.

This function allows user to check state of the STA pin.

Parameters

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

Returns

0 logical low.
1 logical high.

Note: None.

◆ c4gltena_init()

err_t c4gltena_init	(	c4gltena_t *	ctx,
		c4gltena_cfg_t *	cfg )

4G LTE-NA initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ c4gltena_module_power_on()

void c4gltena_module_power_on ( c4gltena_t * ctx )

Power ON the module function.

This function powers ON the module.

Parameters

[out] ctx : Click context object. See c4gltena_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ c4gltena_send_cmd()

void c4gltena_send_cmd	(	c4gltena_t *	ctx,
		char *	cmd )

Send command function.

This function sends a specified command to the click module.

Parameters

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

Returns: Nothing.

Note: None.

◆ c4gltena_send_cmd_check()

void c4gltena_send_cmd_check	(	c4gltena_t *	ctx,
		char *	at_cmd_buf )

Check the sent command.

This function checks the command that is sent.

Parameters

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

Returns: Nothing.

Note: None.

◆ c4gltena_send_cmd_parameter_check()

void c4gltena_send_cmd_parameter_check	(	c4gltena_t *	ctx,
		char *	at_cmd_buf )

Check the command parameters.

This function checks the command that is sent.

Parameters

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

Returns: Nothing.

Note: None.

◆ c4gltena_send_cmd_with_parameter()

void c4gltena_send_cmd_with_parameter	(	c4gltena_t *	ctx,
		char *	at_cmd_buf,
		char *	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 c4gltena_t object definition for detailed explanation.
[in]	at_cmd_buf	Command buffer.
[in]	param_buf	Parameter buffer.

Returns: Nothing.

Note: None.

◆ c4gltena_send_sms_pdu()

err_t c4gltena_send_sms_pdu	(	c4gltena_t *	ctx,
		char *	service_center_number,
		char *	phone_number,
		char *	sms_text )

4G LTE-NA send SMS in PDU mode.

This function sends text message to a phone number in PDU mode.

Parameters

[in]	ctx	: Click context object. See c4gltena_t object definition for detailed explanation.
[in]	service_center_number	SMSC of the SIM card.
[in]	phone_number	Phone number to message.
[in]	sms_text	Message to be sent.

Returns

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

Note: None.

◆ c4gltena_send_sms_text()

void c4gltena_send_sms_text	(	c4gltena_t *	ctx,
		char *	phone_number,
		char *	sms_text )

4G LTE-NA send SMS in text mode.

This function sends text message to a phone number.

Parameters

[in]	ctx	: Click context object. See c4gltena_t object definition for detailed explanation.
[in]	phone_number	Phone number to message.
[in]	sms_text	Message to be sent.

Returns: Nothing.

Note: None.

◆ c4gltena_set_pwk_pin()

void c4gltena_set_pwk_pin	(	c4gltena_t *	ctx,
		uint8_t	state )

Sets state of the PWK pin.

This function sets PWK pin state.

Parameters

[in]	ctx	: Click context object. See c4gltena_t object definition for detailed explanation.
[in]	state	Pin state ( 1 or 0 ).

Returns: Nothing.

Note: None.

◆ c4gltena_set_rts_pin()

void c4gltena_set_rts_pin	(	c4gltena_t *	ctx,
		uint8_t	state )

Sets state of the RTS pin.

This function sets RTS pin state.

Parameters

[in]	ctx	: Click context object. See c4gltena_t object definition for detailed explanation.
[in]	state	Pin state ( 1 or 0 ).

Returns: Nothing.

Note: None.

◆ c4gltena_set_sim_apn()

void c4gltena_set_sim_apn	(	c4gltena_t *	ctx,
		char *	sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters

[in]	ctx	: Click context object. See c4gltena_t object definition for detailed explanation.
[in]	sim_apn	SIM card APN.

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ c4gltena_cfg_setup()

◆ c4gltena_generic_read()

◆ c4gltena_generic_write()

◆ c4gltena_get_cts_pin()

◆ c4gltena_get_ring_pin()

◆ c4gltena_get_sta_pin()

◆ c4gltena_init()

◆ c4gltena_module_power_on()

◆ c4gltena_send_cmd()

◆ c4gltena_send_cmd_check()

◆ c4gltena_send_cmd_parameter_check()

◆ c4gltena_send_cmd_with_parameter()

◆ c4gltena_send_sms_pdu()

◆ c4gltena_send_sms_text()

◆ c4gltena_set_pwk_pin()

◆ c4gltena_set_rts_pin()

◆ c4gltena_set_sim_apn()