c4glteapj  2.0.0.0
Main Page

4G LTE-APJ click

4G LTE-APJ click is an LTE Cat 1 / UMTS multimodecellular network solution, featuring the compact LARA-R2 series modem from u-blox. This module supports up to three LTE bands and one UMTS band. 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 C4GLTEAPJ 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-APJ Click driver.

Standard key functions :

Example key functions :

  • c4glteapj_module_power_on This function powers ON the module.
  • c4glteapj_send_cmd_with_parameter This function sends a command with specified parameter to the click module.
    void c4glteapj_send_cmd_with_parameter ( c4glteapj_t *ctx, char *at_cmd_buf, char *param_buf );
  • c4glteapj_send_cmd_parameter_check This function checks the command that is sent.
    void c4glteapj_send_cmd_parameter_check ( c4glteapj_t *ctx, char *at_cmd_buf );

Example Description

This example reads and processes data from 4G LTE-APJ 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;
c4glteapj_cfg_t c4glteapj_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
c4glteapj_cfg_setup( &c4glteapj_cfg );
C4GLTEAPJ_MAP_MIKROBUS( c4glteapj_cfg, MIKROBUS_1 );
c4glteapj_init( &c4glteapj, &c4glteapj_cfg );
// dummy read
c4glteapj_process( );
c4glteapj_clear_app_buf( );
// AT
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// ATI - product information
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// CGMR - firmware version
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// CMEE - Report Mobile Equipment Error
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// COPS - deregister from network
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// CGDCONT - set sim apn
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// CFUN - full funtionality
Delay_ms ( 1000 );
Delay_ms ( 1000 );
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// COPS - automatic mode
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// CREG - network registration status
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_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 ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}

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
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 500 );
// CSQ - signal quality
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
} else {
log_info( &logger, "CONNECTED TO NETWORK" );
// SMS message format - PDU mode
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
for( ; ; ) {
log_printf( &logger, "> Sending message to phone number...\r\n" );
app_error_flag = c4glteapj_rsp_check( );
c4glteapj_error_check( app_error_flag );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}
}
}

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

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.


c4glteapj_init
err_t c4glteapj_init(c4glteapj_t *ctx, c4glteapj_cfg_t *cfg)
4G LTE-APJ initialization function.
C4GLTEAPJ_CMD_CGMR
#define C4GLTEAPJ_CMD_CGMR
Definition: c4glteapj.h:75
MESSAGE_CONTENT
#define MESSAGE_CONTENT
Definition: main.c:55
SIM_SMSC
#define SIM_SMSC
Definition: main.c:53
c4glteapj_module_power_on
void c4glteapj_module_power_on(c4glteapj_t *ctx)
Power ON the module function.
C4GLTEAPJ_CMD_ATI
#define C4GLTEAPJ_CMD_ATI
Definition: c4glteapj.h:74
C4GLTEAPJ_CMD_CMEE
#define C4GLTEAPJ_CMD_CMEE
Definition: c4glteapj.h:81
application_task
void application_task(void)
Definition: main.c:231
SIM_APN
#define SIM_APN
Definition: main.c:52
C4GLTEAPJ_CMD_CREG
#define C4GLTEAPJ_CMD_CREG
Definition: c4glteapj.h:77
c4glteapj_send_cmd
void c4glteapj_send_cmd(c4glteapj_t *ctx, char *cmd)
Send command function.
C4GLTEAPJ_CMD_CMGF
#define C4GLTEAPJ_CMD_CMGF
Definition: c4glteapj.h:86
WAIT_FOR_CONNECTION
#define WAIT_FOR_CONNECTION
Definition: main.c:59
c4glteapj_cfg_t
4G LTE-APJ Click configuration object.
Definition: c4glteapj.h:152
c4glteapj_send_sms_pdu
err_t c4glteapj_send_sms_pdu(c4glteapj_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
4G LTE-APJ send SMS in PDU mode.
c4glteapj_t
4G LTE-APJ Click context object.
Definition: c4glteapj.h:128
c4glteapj_set_sim_apn
void c4glteapj_set_sim_apn(c4glteapj_t *ctx, char *sim_apn)
Set sim card APN.
C4GLTEAPJ_MAP_MIKROBUS
#define C4GLTEAPJ_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: c4glteapj.h:111
application_init
void application_init(void)
Definition: main.c:126
c4glteapj_send_cmd_with_parameter
void c4glteapj_send_cmd_with_parameter(c4glteapj_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
C4GLTEAPJ_CMD_CFUN
#define C4GLTEAPJ_CMD_CFUN
Definition: c4glteapj.h:76
c4glteapj_send_cmd_check
void c4glteapj_send_cmd_check(c4glteapj_t *ctx, char *at_cmd_buf)
Check the sent command.
c4glteapj_cfg_setup
void c4glteapj_cfg_setup(c4glteapj_cfg_t *cfg)
4G LTE-APJ configuration object setup function.
C4GLTEAPJ_CMD_CSQ
#define C4GLTEAPJ_CMD_CSQ
Definition: c4glteapj.h:83
C4GLTEAPJ_CMD_AT
#define C4GLTEAPJ_CMD_AT
4G LTE-APJ description setting.
Definition: c4glteapj.h:73
C4GLTEAPJ_CMD_COPS
#define C4GLTEAPJ_CMD_COPS
Definition: c4glteapj.h:84
PHONE_NUMBER_TO_MESSAGE
#define PHONE_NUMBER_TO_MESSAGE
Definition: main.c:54