Skip to content

Latest commit

 

History

History

ltecat16

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

LTE Cat.1 6 Click

LTE Cat.1 6 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 : Jun 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 using standard "AT" commands.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.LTECat16

Example Key Functions

  • ltecat16_cfg_setup Config Object Initialization function.
void ltecat16_cfg_setup ( ltecat16_cfg_t *cfg );
  • ltecat16_init Initialization function.
err_t ltecat16_init ( ltecat16_t *ctx, ltecat16_cfg_t *cfg );
  • ltecat16_set_sim_apn This function sets APN for sim card.
void ltecat16_set_sim_apn ( ltecat16_t *ctx, uint8_t *sim_apn );
  • ltecat16_send_sms_text This function sends text message to a phone number.
void ltecat16_send_sms_text ( ltecat16_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
  • ltecat16_send_cmd This function sends a specified command to the Click module.
void ltecat16_send_cmd ( ltecat16_t *ctx, uint8_t *cmd );

Application Init

Initializes the driver and logger.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    ltecat16_cfg_t ltecat16_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    ltecat16_cfg_setup( &ltecat16_cfg );
    LTECAT16_MAP_MIKROBUS( ltecat16_cfg, MIKROBUS_1 );
    if ( UART_ERROR == ltecat16_init( &ltecat16, &ltecat16_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );

    app_state = LTECAT16_POWER_UP;
    log_printf( &logger, ">>> APP STATE - POWER UP <<<\r\n\n" );
}

Application Task

Application task is split in few stages:

  • LTECAT16_POWER_UP:

    Powers up the device, performs a device factory reset and reads system information.

  • LTECAT16_CONFIG_CONNECTION:

    Sets configuration to device to be able to connect to the network.

  • LTECAT16_CHECK_CONNECTION:

    Waits for the network registration indicated via CREG command and then checks the signal quality report.

  • LTECAT16_CONFIG_EXAMPLE:

    Configures device for the selected example.

  • LTECAT16_EXAMPLE:

    Depending on the selected demo example, it sends an SMS message (in PDU or TXT mode) or TCP/UDP message.

By default, the TCP/UDP example is selected.

void application_task ( void )
{
    switch ( app_state )
    {
        case LTECAT16_POWER_UP:
        {
            if ( LTECAT16_OK == ltecat16_power_up( &ltecat16 ) )
            {
                app_state = LTECAT16_CONFIG_CONNECTION;
                log_printf( &logger, ">>> APP STATE - CONFIG CONNECTION <<<\r\n\n" );
            }
            break;
        }
        case LTECAT16_CONFIG_CONNECTION:
        {
            if ( LTECAT16_OK == ltecat16_config_connection( &ltecat16 ) )
            {
                app_state = LTECAT16_CHECK_CONNECTION;
                log_printf( &logger, ">>> APP STATE - CHECK CONNECTION <<<\r\n\n" );
            }
            break;
        }
        case LTECAT16_CHECK_CONNECTION:
        {
            if ( LTECAT16_OK == ltecat16_check_connection( &ltecat16 ) )
            {
                app_state = LTECAT16_CONFIG_EXAMPLE;
                log_printf( &logger, ">>> APP STATE - CONFIG EXAMPLE <<<\r\n\n" );
            }
            break;
        }
        case LTECAT16_CONFIG_EXAMPLE:
        {
            if ( LTECAT16_OK == ltecat16_config_example( &ltecat16 ) )
            {
                app_state = LTECAT16_EXAMPLE;
                log_printf( &logger, ">>> APP STATE - EXAMPLE <<<\r\n\n" );
            }
            break;
        }
        case LTECAT16_EXAMPLE:
        {
            ltecat16_example( &ltecat16 );
            break;
        }
        default:
        {
            log_error( &logger, " APP STATE." );
            break;
        }
    }
}

Note

In order for the examples to work, 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"

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.