c4glte2voice  2.1.0.0
Main Page

4G LTE 2 Voice 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-R6001, the world’s smallest LTE Cat 1 module with global coverage and a built-in MQTT client from u-blox, representing a data and voice solution. Equipped with familiar AT commands set over the UART interface, USB interface, and Network and Status indicators, the LARA-R6001 also has a comprehensive certification scheme and multi-band/multi-mode capabilities providing excellent flexibility alongside 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 Voice 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 Voice Click driver.

Standard key functions :

Example key functions :

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;
c4glte2voice_cfg_t c4glte2voice_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
c4glte2voice_cfg_setup( &c4glte2voice_cfg );
C4GLTE2VOICE_MAP_MIKROBUS( c4glte2voice_cfg, MIKROBUS_1 );
if ( UART_ERROR == c4glte2voice_init( &c4glte2voice, &c4glte2voice_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
c4glte2voice_process( );
c4glte2voice_clear_app_buf( );
app_buf_len = 0;
app_buf_cnt = 0;
// Check communication
error_flag = c4glte2voice_rsp_check( );
c4glte2voice_error_check( error_flag );
log_info( &logger, " Application Task " );
}

Application Task

Application task is split in few stages:

  • C4GLTE2VOICE_CONFIGURE_FOR_NETWORK:

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

  • C4GLTE2VOICE_WAIT_FOR_CONNECTION:

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

  • C4GLTE2VOICE_CONFIGURE_FOR_EXAMPLE:

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

  • C4GLTE2VOICE_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 )
{
{
if ( C4GLTE2VOICE_OK == c4glte2voice_configure_for_network( ) )
{
}
break;
}
{
if ( C4GLTE2VOICE_OK == c4glte2voice_check_connection( ) )
{
}
break;
}
{
if ( C4GLTE2VOICE_OK == c4glte2voice_configure_for_example( ) )
{
example_state = C4GLTE2VOICE_EXAMPLE;
}
break;
}
{
c4glte2voice_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.4GLTE2Voice

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.


c4glte2voice_send_sms_text
void c4glte2voice_send_sms_text(c4glte2voice_t *ctx, char *phone_number, char *sms_text)
4G LTE 2 Voice send SMS in text mode.
c4glte2voice_cfg_t
4G LTE 2 Voice Click configuration object.
Definition: c4glte2voice.h:176
C4GLTE2VOICE_EXAMPLE
@ C4GLTE2VOICE_EXAMPLE
Definition: main.c:92
c4glte2voice_set_sim_apn
void c4glte2voice_set_sim_apn(c4glte2voice_t *ctx, char *sim_apn)
Set sim card APN.
c4glte2voice_send_cmd
void c4glte2voice_send_cmd(c4glte2voice_t *ctx, char *cmd)
Send command function.
application_task
void application_task(void)
Definition: main.c:239
c4glte2voice_set_power_state
void c4glte2voice_set_power_state(c4glte2voice_t *ctx, uint8_t state)
4G LTE 2 Voice set power state function.
C4GLTE2VOICE_WAIT_FOR_CONNECTION
@ C4GLTE2VOICE_WAIT_FOR_CONNECTION
Definition: main.c:90
C4GLTE2VOICE_POWER_STATE_OFF
#define C4GLTE2VOICE_POWER_STATE_OFF
4G LTE 2 Voice power state settings.
Definition: c4glte2voice.h:109
C4GLTE2VOICE_CONFIGURE_FOR_NETWORK
@ C4GLTE2VOICE_CONFIGURE_FOR_NETWORK
Definition: main.c:89
C4GLTE2VOICE_POWER_STATE_ON
#define C4GLTE2VOICE_POWER_STATE_ON
Definition: c4glte2voice.h:110
c4glte2voice_t
4G LTE 2 Voice Click context object.
Definition: c4glte2voice.h:152
C4GLTE2VOICE_MAP_MIKROBUS
#define C4GLTE2VOICE_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: c4glte2voice.h:135
application_init
void application_init(void)
Definition: main.c:196
C4GLTE2VOICE_CONFIGURE_FOR_EXAMPLE
@ C4GLTE2VOICE_CONFIGURE_FOR_EXAMPLE
Definition: main.c:91
C4GLTE2VOICE_CMD_AT
#define C4GLTE2VOICE_CMD_AT
4G LTE 2 Voice control commands.
Definition: c4glte2voice.h:73
C4GLTE2VOICE_OK
@ C4GLTE2VOICE_OK
Definition: c4glte2voice.h:203
c4glte2voice_cfg_setup
void c4glte2voice_cfg_setup(c4glte2voice_cfg_t *cfg)
4G LTE 2 Voice configuration object setup function.
c4glte2voice_init
err_t c4glte2voice_init(c4glte2voice_t *ctx, c4glte2voice_cfg_t *cfg)
4G LTE 2 Voice initialization function.