4gltena

\mainpage Main Page

---

4G LTE-NA click

4G LTE click is an LTE Cat 1 multimode cellular network solution, featuring the compact LARA-R2 series modem from u-blox. This module supports up two LTE bands. It also features a full range of options for the high speed cellular networking and communication, such as the network indication, full embedded TCP/UDP stack, HTTP and HTTPS transfer protocols, IPv4/IPv6 dual-stack support, secondary antenna for the RX diversity, antenna detection, jamming signal detection, embedded TLS 1.2 protocol for the improved security and more. 4G LARA click can achieve data rates up to 10.3 Mbps/5.2 Mbps (downlink/uplink).

click Product page

---

Click library

• Author : Stefan Ilic
• Date : Jun 2021.
• Type : UART type

Software Support

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

Standard key functions :

• c4gltena_cfg_setup Config Object Initialization function.

void c4gltena_cfg_setup ( c4gltena_cfg_t *cfg );

• c4gltena_init Initialization function.

err_t c4gltena_init ( c4gltena_t *ctx, c4gltena_cfg_t *cfg );

Example key functions :

• c4gltena_module_power_on This function powers ON the module.

void c4gltena_module_power_on ( c4gltena_t *ctx );

• c4gltena_send_cmd_with_parameter This function sends a command with specified parameter to the click module.

void c4gltena_send_cmd_with_parameter ( c4gltena_t *ctx, char *at_cmd_buf, char *param_buf );

• c4gltena_send_cmd_parameter_check This function checks the command that is sent.

void c4gltena_send_cmd_parameter_check ( c4gltena_t *ctx, char *at_cmd_buf );

Example Description

This example reads and processes data from 4G LTE NA click.

The demo application is composed of two sections :

Application Init

Initializes the driver and powers up the module, then sets default configuration for connecting the device to network.

void application_init ( void ) {
    log_cfg_t log_cfg;  /**< Logger config object. */
    c4gltena_cfg_t c4gltena_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.

    c4gltena_cfg_setup( &c4gltena_cfg );
    C4GLTENA_MAP_MIKROBUS( c4gltena_cfg, MIKROBUS_1 );
    c4gltena_init( &c4gltena, &c4gltena_cfg );
    
    c4gltena_module_power_on( &c4gltena );
    
    // dummy read
    c4gltena_process( );
    c4gltena_clear_app_buf( );
    
    // AT
    c4gltena_send_cmd( &c4gltena, C4GLTENA_CMD_AT );
    app_error_flag = c4gltena_rsp_check( );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // ATI - product information
    c4gltena_send_cmd( &c4gltena, C4GLTENA_CMD_ATI );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // CGMR - firmware version
    c4gltena_send_cmd( &c4gltena, C4GLTENA_CMD_CGMR );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // CMEE - Report Mobile Equipment Error
    c4gltena_send_cmd_with_parameter( &c4gltena, C4GLTENA_CMD_CMEE, "2" );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // COPS - deregister from network
    c4gltena_send_cmd_with_parameter( &c4gltena, C4GLTENA_CMD_COPS, "2" );
    Delay_ms( 4000 );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // CGDCONT - set sim apn
    c4gltena_set_sim_apn( &c4gltena, SIM_APN );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // CFUN - full funtionality
    c4gltena_send_cmd_with_parameter( &c4gltena, C4GLTENA_CMD_CFUN, "1" );
    Delay_ms( 2000 );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // COPS - automatic mode
    c4gltena_send_cmd_with_parameter( &c4gltena, C4GLTENA_CMD_COPS, "0" );
    Delay_ms( 4000 );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    // CREG - network registration status
    c4gltena_send_cmd_with_parameter( &c4gltena, C4GLTENA_CMD_CREG, "1" );
    app_error_flag = c4gltena_rsp_check(  );
    c4gltena_error_check( app_error_flag );
    Delay_ms( 500 );
    
    app_buf_len = 0;
    app_buf_cnt = 0;
    app_connection_status = WAIT_FOR_CONNECTION;
    log_info( &logger, " Application Task " );
    Delay_ms( 5000 );
}

Application Task

Waits for device to connect to network and then sends a desired SMS to the selected phone number approximately every 30 seconds.

void application_task ( void ) {
    if ( app_connection_status == WAIT_FOR_CONNECTION ) {
        // CREG - network registration status
        c4gltena_send_cmd_check( &c4gltena, C4GLTENA_CMD_CREG );
        app_error_flag = c4gltena_rsp_check(  );
        c4gltena_error_check( app_error_flag );
        Delay_ms( 500 );
        
        // CSQ - signal quality
        c4gltena_send_cmd( &c4gltena, C4GLTENA_CMD_CSQ );
        app_error_flag = c4gltena_rsp_check(  );
        c4gltena_error_check( app_error_flag );
        Delay_ms( 3000 );
    } else {
        log_info( &logger, "CONNECTED TO NETWORK" );
        
        // SMS message format - PDU mode
        c4gltena_send_cmd_with_parameter( &c4gltena, C4GLTENA_CMD_CMGF, "0" );
        app_error_flag = c4gltena_rsp_check(  );
        c4gltena_error_check( app_error_flag );
        Delay_ms( 3000 );
        
        for( ; ; ) {   
            log_printf( &logger, "> Sending message to phone number...\r\n" );
            c4gltena_send_sms_pdu ( &c4gltena, SIM_SMSC, PHONE_NUMBER_TO_MESSAGE, MESSAGE_CONTENT );
            app_error_flag = c4gltena_rsp_check(  );
            c4gltena_error_check( app_error_flag );
            Delay_ms( 10000 );
            Delay_ms( 10000 );
            Delay_ms( 10000 );
        }
    }
}

Note

In order for the example to work, user needs to set the phone number to which he wants to send an SMS, and also will need to set an APN and SMSC (required for PDU mode only) of entered SIM card. Enter valid data for the following macros: SIM_APN, SIM_SMSC and PHONE_NUMBER_TO_MESSAGE.

E.g.

• SIM_APN "vipmobile"
• 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.4GLTENA

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.

---