Skip to content

Latest commit

 

History

History
207 lines (163 loc) · 7.19 KB

README.md

File metadata and controls

207 lines (163 loc) · 7.19 KB
Raw

\mainpage Main Page

4G LTE 2 Data Click

4G LTE 2 Click is a compact add-on board representing a secure-cloud multi-band solution offering universal connectivity and reliable performance. This board features the LARA-R6001D, the world’s smallest LTE Cat 1 module with global coverage and a built-in MQTT client from u-blox, representing a data-only solution. Equipped with familiar AT commands set over the UART interface, USB interface, and Network and Status indicators, the LARA-R6001D also has a comprehensive certification scheme, multi-band and multi-mode capabilities providing excellent flexibility, except for the support of voice/audio application.

Click Product page

Click library

  • Author : Stefan Filipovic
  • Date : Sep 2022.
  • Type : UART type

Software Support

We provide a library for the 4G LTE 2 Data 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 4G LTE 2 Data Click driver.

Standard key functions :

  • c4glte2data_cfg_setup Config Object Initialization function.
void c4glte2data_cfg_setup ( c4glte2data_cfg_t *cfg );
  • c4glte2data_init Initialization function.
err_t c4glte2data_init ( c4glte2data_t *ctx, c4glte2data_cfg_t *cfg );

Example key functions :

  • c4glte2data_set_power_state This function sets a desired power state by toggling PWR pin with a specific time for high state.
void c4glte2data_set_power_state ( c4glte2data_t *ctx, uint8_t state );
  • c4glte2data_set_sim_apn This function sets APN for sim card.
void c4glte2data_set_sim_apn ( c4glte2data_t *ctx, char *sim_apn );
  • c4glte2data_send_sms_text This function sends text message to a phone number.
void c4glte2data_send_sms_text ( c4glte2data_t *ctx, char *phone_number, char *sms_text );

Example Description

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

The demo application is composed of two sections :

Application Init

Initializes the driver, restarts the module and tests the communication.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    c4glte2data_cfg_t c4glte2data_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.
    c4glte2data_cfg_setup( &c4glte2data_cfg );
    C4GLTE2DATA_MAP_MIKROBUS( c4glte2data_cfg, MIKROBUS_1 );
    if ( UART_ERROR == c4glte2data_init( &c4glte2data, &c4glte2data_cfg ) )
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );
        for ( ; ; );
    }
    c4glte2data_set_power_state ( &c4glte2data, C4GLTE2DATA_POWER_STATE_OFF );
    c4glte2data_set_power_state ( &c4glte2data, C4GLTE2DATA_POWER_STATE_ON );
    c4glte2data_process( );
    c4glte2data_clear_app_buf( );
    app_buf_len = 0;
    app_buf_cnt = 0;

    // Check communication
    c4glte2data_send_cmd( &c4glte2data, C4GLTE2DATA_CMD_AT );
    error_flag = c4glte2data_rsp_check( );
    c4glte2data_error_check( error_flag );

    log_info( &logger, " Application Task " );
    example_state = C4GLTE2DATA_CONFIGURE_FOR_NETWORK;
}

Application Task

Application task is split in few stages:

  • C4GLTE2DATA_CONFIGURE_FOR_NETWORK:

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

  • C4GLTE2DATA_WAIT_FOR_CONNECTION:

    Waits for the network registration indicated via CREG URC event and then checks the connection status.

  • C4GLTE2DATA_CONFIGURE_FOR_EXAMPLE:

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

  • C4GLTE2DATA_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 ( example_state )
    {
        case C4GLTE2DATA_CONFIGURE_FOR_NETWORK:
        {
            if ( C4GLTE2DATA_OK == c4glte2data_configure_for_network( ) )
            {
                example_state = C4GLTE2DATA_WAIT_FOR_CONNECTION;
            }
            break;
        }
        case C4GLTE2DATA_WAIT_FOR_CONNECTION:
        {
            if ( C4GLTE2DATA_OK == c4glte2data_check_connection( ) )
            {
                example_state = C4GLTE2DATA_CONFIGURE_FOR_EXAMPLE;
            }
            break;
        }
        case C4GLTE2DATA_CONFIGURE_FOR_EXAMPLE:
        {
            if ( C4GLTE2DATA_OK == c4glte2data_configure_for_example( ) )
            {
                example_state = C4GLTE2DATA_EXAMPLE;
            }
            break;
        }
        case C4GLTE2DATA_EXAMPLE:
        {
            c4glte2data_example( );
            break;
        }
        default:
        {
            log_error( &logger, " Example 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"

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.4GLTE2Data

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.