lteiot11  2.1.0.0
Main Page

LTE IoT 11 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Stefan Filipovic
  • Date : Mar 2023.
  • Type : UART type

Software Support

We provide a library for the LTE IoT 11 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for LTE IoT 11 Click driver.

Standard key functions :

Example key functions :

  • lteiot11_set_sim_apn This function sets APN for sim card.
    void lteiot11_set_sim_apn ( lteiot11_t *ctx, char *sim_apn );
  • lteiot11_send_sms_text This function sends text message to a phone number.
    void lteiot11_send_sms_text ( lteiot11_t *ctx, char *phone_number, char *sms_text );
  • lteiot11_parse_gga This function parses the GGA data from the read response buffer.
    err_t lteiot11_parse_gga ( char *rsp_buf, uint8_t gga_element, char *element_data );

Example Description

Application example shows device capability of connecting to the network and sending SMS or TCP/UDP messages, or retrieving data from GNSS using standard "AT" commands.

The demo application is composed of two sections :

Application Init

Initializes the driver, tests the communication by sending "AT" command, and after that restarts the device.

void application_init ( void )
{
log_cfg_t log_cfg;
lteiot11_cfg_t lteiot11_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
lteiot11_cfg_setup( &lteiot11_cfg );
LTEIOT11_MAP_MIKROBUS( lteiot11_cfg, MIKROBUS_1 );
if ( UART_ERROR == lteiot11_init( &lteiot11, &lteiot11_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
lteiot11_process( );
lteiot11_clear_app_buf( );
// Check communication
error_flag = lteiot11_rsp_check( LTEIOT11_RSP_OK );
lteiot11_error_check( error_flag );
// Restart device
#define RESTART_DEVICE "1,1"
lteiot11_send_cmd_with_parameter( &lteiot11, LTEIOT11_CMD_CFUN, RESTART_DEVICE );
error_flag = lteiot11_rsp_check( LTEIOT11_RSP_SYSSTART );
lteiot11_error_check( error_flag );
log_info( &logger, " Application Task " );
}

Application Task

Application task is split in few stages:

  • LTEIOT11_CONFIGURE_FOR_NETWORK:

    Sets configuration to device to be able to connect to the network. (used only for SMS or TCP/UDP demo examples).

  • LTEIOT11_WAIT_FOR_CONNECTION:

    Waits for the network registration indicated via CREG URC event and then checks the connection status (used only for SMS or TCP/UDP demo examples).

  • LTEIOT11_CONFIGURE_FOR_EXAMPLE:

    Sets the device configuration for sending SMS or TCP/UDP messages or for retrieving data from GNSS depending on the selected demo example.

  • LTEIOT11_EXAMPLE:

    Depending on the selected demo example, it sends an SMS message (in PDU or TXT mode) or TCP/UDP message or waits for the GPS fix to retrieve location info from GNSS. By default, the TCP/UDP example is selected.

void application_task ( void )
{
switch ( example_state )
{
{
if ( LTEIOT11_OK == lteiot11_configure_for_network( ) )
{
}
break;
}
{
if ( LTEIOT11_OK == lteiot11_check_connection( ) )
{
}
break;
}
{
if ( LTEIOT11_OK == lteiot11_configure_for_example( ) )
{
example_state = LTEIOT11_EXAMPLE;
}
break;
}
{
lteiot11_example( );
break;
}
default:
{
log_error( &logger, " Example state." );
break;
}
}
}

Note

In order for the examples to work (except GNSS example), user needs to set the APN and SMSC (SMS PDU mode only)

of entered SIM card as well as the phone number (SMS mode only) to which he wants to send an SMS. Enter valid values for the following macros: SIM_APN, SIM_SMSC and PHONE_NUMBER_TO_MESSAGE.

Example:

  • SIM_APN "internet"
  • SIM_SMSC "+381610401"
  • PHONE_NUMBER_TO_MESSAGE "+381659999999"

In order to establish communication with the module, some of the supported MCUs may require the UART RX line

to be pulled up additionally either with the external or internal weak pull-up resistor.

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.LTEIoT11

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


RESTART_DEVICE
#define RESTART_DEVICE
lteiot11_set_sim_apn
void lteiot11_set_sim_apn(lteiot11_t *ctx, uint8_t *sim_apn)
Set sim card APN.
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.
lteiot11_t
LTE IoT 11 Click context object.
Definition: lteiot11.h:155
lteiot11_cfg_setup
void lteiot11_cfg_setup(lteiot11_cfg_t *cfg)
LTE IoT 11 configuration object setup function.
application_task
void application_task(void)
Definition: main.c:249
LTEIOT11_WAIT_FOR_CONNECTION
@ LTEIOT11_WAIT_FOR_CONNECTION
Definition: main.c:96
lteiot11_send_cmd
void lteiot11_send_cmd(lteiot11_t *ctx, uint8_t *cmd)
Send command function.
LTEIOT11_EXAMPLE
@ LTEIOT11_EXAMPLE
Definition: main.c:98
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.
LTEIOT11_CMD_AT
#define LTEIOT11_CMD_AT
LTE IoT 11 control commands.
Definition: lteiot11.h:59
LTEIOT11_RSP_SYSSTART
#define LTEIOT11_RSP_SYSSTART
Definition: lteiot11.h:83
LTEIOT11_MAP_MIKROBUS
#define LTEIOT11_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: lteiot11.h:138
LTEIOT11_CMD_CFUN
#define LTEIOT11_CMD_CFUN
Definition: lteiot11.h:61
lteiot11_init
err_t lteiot11_init(lteiot11_t *ctx, lteiot11_cfg_t *cfg)
LTE IoT 11 initialization function.
LTEIOT11_RSP_OK
#define LTEIOT11_RSP_OK
LTE IoT 11 device response for AT commands.
Definition: lteiot11.h:81
LTEIOT11_CONFIGURE_FOR_NETWORK
@ LTEIOT11_CONFIGURE_FOR_NETWORK
Definition: main.c:95
application_init
void application_init(void)
Definition: main.c:203
lteiot11_cfg_t
LTE IoT 11 Click configuration object.
Definition: lteiot11.h:179
LTEIOT11_OK
@ LTEIOT11_OK
Definition: lteiot11.h:206
LTEIOT11_CONFIGURE_FOR_EXAMPLE
@ LTEIOT11_CONFIGURE_FOR_EXAMPLE
Definition: main.c:97