Advanced
30 min

Provide high-speed data connectivity over LTE network in IoT applications with LEXI-R10801D and PIC32MX470F512H

Professional-grade single-mode LTE Cat 1bis solution for EMEA, APAC, and Brazilian regions

4G LTE 3 Click (for Europe) with 6LoWPAN clicker

Published Dec 16, 2024

Click board™

4G LTE 3 Click (for Europe)

Dev. board

6LoWPAN clicker

Compiler

NECTO Studio

MCU

PIC32MX470F512H

Reliable LTE connectivity with tracking capabilities and medium data speeds perfect for asset tracking and telematics

A

A

Hardware Overview

How does it work?

4G LTE 3 Click (for Europe) is based on the LEXI-R10801D, a single-mode LTE Cat 1bis module from u-blox, made for applications requiring reliable connectivity, medium data speeds, and extensive coverage in the EMEA, APAC, and Brazilian regions. The LEXI-R10801D module is designed to meet professional-grade standards, adhering to the u-blox qualification policy and the stringent AEC-Q104 standard. It supports various LTE FDD bands, including 1, 3, 5, 7, 8, 20, and 28, ensuring broad compatibility and superior performance across multiple regional networks. Additionally, the module has regulatory certifications such as RED, NCC, RCM, and Anatel, allowing seamless deployment across supported markets. Beyond its LTE functionality, the LEXI-R10801D integrates an embedded Wi-Fi radio, enabling the scanning of Wi-Fi hotspots for enhanced indoor positioning, and supports the u-blox CellLocate® service for advanced geolocation capabilities. This compact and highly integrated module offers medium-capacity data connectivity, achieving download speeds of up to 10Mbps and upload speeds of 5Mbps, all while maintaining exceptionally low power consumption. These features make it an ideal choice for cost-sensitive applications that demand moderate data speeds and reliable coverage. Its versatile use cases include asset tracking, telematics, healthcare devices, and wearables, where efficient and robust connectivity is paramount. Communication between the LEXI-

R10801D and the host MCU is made through a UART interface, using standard UART RX and TX pins and hardware flow control pins (CTS/RTS/RI - Clear to Send/Ready to Send/Ring Indicator) for efficient data transfer. The module defaults to a communication speed of 115200bps, allowing for seamless data exchange over AT commands. This Click board™ also includes a USB Type C connector for power and data transfer, which is compliant with the USB 2.0 specification with a maximum 480Mbit/s data rate (peripheral only). In addition to this interface, the board also features a USB FW upgrade switch on the back of the board labeled USB BOOT to manage firmware upgrades. This switch has positions 0 for normal operation and 1 for firmware upgrades over USB, ensuring a straightforward upgrade process. The 4G LTE 3 Click includes several additional functionalities that enhance its usability and control. The PWR button allows users to easily power the module ON or OFF, while the RESET button provides a quick way to reset the module. These functions can also be controlled digitally via the mikroBUS™ pins PWR and RST, offering greater flexibility. The board also includes an unsoldered header with six GPIO pins, allowing for further customization. Moreover, this board also has dedicated test points for diagnostic purposes, TP1 and TP2, if the host MCU uses the USB and main UART interfaces and two visual indicators to provide real-time status updates. The first red NET LED indicates the current network

status of the module. The device has successfully registered on the network when the LED blinks slowly. If the LED blinks at a normal pace, the device has not yet registered to a network. A fast blinking pattern signals data transmission. When the LED is completely OFF, it indicates that the device is either powered OFF or in Power Saving Mode (PSM). The second yellow STAT LED indicates the module's power status, which stays off when the module is OFF and turns ON when the module is powered on or firmware ready. The board features one u.Fl connector for the main LTE antenna that MIKROE offers, like the LTE Flat Rotation Antenna combined with an IPEX-SMA cable for flexible and efficient connectivity. The board also has a micro SIM card holder that supports both 1.8V and 3.0V uSIM cards, allowing users to select the most appropriate service provider for their particular use case. This Click board™ can operate with both 3.3V and 5V logic voltage levels selected via the VCC SEL jumper. Since the LEXI-R10801D module operates at 3.8V, a logic-level translator, the TXB0106 is also used for proper operation and an accurate signal-level translation. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. Also, this Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used as a reference for further development.

4G LTE 3 Click (for Europe) hardware overview image

Features overview

Development board

6LoWPAN Clicker is a compact starter development board that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It comes with an onboard 32-bit PIC microcontroller, the PIC32MX470F512H from Microchip, a USB connector, LED indicators, buttons, a mikroProg connector, and a header for interfacing with external electronics. Along with this microcontroller, the board also contains a 2.4GHz ISM band transceiver, allowing you to add wireless communication to your target application. Its compact design provides a fluid and immersive working experience, allowing access anywhere

and under any circumstances. Each part of the 6LoWPAN Clicker development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the 6LoWPAN Clicker programming method, using USB HID mikroBootloader, or through an external mikroProg connector for PIC, dsPIC, or PIC32 programmer, the Clicker board also includes a clean and regulated power supply module for the development kit. The USB Micro-B connection can provide up to 500mA of current for the Clicker board, which is more than enough to operate all onboard and additional modules, or it can power

over two standard AA batteries. All communication methods that mikroBUS™ itself supports are on this board, including the well-established mikroBUS™ socket, reset button, and several buttons and LED indicators. 6LoWPAN Clicker is an integral part of the Mikroe ecosystem, allowing you to create a new application in minutes. Natively supported by Mikroe software tools, it covers many aspects of prototyping thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

6LoWPAN clicker double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC32

MCU Memory (KB)

512

Silicon Vendor

Microchip

Pin count

64

RAM (Bytes)

131072

You complete me!

Accessories

LTE Flat Rotation Antenna is a versatile choice for boosting the performance of 3G/4G LTE devices. With a wide frequency range of 700-2700MHz, it ensures optimal connectivity on major cellular bands worldwide. This flat antenna features an SMA male connector, making it easy to attach directly to your device or SMA module connector. One of its standout features is its adjustable angle, which can be set in 45⁰ increments (0⁰/45⁰/90⁰), allowing you to fine-tune the antenna's orientation for maximum signal reception. With an impedance of 50Ω and a VSW Ratio of <2.0:1, this antenna ensures a reliable and efficient connection. Its 5dB gain, vertical polarization, and omnidirectional radiation pattern enhance signal strength, making it suitable for various applications. Measuring 196mm in length and 38mm in width, this antenna offers a compact yet effective solution for improving your connectivity. With a maximum input power of 50W, it can handle the demands of various devices.

4G LTE 3 Click (for Europe) accessories 1 image

IPEX-SMA cable is a type of RF (radio frequency) cable assembly. "IPEX" refers to the IPEX connector, a miniature coaxial connector commonly used in small electronic devices. "SMA" stands for SubMiniature Version A and is another coaxial connector commonly used in RF applications. An IPEX-SMA cable assembly has an IPEX connector on one end and an SMA connector on the other, allowing it to connect devices or components that use these specific connectors. These cables are often used in applications like WiFi or cellular antennas, GPS modules, and other RF communication systems where a reliable and low-loss connection is required.

4G LTE 3 Click (for Europe) accessories 2 image

Used MCU Pins

mikroBUS™ mapper

Module Power-ON
RG9
AN
Reset / ID SEL
RD6
RST
UART RTS / ID COMM
RE5
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
Ring Indicator
RB8
PWM
UART CTS
RD0
INT
UART TX
RF4
TX
UART RX
RF5
RX
NC
NC
SCL
NC
NC
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

4G LTE 3 Click (for Europe) Schematic schematic

Step by step

Project assembly

PIC32MZ clicker front image hardware assembly

Start by selecting your development board and Click board™. Begin with the 6LoWPAN clicker as your development board.

PIC32MZ clicker front image hardware assembly
GNSS2 Click front image hardware assembly
Prog-cut hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
Micro B Connector Clicker Access - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
Flip&Click PIC32MZ MCU step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for 4G LTE 3 Click (for Europe) driver.

Key functions:

  • c4glte3e_set_sim_apn - This function sets APN for sim card.

  • c4glte3e_send_sms_text - This function sends text message to a phone number.

  • c4glte3e_cmd_run - This function sends a specified command to the click module.

Open Source

Code example

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.

/*!
 * @file main.c
 * @brief 4G LTE 3 E Click 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 and logger.
 *
 * ## Application Task
 * Application task is split in few stages:
 *  - C4GLTE3E_POWER_UP:
 * Powers up the device, performs a factory reset and reads system information.
 *
 *  - C4GLTE3E_CONFIG_CONNECTION:
 * Sets configuration to device to be able to connect to the network.
 *
 *  - C4GLTE3E_CHECK_CONNECTION:
 * Waits for the network registration indicated via CEREG command and then checks 
 * the signal quality report.
 *
 *  - C4GLTE3E_CONFIG_EXAMPLE:
 * Configures device for the selected example.
 *
 *  - C4GLTE3E_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.
 *
 * ## Additional Function
 * - static void c4glte3e_clear_app_buf ( void )
 * - static void c4glte3e_log_app_buf ( void )
 * - static err_t c4glte3e_process ( c4glte3e_t *ctx )
 * - static err_t c4glte3e_read_response ( c4glte3e_t *ctx, uint8_t *rsp )
 * - static err_t c4glte3e_power_up ( c4glte3e_t *ctx )
 * - static err_t c4glte3e_config_connection ( c4glte3e_t *ctx )
 * - static err_t c4glte3e_check_connection ( c4glte3e_t *ctx )
 * - static err_t c4glte3e_config_example ( c4glte3e_t *ctx )
 * - static err_t c4glte3e_example ( c4glte3e_t *ctx )
 *
 * @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.
 * Example:
    SIM_APN "internet"
    SIM_SMSC "+381610401"
    PHONE_NUMBER "+381659999999"
 *
 * @author Stefan Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "c4glte3e.h"
#include "generic_pointer.h"
#include "conversions.h"

// Example selection macros
#define EXAMPLE_TCP_UDP                     0               // Example of sending messages to a TCP/UDP echo server
#define EXAMPLE_SMS                         1               // Example of sending SMS to a phone number
#define DEMO_EXAMPLE                        EXAMPLE_TCP_UDP // Example selection macro

// SIM APN config
#define SIM_APN                             "internet"      // Set valid SIM APN

// SMS example parameters
#define SIM_SMSC                            ""              // Set valid SMS Service Center Address - only in SMS PDU mode
#define PHONE_NUMBER                        ""              // Set Phone number to message
#define SMS_MODE                            "1"             // SMS mode: "0" - PDU, "1" - TXT

// TCP/UDP example parameters
#define REMOTE_IP                           "77.46.162.162" // TCP/UDP echo server IP address
#define REMOTE_PORT                         "51111"         // TCP/UDP echo server port

// Message content
#define MESSAGE_CONTENT                     "4G LTE 3 E click board - demo example."

// Application buffer size
#define APP_BUFFER_SIZE                     256
#define PROCESS_BUFFER_SIZE                 256

/**
 * @brief Example states.
 * @details Predefined enum values for application example state.
 */
typedef enum
{
    C4GLTE3E_POWER_UP = 1,
    C4GLTE3E_CONFIG_CONNECTION,
    C4GLTE3E_CHECK_CONNECTION,
    C4GLTE3E_CONFIG_EXAMPLE,
    C4GLTE3E_EXAMPLE

} c4glte3e_app_state_t;

/**
 * @brief Application example variables.
 * @details Variables used in application example.
 */
static uint8_t app_buf[ APP_BUFFER_SIZE ] = { 0 };
static int32_t app_buf_len = 0;
static c4glte3e_app_state_t app_state = C4GLTE3E_POWER_UP;

static c4glte3e_t c4glte3e;
static log_t logger;

/**
 * @brief 4G LTE 3 E clearing application buffer.
 * @details This function clears memory of application buffer and reset its length.
 * @note None.
 */
static void c4glte3e_clear_app_buf ( void );

/**
 * @brief 4G LTE 3 E log application buffer.
 * @details This function logs data from application buffer to USB UART.
 * @note None.
 */
static void c4glte3e_log_app_buf ( void );

/**
 * @brief 4G LTE 3 E data reading function.
 * @details This function reads data from device and concatenates data to application buffer. 
 * @param[in] ctx : Click context object.
 * See #c4glte3e_t object definition for detailed explanation.
 * @return @li @c  0 - Read some data.
 *         @li @c -1 - Nothing is read.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t c4glte3e_process ( c4glte3e_t *ctx );

/**
 * @brief 4G LTE 3 E read response function.
 * @details This function waits for a response message, reads and displays it on the USB UART.
 * @param[in] ctx : Click context object.
 * See #c4glte3e_t object definition for detailed explanation.
 * @param[in] rsp  Expected response.
 * @return @li @c  0 - OK response.
 *         @li @c -2 - Timeout error.
 *         @li @c -3 - Command error.
 *         @li @c -4 - Unknown error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t c4glte3e_read_response ( c4glte3e_t *ctx, uint8_t *rsp );

/**
 * @brief 4G LTE 3 E power up function.
 * @details This function powers up the device, performs a factory reset and reads system information.
 * @param[in] ctx : Click context object.
 * See #c4glte3e_t object definition for detailed explanation.
 * @return @li @c    0 - OK.
 *         @li @c != 0 - Read response error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t c4glte3e_power_up ( c4glte3e_t *ctx );

/**
 * @brief 4G LTE 3 E config connection function.
 * @details This function configures and enables connection to the specified network.
 * @param[in] ctx : Click context object.
 * See #c4glte3e_t object definition for detailed explanation.
 * @return @li @c    0 - OK.
 *         @li @c != 0 - Read response error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t c4glte3e_config_connection ( c4glte3e_t *ctx );

/**
 * @brief 4G LTE 3 E check connection function.
 * @details This function checks the connection to network.
 * @param[in] ctx : Click context object.
 * See #c4glte3e_t object definition for detailed explanation.
 * @return @li @c    0 - OK.
 *         @li @c != 0 - Read response error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t c4glte3e_check_connection ( c4glte3e_t *ctx );

/**
 * @brief 4G LTE 3 E config example function.
 * @details This function configures device for the selected example.
 * @param[in] ctx : Click context object.
 * See #c4glte3e_t object definition for detailed explanation.
 * @return @li @c    0 - OK.
 *         @li @c != 0 - Read response error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t c4glte3e_config_example ( c4glte3e_t *ctx );

/**
 * @brief 4G LTE 3 E example function.
 * @details This function executes SMS or TCP/UDP depending on the DEMO_EXAMPLE macro.
 * @param[in] ctx : Click context object.
 * See #c4glte3e_t object definition for detailed explanation.
 * @return @li @c    0 - OK.
 *         @li @c != 0 - Read response error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t c4glte3e_example ( c4glte3e_t *ctx );

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    c4glte3e_cfg_t c4glte3e_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.
    c4glte3e_cfg_setup( &c4glte3e_cfg );
    C4GLTE3E_MAP_MIKROBUS( c4glte3e_cfg, MIKROBUS_1 );
    if ( UART_ERROR == c4glte3e_init( &c4glte3e, &c4glte3e_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );

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

void application_task ( void ) 
{
    switch ( app_state )
    {
        case C4GLTE3E_POWER_UP:
        {
            if ( C4GLTE3E_OK == c4glte3e_power_up( &c4glte3e ) )
            {
                app_state = C4GLTE3E_CONFIG_CONNECTION;
                log_printf( &logger, ">>> APP STATE - CONFIG CONNECTION <<<\r\n\n" );
            }
            break;
        }
        case C4GLTE3E_CONFIG_CONNECTION:
        {
            if ( C4GLTE3E_OK == c4glte3e_config_connection( &c4glte3e ) )
            {
                app_state = C4GLTE3E_CHECK_CONNECTION;
                log_printf( &logger, ">>> APP STATE - CHECK CONNECTION <<<\r\n\n" );
            }
            break;
        }
        case C4GLTE3E_CHECK_CONNECTION:
        {
            if ( C4GLTE3E_OK == c4glte3e_check_connection( &c4glte3e ) )
            {
                app_state = C4GLTE3E_CONFIG_EXAMPLE;
                log_printf( &logger, ">>> APP STATE - CONFIG EXAMPLE <<<\r\n\n" );
            }
            break;
        }
        case C4GLTE3E_CONFIG_EXAMPLE:
        {
            if ( C4GLTE3E_OK == c4glte3e_config_example( &c4glte3e ) )
            {
                app_state = C4GLTE3E_EXAMPLE;
                log_printf( &logger, ">>> APP STATE - EXAMPLE <<<\r\n\n" );
            }
            break;
        }
        case C4GLTE3E_EXAMPLE:
        {
            c4glte3e_example( &c4glte3e );
            break;
        }
        default:
        {
            log_error( &logger, " APP STATE." );
            break;
        }
    }
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

static void c4glte3e_clear_app_buf ( void ) 
{
    memset( app_buf, 0, app_buf_len );
    app_buf_len = 0;
}

static void c4glte3e_log_app_buf ( void )
{
    for ( int32_t buf_cnt = 0; buf_cnt < app_buf_len; buf_cnt++ )
    {
        log_printf( &logger, "%c", app_buf[ buf_cnt ] );
    }
}

static err_t c4glte3e_process ( c4glte3e_t *ctx ) 
{
    uint8_t rx_buf[ PROCESS_BUFFER_SIZE ] = { 0 };
    int32_t overflow_bytes = 0;
    int32_t rx_cnt = 0;
    int32_t rx_size = c4glte3e_generic_read( ctx, rx_buf, PROCESS_BUFFER_SIZE );
    if ( ( rx_size > 0 ) && ( rx_size <= APP_BUFFER_SIZE ) ) 
    {
        if ( ( app_buf_len + rx_size ) > APP_BUFFER_SIZE ) 
        {
            overflow_bytes = ( app_buf_len + rx_size ) - APP_BUFFER_SIZE;
            app_buf_len = APP_BUFFER_SIZE - rx_size;
            memmove ( app_buf, &app_buf[ overflow_bytes ], app_buf_len );
            memset ( &app_buf[ app_buf_len ], 0, overflow_bytes );
        }
        for ( rx_cnt = 0; rx_cnt < rx_size; rx_cnt++ ) 
        {
            if ( rx_buf[ rx_cnt ] ) 
            {
                app_buf[ app_buf_len++ ] = rx_buf[ rx_cnt ];
            }
        }
        return C4GLTE3E_OK;
    }
    return C4GLTE3E_ERROR;
}

static err_t c4glte3e_read_response ( c4glte3e_t *ctx, uint8_t *rsp ) 
{
    #define READ_RESPONSE_TIMEOUT_MS    120000
    uint32_t timeout_cnt = 0;
    c4glte3e_clear_app_buf ( );
    c4glte3e_process( ctx );
    while ( ( 0 == strstr( app_buf, rsp ) ) &&
            ( 0 == strstr( app_buf, C4GLTE3E_RSP_ERROR ) ) )
    {
        c4glte3e_process( ctx );
        if ( timeout_cnt++ > READ_RESPONSE_TIMEOUT_MS )
        {
            c4glte3e_clear_app_buf( );
            log_error( &logger, " Timeout!" );
            return C4GLTE3E_ERROR_TIMEOUT;
        }
        Delay_ms( 1 );
    }
    Delay_ms ( 200 );
    c4glte3e_process( ctx );
    c4glte3e_log_app_buf( );
    if ( strstr( app_buf, rsp ) )
    {
        log_printf( &logger, "--------------------------------\r\n" );
        return C4GLTE3E_OK;
    }
    else if ( strstr( app_buf, C4GLTE3E_RSP_ERROR ) )
    {
        log_error( &logger, " CMD!" );
        return C4GLTE3E_ERROR_CMD;
    }
    log_error( &logger, " Unknown!" );
    return C4GLTE3E_ERROR_UNKNOWN;
}

static err_t c4glte3e_power_up ( c4glte3e_t *ctx )
{
    err_t error_flag = C4GLTE3E_OK;

    uint8_t power_state = C4GLTE3E_POWER_STATE_OFF;
    for ( ; ; )
    {
        c4glte3e_process( ctx );
        c4glte3e_log_app_buf ( );
        c4glte3e_clear_app_buf ( );
        // Wake up UART interface
        c4glte3e_cmd_run( ctx, C4GLTE3E_CMD_AT );

        log_printf( &logger, ">>> Check communication.\r\n" );
        c4glte3e_cmd_run( ctx, C4GLTE3E_CMD_AT );
        if ( ( ( C4GLTE3E_OK == c4glte3e_process( ctx ) ) && strstr( app_buf, C4GLTE3E_RSP_OK ) ) )
        {
            power_state = C4GLTE3E_POWER_STATE_ON;
            break;
        }
        else if ( C4GLTE3E_POWER_STATE_OFF == power_state )
        {
            power_state = C4GLTE3E_POWER_STATE_ON;
            log_printf( &logger, ">>> Power up device.\r\n" );
            c4glte3e_set_power_state ( ctx, C4GLTE3E_POWER_STATE_ON );
        }
        else if ( C4GLTE3E_POWER_STATE_ON == power_state )
        {
            power_state = C4GLTE3E_POWER_STATE_OFF;
            log_printf( &logger, ">>> Power down device.\r\n" );
            c4glte3e_set_power_state ( ctx, C4GLTE3E_POWER_STATE_OFF );
        }
    }
    c4glte3e_cmd_run( ctx, C4GLTE3E_CMD_AT );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    
    log_printf( &logger, ">>> Factory reset.\r\n" );
    c4glte3e_cmd_run( ctx, C4GLTE3E_CMD_FACTORY_RESET );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Get device software version ID.\r\n" );
    c4glte3e_cmd_run( ctx, C4GLTE3E_CMD_GET_SW_VERSION );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Get device serial number.\r\n" );
    c4glte3e_cmd_run( ctx, C4GLTE3E_CMD_GET_SERIAL_NUM );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    return error_flag;
}

static err_t c4glte3e_config_connection ( c4glte3e_t *ctx )
{
    err_t error_flag = C4GLTE3E_OK;
#if ( ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP ) || ( DEMO_EXAMPLE == EXAMPLE_SMS ) )
    log_printf( &logger, ">>> Configure network status LED.\r\n" );
    #define NETWORK_STATUS_LED "14,2"
    c4glte3e_cmd_set( ctx, C4GLTE3E_CMD_GPIO_CONFIG, NETWORK_STATUS_LED );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Configure module status LED.\r\n" );
    #define MODULE_STATUS_LED "15,10"
    c4glte3e_cmd_set( ctx, C4GLTE3E_CMD_GPIO_CONFIG, MODULE_STATUS_LED );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Deregister from network.\r\n" );
    #define DEREGISTER_FROM_NETWORK "2"
    c4glte3e_cmd_set( ctx, C4GLTE3E_CMD_OPERATOR_SELECTION, DEREGISTER_FROM_NETWORK );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Set SIM APN.\r\n" );
    c4glte3e_set_sim_apn( &c4glte3e, SIM_APN );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    
    log_printf( &logger, ">>> Enable full functionality.\r\n" );
    #define FULL_FUNCTIONALITY "1"
    c4glte3e_cmd_set( ctx, C4GLTE3E_CMD_SET_MODULE_FUNCTIONALITY, FULL_FUNCTIONALITY );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Enable network registration.\r\n" );
    #define ENABLE_REG "2"
    c4glte3e_cmd_set( ctx, C4GLTE3E_CMD_EPS_NETWORK_REGISTRATION, ENABLE_REG );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Set automatic registration.\r\n" );
    #define AUTOMATIC_REGISTRATION "0"
    c4glte3e_cmd_set( ctx, C4GLTE3E_CMD_OPERATOR_SELECTION, AUTOMATIC_REGISTRATION );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
#endif
    return error_flag;
}

static err_t c4glte3e_check_connection ( c4glte3e_t *ctx )
{
    err_t error_flag = C4GLTE3E_OK;
#if ( ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP ) || ( DEMO_EXAMPLE == EXAMPLE_SMS ) )
    log_printf( &logger, ">>> Check network registration.\r\n" );
    #define CONNECTED "+CEREG: 2,1"
    c4glte3e_cmd_get ( &c4glte3e, C4GLTE3E_CMD_EPS_NETWORK_REGISTRATION );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    if ( strstr( app_buf, CONNECTED ) )
    {
        Delay_ms ( 1000 );
        log_printf( &logger, ">>> Check signal quality.\r\n" );
        c4glte3e_cmd_run ( &c4glte3e, C4GLTE3E_CMD_SIGNAL_QUALITY_REPORT );
        error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    }
    else
    {
        error_flag = C4GLTE3E_ERROR;
        Delay_ms ( 1000 );
        Delay_ms ( 1000 );
    }
#endif
    return error_flag;
}

static err_t c4glte3e_config_example ( c4glte3e_t *ctx )
{
    err_t error_flag = C4GLTE3E_OK;
#if ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP )
    log_printf( &logger, ">>> Activate PDP context.\r\n" );
    #define ACTIVATE_PDP_CONTEXT "1,1"
    c4glte3e_cmd_set( &c4glte3e, C4GLTE3E_CMD_ACTIVATE_PDP_CONTEXT, ACTIVATE_PDP_CONTEXT );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    log_printf( &logger, ">>> Show PDP address.\r\n" );
    #define PDP_CID "1"
    c4glte3e_cmd_set( &c4glte3e, C4GLTE3E_CMD_SHOW_PDP_ADDRESS, PDP_CID );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
#elif ( DEMO_EXAMPLE == EXAMPLE_SMS )
    log_printf( &logger, ">>> Select SMS format.\r\n" );
    c4glte3e_cmd_set( &c4glte3e, C4GLTE3E_CMD_SELECT_SMS_FORMAT, SMS_MODE );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
#endif
    return error_flag;
}

static err_t c4glte3e_example ( c4glte3e_t *ctx )
{
    err_t error_flag = C4GLTE3E_OK;
#if ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP )
    uint8_t cmd_buf[ 100 ] = { 0 };
    uint8_t * __generic_ptr socket_num_buf = 0;
    uint8_t tcp_socket_num[ 2 ] = { 0 };
    uint8_t udp_socket_num[ 2 ] = { 0 };
    log_printf( &logger, ">>> Create TCP socket.\r\n" );
    #define TCP_PROTOCOL "6"
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_CREATE_SOCKET, TCP_PROTOCOL );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    socket_num_buf = strstr( app_buf, C4GLTE3E_URC_CREATE_SOCKET ) + strlen ( C4GLTE3E_URC_CREATE_SOCKET );
    if ( NULL != socket_num_buf )
    {
        tcp_socket_num[ 0 ] = *socket_num_buf;
    }

    log_printf( &logger, ">>> Create UDP socket.\r\n" );
    #define UDP_PROTOCOL "17"
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_CREATE_SOCKET, UDP_PROTOCOL );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    socket_num_buf = strstr( app_buf, C4GLTE3E_URC_CREATE_SOCKET ) + strlen ( C4GLTE3E_URC_CREATE_SOCKET );
    if ( NULL != socket_num_buf )
    {
        udp_socket_num[ 0 ] = *socket_num_buf;
    }

    log_printf( &logger, ">>> Open TCP connection.\r\n" );
    strcpy( cmd_buf, tcp_socket_num );
    strcat( cmd_buf, ",\"" );
    strcat( cmd_buf, REMOTE_IP );
    strcat( cmd_buf, "\"," );
    strcat( cmd_buf, REMOTE_PORT );
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_CONNECT_SOCKET, cmd_buf );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Open UDP connection.\r\n" );
    strcpy( cmd_buf, udp_socket_num );
    strcat( cmd_buf, ",\"" );
    strcat( cmd_buf, REMOTE_IP );
    strcat( cmd_buf, "\"," );
    strcat( cmd_buf, REMOTE_PORT );
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_CONNECT_SOCKET, cmd_buf );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    // Get message length
    uint8_t message_len_buf[ 10 ] = { 0 };
    uint16_t message_len = strlen( MESSAGE_CONTENT );
    uint16_to_str( message_len, message_len_buf );
    l_trim( message_len_buf );
    r_trim( message_len_buf );

    log_printf( &logger, ">>> Write message to TCP connection.\r\n" );
    strcpy( cmd_buf, tcp_socket_num );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    strcat( cmd_buf, ",\"" );
    strcat( cmd_buf, MESSAGE_CONTENT );
    strcat( cmd_buf, "\"" );
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_WRITE_SOCKET_DATA, cmd_buf );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_URC_RECEIVED_DATA );
    log_printf( &logger, ">>> Read response from TCP connection.\r\n" );
    strcpy( cmd_buf, tcp_socket_num );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    c4glte3e_cmd_set( &c4glte3e, C4GLTE3E_CMD_READ_SOCKET_DATA, cmd_buf );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );

    log_printf( &logger, ">>> Write message to UDP connection.\r\n" );
    strcpy( cmd_buf, udp_socket_num );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    strcat( cmd_buf, ",\"" );
    strcat( cmd_buf, MESSAGE_CONTENT );
    strcat( cmd_buf, "\"" );
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_WRITE_SOCKET_DATA, cmd_buf );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_URC_RECEIVED_DATA );
    log_printf( &logger, ">>> Read response from UDP connection.\r\n" );
    strcpy( cmd_buf, udp_socket_num );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    c4glte3e_cmd_set( &c4glte3e, C4GLTE3E_CMD_READ_SOCKET_DATA, cmd_buf );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    
    log_printf( &logger, ">>> Close TCP connection.\r\n" );
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_CLOSE_SOCKET, tcp_socket_num );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    
    log_printf( &logger, ">>> Close UDP connection.\r\n" );
    c4glte3e_cmd_set ( &c4glte3e, C4GLTE3E_CMD_CLOSE_SOCKET, udp_socket_num );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
#elif ( DEMO_EXAMPLE == EXAMPLE_SMS )
    #define CMGF_PDU "+CMGF: 0"
    #define CMGF_TXT "+CMGF: 1"
    log_printf( &logger, ">>> Check SMS format.\r\n" );
    c4glte3e_cmd_get( &c4glte3e, C4GLTE3E_CMD_SELECT_SMS_FORMAT );
    error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    if ( strstr( app_buf, CMGF_PDU ) )
    {
        log_printf( &logger, ">>> Send SMS in PDU mode.\r\n" );
        c4glte3e_send_sms_pdu( &c4glte3e, SIM_SMSC, PHONE_NUMBER, MESSAGE_CONTENT );
        error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    }
    else if ( strstr( app_buf, CMGF_TXT ) )
    {
        log_printf( &logger, ">>> Send SMS in TXT mode.\r\n" );
        c4glte3e_send_sms_text ( &c4glte3e, PHONE_NUMBER, MESSAGE_CONTENT );
        error_flag |= c4glte3e_read_response( ctx, C4GLTE3E_RSP_OK );
    }
    // 30 seconds delay
    for ( uint8_t delay_cnt = 0; delay_cnt < 30; delay_cnt++ )
    {
        Delay_ms ( 1000 );
    }
#else
    #error "No demo example selected"
#endif
    return error_flag;
}

// ------------------------------------------------------------------------ END

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.