API for configuring and manipulating LTE IoT 11 Click driver. More...

Topics
	LTE IoT 11 Device Settings
	Settings for registers of LTE IoT 11 Click driver.

	LTE IoT 11 MikroBUS Map
	MikroBUS pin mapping of LTE IoT 11 Click driver.

Functions
void	lteiot11_cfg_setup (lteiot11_cfg_t *cfg)
	LTE IoT 11 configuration object setup function.

err_t	lteiot11_init (lteiot11_t ctx, lteiot11_cfg_t cfg)
	LTE IoT 11 initialization function.

err_t	lteiot11_generic_write (lteiot11_t ctx, uint8_t data_in, uint16_t len)
	LTE IoT 11 data writing function.

err_t	lteiot11_generic_read (lteiot11_t ctx, uint8_t data_out, uint16_t len)
	LTE IoT 11 data reading function.

void	lteiot11_set_on_pin (lteiot11_t *ctx, uint8_t state)
	LTE IoT 11 set on pin function.

void	lteiot11_set_rts_pin (lteiot11_t *ctx, uint8_t state)
	LTE IoT 11 set rts pin function.

void	lteiot11_set_cs_pin (lteiot11_t *ctx, uint8_t state)
	LTE IoT 11 set cs pin function.

uint8_t	lteiot11_get_smi_pin (lteiot11_t *ctx)
	LTE IoT 11 get smi pin function.

uint8_t	lteiot11_get_cts_pin (lteiot11_t *ctx)
	LTE IoT 11 get cts pin function.

void	lteiot11_send_cmd (lteiot11_t ctx, uint8_t cmd)
	Send command function.

void	lteiot11_send_cmd_with_par (lteiot11_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.

void	lteiot11_send_cmd_check (lteiot11_t ctx, uint8_t at_cmd_buf)
	Check the sent command.

void	lteiot11_send_cmd_par_check (lteiot11_t ctx, uint8_t at_cmd_buf)
	Check the command parameters.

void	lteiot11_set_sim_apn (lteiot11_t ctx, uint8_t sim_apn)
	Set sim card APN.

void	lteiot11_send_sms_text (lteiot11_t ctx, uint8_t phone_number, uint8_t *sms_text)
	LTE IoT 11 send SMS in text mode.

err_t	lteiot11_send_sms_pdu (lteiot11_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	LTE IoT 11 send SMS in PDU mode.

err_t	lteiot11_parse_gga (uint8_t rsp_buf, uint8_t gga_element, uint8_t element_data)
	LTE IoT 11 parse GGA function.

Detailed Description

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

◆ lteiot11_cfg_setup()

void lteiot11_cfg_setup ( lteiot11_cfg_t * cfg )

LTE IoT 11 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ lteiot11_generic_read()

err_t lteiot11_generic_read	(	lteiot11_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

LTE IoT 11 data reading function.

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

Parameters

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

◆ lteiot11_generic_write()

err_t lteiot11_generic_write	(	lteiot11_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

LTE IoT 11 data writing function.

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

Parameters

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

◆ lteiot11_get_cts_pin()

uint8_t lteiot11_get_cts_pin ( lteiot11_t * ctx )

LTE IoT 11 get cts pin function.

This function returns the clear to send (CTS) pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ lteiot11_get_smi_pin()

uint8_t lteiot11_get_smi_pin ( lteiot11_t * ctx )

LTE IoT 11 get smi pin function.

This function returns the suspend mode indication (SMI) pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ lteiot11_init()

err_t lteiot11_init	(	lteiot11_t *	ctx,
		lteiot11_cfg_t *	cfg )

LTE IoT 11 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ lteiot11_parse_gga()

err_t lteiot11_parse_gga	(	uint8_t *	rsp_buf,
		uint8_t	gga_element,
		uint8_t *	element_data )

LTE IoT 11 parse GGA function.

This function parses the GGA data from the read response buffer.

Parameters

[in]	rsp_buf	: Response buffer.
[in]	gga_element	: GGA element position [1-14].
[out]	element_data	: Element data parsed.

Returns

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

Note: None.

◆ lteiot11_send_cmd()

void lteiot11_send_cmd	(	lteiot11_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 lteiot11_t object definition for detailed explanation.
[in]	cmd	: Command variable.

Returns: Nothing.

Note: None.

◆ lteiot11_send_cmd_check()

void lteiot11_send_cmd_check	(	lteiot11_t *	ctx,
		uint8_t *	at_cmd_buf )

Check the sent command.

This function checks the command that is sent.

Parameters

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

Returns: Nothing.

Note: None.

◆ lteiot11_send_cmd_par_check()

void lteiot11_send_cmd_par_check	(	lteiot11_t *	ctx,
		uint8_t *	at_cmd_buf )

Check the command parameters.

This function checks the command that is sent.

Parameters

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

Returns: Nothing.

Note: None.

◆ lteiot11_send_cmd_with_par()

void lteiot11_send_cmd_with_par	(	lteiot11_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 lteiot11_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.
[in]	param_buf	: Parameter buffer.

Returns: Nothing.

Note: None.

◆ lteiot11_send_sms_pdu()

err_t lteiot11_send_sms_pdu	(	lteiot11_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE IoT 11 send SMS in PDU mode.

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

Parameters

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

◆ lteiot11_send_sms_text()

void lteiot11_send_sms_text	(	lteiot11_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE IoT 11 send SMS in text mode.

This function sends text message to a phone number.

Parameters

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

Returns: Nothing.

Note: None.

◆ lteiot11_set_cs_pin()

void lteiot11_set_cs_pin	(	lteiot11_t *	ctx,
		uint8_t	state )

LTE IoT 11 set cs pin function.

This function sets the CS pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ lteiot11_set_on_pin()

void lteiot11_set_on_pin	(	lteiot11_t *	ctx,
		uint8_t	state )

LTE IoT 11 set on pin function.

This function sets the ON pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ lteiot11_set_rts_pin()

void lteiot11_set_rts_pin	(	lteiot11_t *	ctx,
		uint8_t	state )

LTE IoT 11 set rts pin function.

This function sets the RTS pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ lteiot11_set_sim_apn()

void lteiot11_set_sim_apn	(	lteiot11_t *	ctx,
		uint8_t *	sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters

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

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ lteiot11_cfg_setup()

◆ lteiot11_generic_read()

◆ lteiot11_generic_write()

◆ lteiot11_get_cts_pin()

◆ lteiot11_get_smi_pin()

◆ lteiot11_init()

◆ lteiot11_parse_gga()

◆ lteiot11_send_cmd()

◆ lteiot11_send_cmd_check()

◆ lteiot11_send_cmd_par_check()

◆ lteiot11_send_cmd_with_par()

◆ lteiot11_send_sms_pdu()

◆ lteiot11_send_sms_text()

◆ lteiot11_set_cs_pin()

◆ lteiot11_set_on_pin()

◆ lteiot11_set_rts_pin()

◆ lteiot11_set_sim_apn()