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

Topics
	LTE IoT 8 Commands List
	List of commands of LTE IoT 8 Click driver.

	LTE IoT 8 Device Settings
	Settings for registers of LTE IoT 8 Click driver.

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

	Lteiot8_cmd

Functions
void	lteiot8_cfg_setup (lteiot8_cfg_t *cfg)
	LTE IoT 8 configuration object setup function.

err_t	lteiot8_init (lteiot8_t ctx, lteiot8_cfg_t cfg)
	LTE IoT 8 initialization function.

err_t	lteiot8_default_cfg (lteiot8_t *ctx)
	LTE IoT 8 default configuration function.

err_t	lteiot8_generic_write (lteiot8_t ctx, char data_buf, uint16_t len)
	LTE IoT 8 data writing function.

err_t	lteiot8_generic_read (lteiot8_t ctx, char data_buf, uint16_t max_len)
	LTE IoT 8 data reading function.

void	lteiot8_send_cmd (lteiot8_t ctx, char cmd)
	Send command function.

void	lteiot8_send_cmd_with_parameter (lteiot8_t ctx, char at_cmd_buf, char *param_buf)
	Send command with parameters.

void	lteiot8_send_cmd_check (lteiot8_t ctx, char at_cmd_buf)
	Send command to check commands current value.

void	lteiot8_send_cmd_syntax_check (lteiot8_t ctx, char at_cmd_buf)
	Send command to check commands available parameters.

void	lteiot8_set_sim_apn (lteiot8_t ctx, char sim_apn)
	Set SIM APN.

void	lteiot8_send_text_message (lteiot8_t ctx, char phone_number, char *message_content)
	Send SMS message to number in text mode.

err_t	lteiot8_send_sms_pdu (lteiot8_t ctx, char service_center_number, char phone_number, char sms_text)
	Send SMS message to number in pdu mode.

Detailed Description

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

◆ lteiot8_cfg_setup()

void lteiot8_cfg_setup ( lteiot8_cfg_t * cfg )

LTE IoT 8 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ lteiot8_default_cfg()

err_t lteiot8_default_cfg ( lteiot8_t * ctx )

LTE IoT 8 default configuration function.

This function executes a default configuration of LTE IoT 8 click board.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ lteiot8_generic_read()

err_t lteiot8_generic_read	(	lteiot8_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

LTE IoT 8 data reading function.

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

Parameters

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

◆ lteiot8_generic_write()

err_t lteiot8_generic_write	(	lteiot8_t *	ctx,
		char *	data_buf,
		uint16_t	len )

LTE IoT 8 data writing function.

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

Parameters

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

◆ lteiot8_init()

err_t lteiot8_init	(	lteiot8_t *	ctx,
		lteiot8_cfg_t *	cfg )

LTE IoT 8 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ lteiot8_send_cmd()

void lteiot8_send_cmd	(	lteiot8_t *	ctx,
		char *	cmd )

Send command function.

Send string byte by byte and additionaly send CR flag.

Parameters

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

Returns: Nothing.

◆ lteiot8_send_cmd_check()

void lteiot8_send_cmd_check	(	lteiot8_t *	ctx,
		char *	at_cmd_buf )

Send command to check commands current value.

Send AT command (at_cmd_buf) and appends '?' to check commands value.

Parameters

[in]	ctx	: Click context object. See lteiot8_t object definition for detailed explanation.
[in]	at_cmd_buf	: AT command.

Returns: Nothing.

◆ lteiot8_send_cmd_syntax_check()

void lteiot8_send_cmd_syntax_check	(	lteiot8_t *	ctx,
		char *	at_cmd_buf )

Send command to check commands available parameters.

Send AT command (at_cmd_buf) and appends '?' to check commands value.

Parameters

[in]	ctx	: Click context object. See lteiot8_t object definition for detailed explanation.
[in]	at_cmd_buf	: AT command.

Returns: Nothing.

◆ lteiot8_send_cmd_with_parameter()

void lteiot8_send_cmd_with_parameter	(	lteiot8_t *	ctx,
		char *	at_cmd_buf,
		char *	param_buf )

Send command with parameters.

Send AT command (at_cmd_buf) with '=' and parameter(param_buf) to set commands value.

Parameters

[in]	ctx	: Click context object. See lteiot8_t object definition for detailed explanation.
[in]	at_cmd_buf	: AT command.
[in]	param_buf	: Parameter for AT command.

Returns: Nothing.

◆ lteiot8_send_sms_pdu()

err_t lteiot8_send_sms_pdu	(	lteiot8_t *	ctx,
		char *	service_center_number,
		char *	phone_number,
		char *	sms_text )

Send SMS message to number in pdu mode.

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

Parameters

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

◆ lteiot8_send_text_message()

void lteiot8_send_text_message	(	lteiot8_t *	ctx,
		char *	phone_number,
		char *	message_content )

Send SMS message to number in text mode.

Send command for SIM message with function parameters for device to send SMS message.

Parameters

[in]	ctx	: Click context object. See lteiot8_t object definition for detailed explanation.
[in]	phone_number	: Phone number to send message to.
[in]	message_context	: Content of the message.

Returns: Nothing.

Note: Device should be configured for .

◆ lteiot8_set_sim_apn()

void lteiot8_set_sim_apn	(	lteiot8_t *	ctx,
		char *	sim_apn )

Set SIM APN.

Send command to select SIM APN.

Parameters

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

Returns: Nothing.

Topics

Functions

Detailed Description

Function Documentation

◆ lteiot8_cfg_setup()

◆ lteiot8_default_cfg()

◆ lteiot8_generic_read()

◆ lteiot8_generic_write()

◆ lteiot8_init()

◆ lteiot8_send_cmd()

◆ lteiot8_send_cmd_check()

◆ lteiot8_send_cmd_syntax_check()

◆ lteiot8_send_cmd_with_parameter()

◆ lteiot8_send_sms_pdu()

◆ lteiot8_send_text_message()

◆ lteiot8_set_sim_apn()