LTE IoT 5 Click
LTE IoT 5 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.
Click Library
- Author : Stefan Filipovic
- Date : Nov 2024.
- Type : UART type
Software Support
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.
Example Libraries
- MikroSDK.Board
- MikroSDK.Log
- Click.LTEIoT5
Example Key Functions
- lteiot5_cfg_setup Config Object Initialization function.
void lteiot5_cfg_setup(lteiot5_cfg_t *cfg)
LTE IoT 5 configuration object setup function.
LTE IoT 5 Click configuration object.
Definition lteiot5.h:214
- lteiot5_init Initialization function.
err_t lteiot5_init(lteiot5_t *ctx, lteiot5_cfg_t *cfg)
LTE IoT 5 initialization function.
LTE IoT 5 Click context object.
Definition lteiot5.h:189
- lteiot5_set_sim_apn This function sets APN for sim card.
void lteiot5_set_sim_apn(lteiot5_t *ctx, uint8_t *sim_apn)
Set sim card APN.
- lteiot5_send_sms_text This function sends text message to a phone number.
void lteiot5_send_sms_text(lteiot5_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 5 send SMS in text mode.
- lteiot5_cmd_set This function sets a value to a specified command of the Click module.
void lteiot5_cmd_set(lteiot5_t *ctx, uint8_t *cmd, uint8_t *value)
LTE IoT 5 cmd set function.
Application Init
Initializes the driver and logger.
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
log_printf( &logger, ">>> APP STATE - POWER UP <<<\r\n\n" );
}
#define LTEIOT5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition lteiot5.h:172
void application_init(void)
Definition main.c:215
@ LTEIOT5_POWER_UP
Definition main.c:96
Application Task
Application task is split in few stages:
- LTEIOT5_POWER_UP:
Powers up the device, performs a device factory reset and reads system information.
- LTEIOT5_CONFIG_CONNECTION:
Sets configuration to device to be able to connect to the network (used only for SMS or TCP/UDP demo examples).
- LTEIOT5_CHECK_CONNECTION:
Waits for the network registration indicated via CEREG command and then checks the signal quality report (used only for SMS or TCP/UDP demo examples).
- LTEIOT5_CONFIG_EXAMPLE:
Configures device for the selected example.
- LTEIOT5_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.
{
switch ( app_state )
{
{
{
log_printf( &logger, ">>> APP STATE - CONFIG CONNECTION <<<\r\n\n" );
}
break;
}
{
if (
LTEIOT5_OK == lteiot5_config_connection( <eiot5 ) )
{
log_printf( &logger, ">>> APP STATE - CHECK CONNECTION <<<\r\n\n" );
}
break;
}
{
if (
LTEIOT5_OK == lteiot5_check_connection( <eiot5 ) )
{
log_printf( &logger, ">>> APP STATE - CONFIG EXAMPLE <<<\r\n\n" );
}
break;
}
{
if (
LTEIOT5_OK == lteiot5_config_example( <eiot5 ) )
{
log_printf( &logger, ">>> APP STATE - EXAMPLE <<<\r\n\n" );
}
break;
}
{
lteiot5_example( <eiot5 );
break;
}
default:
{
log_error( &logger, " APP STATE." );
break;
}
}
}
@ LTEIOT5_OK
Definition lteiot5.h:241
void application_task(void)
Definition main.c:248
@ LTEIOT5_CONFIG_EXAMPLE
Definition main.c:99
@ LTEIOT5_EXAMPLE
Definition main.c:100
@ LTEIOT5_CONFIG_CONNECTION
Definition main.c:97
@ LTEIOT5_CHECK_CONNECTION
Definition main.c:98
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.
Example:
- SIM_APN "internet"
- SIM_SMSC "+381610401"
- PHONE_NUMBER "+381659999999"
Application Output
This Click board can be interfaced and monitored in two ways:
- Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
- UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.
Additional Notes and Information
The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.