lteiot3 2.1.0.0
Main Page

LTE IoT 3 click

‍LTE IoT 3 Click is a compact add-on board that contains a Low Power Wide Area (LPWA) Wireless IoT module that allows connections to the LTE CAT-M1, CAT NB1/2, and 2G networks. This board features the EXS82-W, LTE-IoT Wireless Module from Thales that offers a rich set of Internet protocols and industry-standard interfaces such as UART, USB, etc. Global IoT connectivity, integrated GNSS support, SMS support, extended coverage range, and reduced power consumption makes this single IoT module an excellent choice for device makers while ensuring worldwide reliability.

click Product page


Click library

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

Software Support

We provide a library for the LTE IoT 3 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 3 Click driver.

Standard key functions :

Example key functions :

  • lteiot3_set_sim_apn This function sets APN for sim card.
    void lteiot3_set_sim_apn ( lteiot3_t *ctx, char *sim_apn );
    void lteiot3_set_sim_apn(lteiot3_t *ctx, uint8_t *sim_apn)
    Set sim card APN.
  • lteiot3_send_sms_text This function sends text message to a phone number.
    void lteiot3_send_sms_text ( lteiot3_t *ctx, char *phone_number, char *sms_text );
    void lteiot3_send_sms_text(lteiot3_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
    LTE IoT 3 send SMS in text mode.
  • lteiot3_parse_gga This function parses the GGA data from the read response buffer.
    err_t lteiot3_parse_gga ( char *rsp_buf, uint8_t gga_element, char *element_data );
    err_t lteiot3_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
    LTE IoT 3 parse GGA function.

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;
lteiot3_cfg_t lteiot3_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
lteiot3_cfg_setup( &lteiot3_cfg );
LTEIOT3_MAP_MIKROBUS( lteiot3_cfg, MIKROBUS_1 );
if ( UART_ERROR == lteiot3_init( &lteiot3, &lteiot3_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
lteiot3_process( );
lteiot3_clear_app_buf( );
// Check communication
error_flag = lteiot3_rsp_check( LTEIOT3_RSP_OK );
lteiot3_error_check( error_flag );
// Restart device
#define RESTART_DEVICE "1,1"
error_flag = lteiot3_rsp_check( LTEIOT3_RSP_SYSSTART );
lteiot3_error_check( error_flag );
log_info( &logger, " Application Task " );
}
#define LTEIOT3_RSP_SYSSTART
Definition lteiot3.h:97
#define LTEIOT3_CMD_AT
LTE IoT 3 control commands.
Definition lteiot3.h:73
#define LTEIOT3_CMD_CFUN
Definition lteiot3.h:75
#define LTEIOT3_RSP_OK
LTE IoT 3 device response for AT commands.
Definition lteiot3.h:95
#define LTEIOT3_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition lteiot3.h:160
void lteiot3_send_cmd(lteiot3_t *ctx, uint8_t *cmd)
Send command function.
void lteiot3_send_cmd_with_parameter(lteiot3_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
void application_init(void)
Definition main.c:202
@ LTEIOT3_CONFIGURE_FOR_NETWORK
Definition main.c:94
#define RESTART_DEVICE

Application Task

‍Application task is split in few stages:

  • LTEIOT3_CONFIGURE_FOR_NETWORK: Sets configuration to device to be able to connect to the network. (used only for SMS or TCP/UDP demo examples).
  • LTEIOT3_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).
  • LTEIOT3_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.
  • LTEIOT3_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 ( LTEIOT3_OK == lteiot3_configure_for_network( ) )
{
example_state = LTEIOT3_WAIT_FOR_CONNECTION;
}
break;
}
{
if ( LTEIOT3_OK == lteiot3_check_connection( ) )
{
}
break;
}
{
if ( LTEIOT3_OK == lteiot3_configure_for_example( ) )
{
example_state = LTEIOT3_EXAMPLE;
}
break;
}
{
lteiot3_example( );
break;
}
default:
{
log_error( &logger, " Example state." );
break;
}
}
}
@ LTEIOT3_OK
Definition lteiot3.h:228
void application_task(void)
Definition main.c:248
@ LTEIOT3_WAIT_FOR_CONNECTION
Definition main.c:95
@ LTEIOT3_EXAMPLE
Definition main.c:97
@ LTEIOT3_CONFIGURE_FOR_EXAMPLE
Definition main.c:96

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"

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.LTEIoT3

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.