Advanced
30 min

Achieve global wireless communication with multi-band LTE, UMTS, and GSM support using SIM7600SA and MK64FN1M0VDC12

LTE Cat 1 project with LTE-TDD/LTE-FDD/HSPA+/GSM/GPRS/EDGE communication modes support

LTE Cat.1 6 Click with Clicker 2 for Kinetis

Published Nov 04, 2024

Click board™

LTE Cat.1 6 Click

Dev. board

Clicker 2 for Kinetis

Compiler

NECTO Studio

MCU

MK64FN1M0VDC12

Worldwide wireless connectivity through multi-band LTE, UMTS, and GSM compatibility, ideal for telematics, surveillance, industrial routers, and remote diagnostics

A

A

Hardware Overview

How does it work?

LTE Cat.1 6 Click is based on the SIM7600SA, an LTE Cat 1 module from SIMCom suitable for LTE, UMTS, and GSM networks with global coverage (this version covers regions like Europe, South America, Australia, and New Zealand). The SIM7600SA supports LTE-TDD/ LTE-FDD/HSPA+/GSM/GPRS/EDGE wireless communication modes and has a maximum 10Mbps downlink rate and 5Mbps uplink rate. Besides, it also supports multiple LTE bands (B1/B3/B5/B7/B8/B20/B38/B40/B41), auxiliary (diversity) for bands B1, B5, and B8, as well as 900/1800MHz GSM support. The module integrates an optional multi-constellation GNSS support with multiple built-in network protocols and supports drivers for main operation systems (USB driver for Windows, Linux, and Android) and AT commands. Based on its broad features, this Click board™ is suitable for a wide range of IoT applications such as telematics, surveillance devices, CPE, industrial routers, remote diagnostics, and more. Communication between the SIM7600SA 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 board is also equipped with all the necessary components and circuitry for an audio interface supported by the module family. However, in the current version, with the module placed on the board, the audio interface is not supported. As a result, those components have not been soldered onto the board. In the case of the audio interface, the module’s audio interface operates through the NAU88C10, a mono audio

voice codec configurable via the I2C interface. This setup works with a jack on the back of the board designed for CTIA standard headphones, which are commonly used in modern smartphones and feature a combined audio and microphone connector. This standard ensures compatibility with a wide range of headphones and headsets. This Click board™ also includes a USB Type C connector for both power and data transfer, which is compliant with the USB 2.0 specification (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 LTE Cat.1 6 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. Moreover, these controls have dedicated test points for easier debugging and testing. The board also features three visual indicators to provide real-time status updates. The first red NET LED indicates the current network status of the module. When the LED is always on, the device is either searching for a network or connected to a call in VoLTE versions. A faster blinking pattern (200ms ON/OFF) indicates data transmission or 4G network registration. If the LED blinks slowly with an 800ms ON/OFF pattern, the module is registered on a 2G or 3G network. When the LED is off, the device is either powered OFF or in sleep mode. 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 third green ISINK LED indicator is a user-configurable LED that allows users to customize specific notifications. Additionally, the brightness of this LED can be adjusted by configuring the current supplied to it, ranging from 0 to 40mA, which directly controls the intensity of its illumination. The board features three u.Fl connectors for LTE, Auxiliary-diversity, and optional GNSS antennas that MIKROE offers, like the LTE Flat Rotation Antenna and Active GPS Antenna combined with an IPEX-SMA cable for flexible and efficient connectivity options. In addition, the user can easily choose the power supply of the optional GNSS antenna by choosing between 3.3V and 5V on the GNSS ANT jumper. The board is equipped with a micro SIM card holder that supports both 1.8V and 3.0V uSIM cards, ensuring compatibility with a wide range of cellular networks and allowing users to select the most appropriate service provider for their particular use case, and one optional microSD card slot for up to 32GB SD cards. This Click board™ can operate with both 3.3V and 5V logic voltage levels selected via the VCC SEL jumper. Since the SIM7600SA module operates at 3.8V, logic-level translators, the TXB0106 and PCA9306, are 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.

LTE Cat.1 6 Click hardware overview image

Features overview

Development board

Clicker 2 for Kinetis 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 ARM Cortex-M4F microcontroller, the MK64FN1M0VDC12 from NXP Semiconductors, two mikroBUS™ sockets for Click board™ connectivity, a USB connector, LED indicators, buttons, a JTAG programmer connector, and two 26-pin headers for interfacing with external electronics. Its compact design with clear and easily recognizable silkscreen markings allows you to build gadgets with unique functionalities and

features quickly. Each part of the Clicker 2 for Kinetis development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the Clicker 2 for Kinetis programming method, using a USB HID mikroBootloader or an external mikroProg connector for Kinetis programmer, the Clicker 2 board also includes a clean and regulated power supply module for the development kit. It provides two ways of board-powering; through the USB Micro-B cable, where onboard voltage regulators provide the appropriate voltage levels to each component on the board, or

using a Li-Polymer battery via an onboard battery connector. All communication methods that mikroBUS™ itself supports are on this board, including the well-established mikroBUS™ socket, reset button, and several user-configurable buttons and LED indicators. Clicker 2 for Kinetis 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.

Clicker 2 for Kinetis dimensions image

Microcontroller Overview

MCU Card / MCU

default

Architecture

ARM Cortex-M4

MCU Memory (KB)

1024

Silicon Vendor

NXP

Pin count

121

RAM (Bytes)

262144

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.

LTE Cat.1 6 Click 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.

LTE Cat.1 6 Click accessories 2 image

Used MCU Pins

mikroBUS™ mapper

Module Power-ON
PB2
AN
Reset / ID SEL
PB11
RST
UART RTS / ID COMM
PC4
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
Ring Indicator
PA10
PWM
UART CTS
PB13
INT
UART TX
PD3
TX
UART RX
PD2
RX
I2C Clock
PD8
SCL
I2C Data
PD9
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

LTE Cat.1 6 Click Schematic schematic

Step by step

Project assembly

Clicker 2 for PIC32MZ front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Clicker 2 for Kinetis as your development board.

Clicker 2 for PIC32MZ front image hardware assembly
GNSS2 Click front image hardware assembly
Prog-cut hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
Board mapper by product7 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 LTE Cat.1 6 Click driver.

Key functions:

  • ltecat16_set_sim_apn - This function sets APN for sim card.

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

  • ltecat16_send_cmd - 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 LTE Cat.1 6 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:
 *  - 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.
 *
 * ## Additional Function
 * - static void ltecat16_clear_app_buf ( void )
 * - static void ltecat16_log_app_buf ( void )
 * - static err_t ltecat16_process ( ltecat16_t *ctx )
 * - static err_t ltecat16_read_response ( ltecat16_t *ctx, uint8_t *rsp )
 * - static err_t ltecat16_power_up ( ltecat16_t *ctx )
 * - static err_t ltecat16_config_connection ( ltecat16_t *ctx )
 * - static err_t ltecat16_check_connection ( ltecat16_t *ctx )
 * - static err_t ltecat16_config_example ( ltecat16_t *ctx )
 * - static err_t ltecat16_example ( ltecat16_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_TO_MESSAGE.
 * Example:
    SIM_APN "internet"
    SIM_SMSC "+381610401"
    PHONE_NUMBER_TO_MESSAGE "+381659999999"
 *
 * @author Stefan Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "ltecat16.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_TO_MESSAGE             ""              // 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                     "LTE Cat.1 6 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
{
    LTECAT16_POWER_UP = 1,
    LTECAT16_CONFIG_CONNECTION,
    LTECAT16_CHECK_CONNECTION,
    LTECAT16_CONFIG_EXAMPLE,
    LTECAT16_EXAMPLE

} ltecat16_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 ltecat16_app_state_t app_state = LTECAT16_POWER_UP;

static ltecat16_t ltecat16;
static log_t logger;

/**
 * @brief LTE Cat.1 6 clearing application buffer.
 * @details This function clears memory of application buffer and reset its length.
 * @note None.
 */
static void ltecat16_clear_app_buf ( void );

/**
 * @brief LTE Cat.1 6 log application buffer.
 * @details This function logs data from application buffer to USB UART.
 * @note None.
 */
static void ltecat16_log_app_buf ( void );

/**
 * @brief LTE Cat.1 6 data reading function.
 * @details This function reads data from device and concatenates data to application buffer. 
 * @param[in] ctx : Click context object.
 * See #ltecat16_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 ltecat16_process ( ltecat16_t *ctx );

/**
 * @brief LTE Cat.1 6 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 #ltecat16_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 ltecat16_read_response ( ltecat16_t *ctx, uint8_t *rsp );

/**
 * @brief LTE Cat.1 6 power up function.
 * @details This function powers up the device, performs device factory reset and reads system information.
 * @param[in] ctx : Click context object.
 * See #ltecat16_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 ltecat16_power_up ( ltecat16_t *ctx );

/**
 * @brief LTE Cat.1 6 config connection function.
 * @details This function configures and enables connection to the specified network.
 * @param[in] ctx : Click context object.
 * See #ltecat16_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 ltecat16_config_connection ( ltecat16_t *ctx );

/**
 * @brief LTE Cat.1 6 check connection function.
 * @details This function checks the connection to network.
 * @param[in] ctx : Click context object.
 * See #ltecat16_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 ltecat16_check_connection ( ltecat16_t *ctx );

/**
 * @brief LTE Cat.1 6 config example function.
 * @details This function configures device for the selected example.
 * @param[in] ctx : Click context object.
 * See #ltecat16_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 ltecat16_config_example ( ltecat16_t *ctx );

/**
 * @brief LTE Cat.1 6 example function.
 * @details This function executes SMS or TCP/UDP example depending on the DEMO_EXAMPLE macro.
 * @param[in] ctx : Click context object.
 * See #ltecat16_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 ltecat16_example ( ltecat16_t *ctx );

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" );
}

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;
        }
    }
}

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 ltecat16_clear_app_buf ( void ) 
{
    memset( app_buf, 0, app_buf_len );
    app_buf_len = 0;
}

static void ltecat16_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 ltecat16_process ( ltecat16_t *ctx ) 
{
    uint8_t rx_buf[ PROCESS_BUFFER_SIZE ] = { 0 };
    int32_t overflow_bytes = 0;
    int32_t rx_cnt = 0;
    int32_t rx_size = ltecat16_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 LTECAT16_OK;
    }
    return LTECAT16_ERROR;
}

static err_t ltecat16_read_response ( ltecat16_t *ctx, uint8_t *rsp ) 
{
    #define READ_RESPONSE_TIMEOUT_MS    120000
    uint32_t timeout_cnt = 0;
    ltecat16_clear_app_buf ( );
    ltecat16_process( ctx );
    while ( ( 0 == strstr( app_buf, rsp ) ) &&
            ( 0 == strstr( app_buf, LTECAT16_RSP_ERROR ) ) )
    {
        ltecat16_process( ctx );
        if ( timeout_cnt++ > READ_RESPONSE_TIMEOUT_MS )
        {
            ltecat16_clear_app_buf( );
            log_error( &logger, " Timeout!" );
            return LTECAT16_ERROR_TIMEOUT;
        }
        Delay_ms( 1 );
    }
    Delay_ms ( 200 );
    ltecat16_process( ctx );
    if ( strstr( app_buf, rsp ) )
    {
        ltecat16_log_app_buf( );
        log_printf( &logger, "--------------------------------\r\n" );
        return LTECAT16_OK;
    }
    else if ( strstr( app_buf, LTECAT16_RSP_ERROR ) )
    {
        log_error( &logger, " CMD!" );
        return LTECAT16_ERROR_CMD;
    }
    log_error( &logger, " Unknown!" );
    return LTECAT16_ERROR_UNKNOWN;
}

static err_t ltecat16_power_up ( ltecat16_t *ctx )
{
    err_t error_flag = LTECAT16_OK;
    
    uint8_t power_state = LTECAT16_POWER_STATE_OFF;
    for ( ; ; )
    {
        ltecat16_process( ctx );
        ltecat16_clear_app_buf ( );
        // Wake up UART interface
        ltecat16_send_cmd( ctx, LTECAT16_CMD_AT );

        log_printf( &logger, ">>> Check communication.\r\n" );
        ltecat16_send_cmd( ctx, LTECAT16_CMD_AT );
        if ( ( ( LTECAT16_OK == ltecat16_process( ctx ) ) && strstr( app_buf, LTECAT16_RSP_OK ) ) )
        {
            power_state = LTECAT16_POWER_STATE_ON;
            break;
        }
        else if ( LTECAT16_POWER_STATE_OFF == power_state )
        {
            power_state = LTECAT16_POWER_STATE_ON;
            log_printf( &logger, ">>> Power up device.\r\n" );
            ltecat16_set_power_state ( ctx, LTECAT16_POWER_STATE_ON );
        }
        else if ( LTECAT16_POWER_STATE_ON == power_state )
        {
            power_state = LTECAT16_POWER_STATE_OFF;
            log_printf( &logger, ">>> Power down device.\r\n" );
            ltecat16_set_power_state ( ctx, LTECAT16_POWER_STATE_OFF );
        }
    }
    ltecat16_send_cmd( ctx, LTECAT16_CMD_AT );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    
    log_printf( &logger, ">>> Factory reset.\r\n" );
    ltecat16_send_cmd( ctx, LTECAT16_CMD_FACTORY_RESET );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Get device model ID.\r\n" );
    ltecat16_send_cmd( ctx, LTECAT16_CMD_GET_MODEL_ID );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Get device software version ID.\r\n" );
    ltecat16_send_cmd( ctx, LTECAT16_CMD_GET_SW_VERSION );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Get device serial number.\r\n" );
    ltecat16_send_cmd( ctx, LTECAT16_CMD_GET_SERIAL_NUM );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    return error_flag;
}

static err_t ltecat16_config_connection ( ltecat16_t *ctx )
{
    err_t error_flag = LTECAT16_OK;
#if ( ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP ) || ( DEMO_EXAMPLE == EXAMPLE_SMS ) )
    log_printf( &logger, ">>> Deregister from network.\r\n" );
    #define DEREGISTER_FROM_NETWORK "2"
    ltecat16_send_cmd_par( ctx, LTECAT16_CMD_OPERATOR_SELECTION, DEREGISTER_FROM_NETWORK );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Set SIM APN.\r\n" );
    ltecat16_set_sim_apn( &ltecat16, SIM_APN );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    
    log_printf( &logger, ">>> Enable full functionality.\r\n" );
    #define FULL_FUNCTIONALITY "1"
    ltecat16_send_cmd_par( ctx, LTECAT16_CMD_SET_PHONE_FUNCTIONALITY, FULL_FUNCTIONALITY );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Enable network registration.\r\n" );
    #define ENABLE_REG "2"
    ltecat16_send_cmd_par( ctx, LTECAT16_CMD_NETWORK_REGISTRATION, ENABLE_REG );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Set automatic registration.\r\n" );
    #define AUTOMATIC_REGISTRATION "0"
    ltecat16_send_cmd_par( ctx, LTECAT16_CMD_OPERATOR_SELECTION, AUTOMATIC_REGISTRATION );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
#endif
    return error_flag;
}

static err_t ltecat16_check_connection ( ltecat16_t *ctx )
{
    err_t error_flag = LTECAT16_OK;
#if ( ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP ) || ( DEMO_EXAMPLE == EXAMPLE_SMS ) )
    log_printf( &logger, ">>> Check network registration.\r\n" );
    #define CONNECTED "+CREG: 2,1"
    ltecat16_send_cmd_check ( &ltecat16, LTECAT16_CMD_NETWORK_REGISTRATION );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    if ( strstr( app_buf, CONNECTED ) )
    {
        Delay_ms ( 1000 );
        log_printf( &logger, ">>> Check signal quality.\r\n" );
        ltecat16_send_cmd( &ltecat16, LTECAT16_CMD_SIGNAL_QUALITY_REPORT );
        error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    }
    else
    {
        error_flag = LTECAT16_ERROR;
        Delay_ms ( 1000 );
        Delay_ms ( 1000 );
    }
#endif
    return error_flag;
}

static err_t ltecat16_config_example ( ltecat16_t *ctx )
{
    err_t error_flag = LTECAT16_OK;
#if ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP )
    log_printf( &logger, ">>> Activate PDP context.\r\n" );
    #define ACTIVATE_PDP_CONTEXT "1,1"
    ltecat16_send_cmd_par( &ltecat16, LTECAT16_CMD_ACTIVATE_PDP_CONTEXT, ACTIVATE_PDP_CONTEXT );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Show PDP address.\r\n" );
    #define PDP_CID "1"
    ltecat16_send_cmd_par( &ltecat16, LTECAT16_CMD_SHOW_PDP_ADDRESS, PDP_CID );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    
    log_printf( &logger, ">>> Start TCPIP service.\r\n" );
    ltecat16_send_cmd ( &ltecat16, LTECAT16_CMD_START_TCPIP_SERVICE );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Set RX mode to manually.\r\n" );
    #define RX_MODE_MANUALLY "1"
    ltecat16_send_cmd_par( &ltecat16, LTECAT16_CMD_RECEIVE_DATA_VIA_CONNECTION, RX_MODE_MANUALLY );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
#elif ( DEMO_EXAMPLE == EXAMPLE_SMS )
    log_printf( &logger, ">>> Select SMS format.\r\n" );
    ltecat16_send_cmd_par( &ltecat16, LTECAT16_CMD_SELECT_SMS_FORMAT, SMS_MODE );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
#endif
    return error_flag;
}

static err_t ltecat16_example ( ltecat16_t *ctx )
{
    err_t error_flag = LTECAT16_OK;
#if ( DEMO_EXAMPLE == EXAMPLE_TCP_UDP )
    uint8_t cmd_buf[ 100 ] = { 0 };
    
    log_printf( &logger, ">>> Open TCP connection.\r\n" );
    #define TCP_LINK_NUM "0"
    #define TCP_CONN_TYPE "TCP"
    strcpy( cmd_buf, TCP_LINK_NUM );
    strcat( cmd_buf, ",\"" );
    strcat( cmd_buf, TCP_CONN_TYPE );
    strcat( cmd_buf, "\",\"" );
    strcat( cmd_buf, REMOTE_IP );
    strcat( cmd_buf, "\"," );
    strcat( cmd_buf, REMOTE_PORT );
    ltecat16_send_cmd_par ( &ltecat16, LTECAT16_CMD_OPEN_TCP_UDP_CONNECTION, cmd_buf );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Open UDP connection.\r\n" );
    #define UDP_LINK_NUM "1"
    #define UDP_CONN_TYPE "UDP"
    #define UDP_LOCAL_PORT "5000"
    strcpy( cmd_buf, UDP_LINK_NUM );
    strcat( cmd_buf, ",\"" );
    strcat( cmd_buf, UDP_CONN_TYPE );
    strcat( cmd_buf, "\",,," );
    strcat( cmd_buf, UDP_LOCAL_PORT );
    ltecat16_send_cmd_par ( &ltecat16, LTECAT16_CMD_OPEN_TCP_UDP_CONNECTION, cmd_buf );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_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_LINK_NUM );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    ltecat16_send_cmd_par ( &ltecat16, LTECAT16_CMD_SEND_DATA_VIA_CONNECTION, cmd_buf );
    Delay_ms ( 100 );
    ltecat16_generic_write ( &ltecat16, MESSAGE_CONTENT, message_len );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_URC_RECEIVED_DATA );
    log_printf( &logger, ">>> Read response from TCP connection.\r\n" );
    #define RX_DATA_READ "2"
    strcpy( cmd_buf, RX_DATA_READ );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, TCP_LINK_NUM );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    ltecat16_send_cmd_par( &ltecat16, LTECAT16_CMD_RECEIVE_DATA_VIA_CONNECTION, cmd_buf );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );

    log_printf( &logger, ">>> Write message to UDP connection.\r\n" );
    strcpy( cmd_buf, UDP_LINK_NUM );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    strcat( cmd_buf, ",\"" );
    strcat( cmd_buf, REMOTE_IP );
    strcat( cmd_buf, "\"," );
    strcat( cmd_buf, REMOTE_PORT );
    ltecat16_send_cmd_par ( &ltecat16, LTECAT16_CMD_SEND_DATA_VIA_CONNECTION, cmd_buf );
    Delay_ms ( 100 );
    ltecat16_generic_write ( &ltecat16, MESSAGE_CONTENT, message_len );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_URC_RECEIVED_DATA );
    log_printf( &logger, ">>> Read response from UDP connection.\r\n" );
    strcpy( cmd_buf, RX_DATA_READ );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, UDP_LINK_NUM );
    strcat( cmd_buf, "," );
    strcat( cmd_buf, message_len_buf );
    ltecat16_send_cmd_par( &ltecat16, LTECAT16_CMD_RECEIVE_DATA_VIA_CONNECTION, cmd_buf );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    
    log_printf( &logger, ">>> Close TCP connection.\r\n" );
    ltecat16_send_cmd_par ( &ltecat16, LTECAT16_CMD_CLOSE_TCP_UDP_CONNECTION, TCP_LINK_NUM );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    
    log_printf( &logger, ">>> Close UDP connection.\r\n" );
    ltecat16_send_cmd_par ( &ltecat16, LTECAT16_CMD_CLOSE_TCP_UDP_CONNECTION, UDP_LINK_NUM );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
#elif ( DEMO_EXAMPLE == EXAMPLE_SMS )
    // Check SMS mode
    #define CMGF_PDU "+CMGF: 0"
    #define CMGF_TXT "+CMGF: 1"
    log_printf( &logger, ">>> Check SMS format.\r\n" );
    ltecat16_send_cmd_check( &ltecat16, LTECAT16_CMD_SELECT_SMS_FORMAT );
    error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    if ( strstr( app_buf, CMGF_PDU ) )
    {
        // Send SMS in PDU mode
        log_printf( &logger, ">>> Send SMS in PDU mode.\r\n" );
        ltecat16_send_sms_pdu( &ltecat16, SIM_SMSC, PHONE_NUMBER_TO_MESSAGE, MESSAGE_CONTENT );
        error_flag |= ltecat16_read_response( ctx, LTECAT16_RSP_OK );
    }
    else if ( strstr( app_buf, CMGF_TXT ) )
    {
        // Send SMS in TXT mode
        log_printf( &logger, ">>> Send SMS in TXT mode.\r\n" );
        ltecat16_send_sms_text ( &ltecat16, PHONE_NUMBER_TO_MESSAGE, MESSAGE_CONTENT );
        error_flag |= ltecat16_read_response( ctx, LTECAT16_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.