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

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

	LTE IoT 9 Device Settings
	Helping defines of LTE IoT 9 Click driver.

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

Functions
void	lteiot9_cfg_setup (lteiot9_cfg_t *cfg)
	LTE IoT 9 configuration object setup function.

err_t	lteiot9_init (lteiot9_t ctx, lteiot9_cfg_t cfg)
	LTE IoT 9 initialization function.

err_t	lteiot9_default_cfg (lteiot9_t *ctx)
	LTE IoT 9 default configuration function.

err_t	lteiot9_generic_write (lteiot9_t ctx, char data_buf, uint16_t len)
	LTE IoT 9 data writing function.

err_t	lteiot9_generic_read (lteiot9_t ctx, char data_buf, uint16_t max_len)
	LTE IoT 9 data reading function.

void	lteiot9_set_pin_on (lteiot9_t *ctx, uint8_t state)
	Set ON pin state.

void	lteiot9_send_cmd (lteiot9_t ctx, char cmd)
	Send command function.

void	lteiot9_send_cmd_with_parameter (lteiot9_t ctx, char at_cmd_buf, char *param_buf)
	Send command function with parameter.

void	lteiot9_send_cmd_check (lteiot9_t ctx, char at_cmd_buf)
	Check the sent command.

void	lteiot9_send_cmd_parameter_check (lteiot9_t ctx, char at_cmd_buf)
	Check the command parameters.

void	lteiot9_set_sim_apn (lteiot9_t ctx, char sim_apn)
	Set sim card APN.

void	lteiot9_send_text_message (lteiot9_t ctx, char phone_number, char *message_context)
	LTE IoT 9 send text message.

Detailed Description

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

◆ lteiot9_cfg_setup()

void lteiot9_cfg_setup ( lteiot9_cfg_t * cfg )

LTE IoT 9 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ lteiot9_default_cfg()

err_t lteiot9_default_cfg ( lteiot9_t * ctx )

LTE IoT 9 default configuration function.

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

Parameters

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

◆ lteiot9_generic_read()

err_t lteiot9_generic_read	(	lteiot9_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

LTE IoT 9 data reading function.

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

Parameters

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

◆ lteiot9_generic_write()

err_t lteiot9_generic_write	(	lteiot9_t *	ctx,
		char *	data_buf,
		uint16_t	len )

LTE IoT 9 data writing function.

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

Parameters

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

◆ lteiot9_init()

err_t lteiot9_init	(	lteiot9_t *	ctx,
		lteiot9_cfg_t *	cfg )

LTE IoT 9 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ lteiot9_send_cmd()

void lteiot9_send_cmd	(	lteiot9_t *	ctx,
		char *	cmd )

Send command function.

This function sends the specified command to the click module.

Parameters

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

Returns: Nothing.

◆ lteiot9_send_cmd_check()

void lteiot9_send_cmd_check	(	lteiot9_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 lteiot9_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

◆ lteiot9_send_cmd_parameter_check()

void lteiot9_send_cmd_parameter_check	(	lteiot9_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 lteiot9_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

◆ lteiot9_send_cmd_with_parameter()

void lteiot9_send_cmd_with_parameter	(	lteiot9_t *	ctx,
		char *	at_cmd_buf,
		char *	param_buf )

Send command function with parameter.

This function sends commands to the click module.

Parameters

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

Returns: Nothing.

◆ lteiot9_send_text_message()

void lteiot9_send_text_message	(	lteiot9_t *	ctx,
		char *	phone_number,
		char *	message_context )

LTE IoT 9 send text message.

This function sends text message to a phone number.

Parameters

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

Returns: Nothing.

◆ lteiot9_set_pin_on()

void lteiot9_set_pin_on	(	lteiot9_t *	ctx,
		uint8_t	state )

Set ON pin state.

This function sets pin ON to desired state.

Parameters

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

Returns: Nothing.

◆ lteiot9_set_sim_apn()

void lteiot9_set_sim_apn	(	lteiot9_t *	ctx,
		char *	sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters

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

Returns: Nothing.

Topics

Functions

Detailed Description

Function Documentation

◆ lteiot9_cfg_setup()

◆ lteiot9_default_cfg()

◆ lteiot9_generic_read()

◆ lteiot9_generic_write()

◆ lteiot9_init()

◆ lteiot9_send_cmd()

◆ lteiot9_send_cmd_check()

◆ lteiot9_send_cmd_parameter_check()

◆ lteiot9_send_cmd_with_parameter()

◆ lteiot9_send_text_message()

◆ lteiot9_set_pin_on()

◆ lteiot9_set_sim_apn()