c3gea  2.0.0.0
Main Page

3G-EA Click

3G-EA Click is a versatile cellular network communication solution, featuring the compact 3G UMTS/HSPA Quectel UG95 module. This module features a full set of options for the cellular networking and communication, such as the network indication, embedded TCP/UDP stack, HTTP/HTTPS stack, full GSM/GPRS/EDGE implementation, UMTS/HSDPA/HSUPA protocol implementation and more. 3G-EA Click features data-rates of 7.2 Mb/s (downlink) and 5.76 Mb/s (uplink) in HSPA mode. Onboard 16bit audio CODEC IC adds high-quality voice communication capability.

Click Product page


Click library

  • Author : Stefan Filipovic
  • Date : May 2023.
  • Type : UART type

Software Support

We provide a library for the C3GEA 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 C3GEA Click driver.

Standard key functions :

Example key functions :

  • c3gea_set_sim_apn This function sets APN for sim card.
    void c3gea_set_sim_apn ( c3gea_t *ctx, uint8_t *sim_apn );
  • c3gea_send_sms_text This function sends text message to a phone number.
    void c3gea_send_sms_text ( c3gea_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
  • c3gea_send_sms_pdu This function sends text message to a phone number in PDU mode.
    err_t c3gea_send_sms_pdu ( c3gea_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *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, tests the communication by sending "AT" command, and after that restarts the device.

void application_init ( void )
{
log_cfg_t log_cfg;
c3gea_cfg_t c3gea_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
c3gea_cfg_setup( &c3gea_cfg );
C3GEA_MAP_MIKROBUS( c3gea_cfg, MIKROBUS_1 );
if ( UART_ERROR == c3gea_init( &c3gea, &c3gea_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
c3gea_process( );
c3gea_clear_app_buf( );
// Check communication
error_flag = c3gea_rsp_check( C3GEA_RSP_OK );
c3gea_error_check( error_flag );
// Restart device
#define RESTART_DEVICE "1,1"
error_flag = c3gea_rsp_check( C3GEA_RSP_OK );
c3gea_error_check( error_flag );
log_info( &logger, " Application Task " );
example_state = C3GEA_CONFIGURE_FOR_NETWORK;
}

Application Task

Application task is split in few stages:

  • C3GEA_CONFIGURE_FOR_NETWORK:

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

  • C3GEA_WAIT_FOR_CONNECTION:

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

  • C3GEA_CONFIGURE_FOR_EXAMPLE:

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

  • C3GEA_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 ( C3GEA_OK == c3gea_configure_for_network( ) )
{
example_state = C3GEA_WAIT_FOR_CONNECTION;
}
break;
}
{
if ( C3GEA_OK == c3gea_check_connection( ) )
{
example_state = C3GEA_CONFIGURE_FOR_EXAMPLE;
}
break;
}
{
if ( C3GEA_OK == c3gea_configure_for_example( ) )
{
example_state = C3GEA_EXAMPLE;
}
break;
}
{
c3gea_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.3GEA

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.


c3gea_send_sms_text
void c3gea_send_sms_text(c3gea_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
3G-EA send SMS in text mode.
c3gea_cfg_t
3G-EA Click configuration object.
Definition: c3gea.h:160
RESTART_DEVICE
#define RESTART_DEVICE
c3gea_send_cmd
void c3gea_send_cmd(c3gea_t *ctx, uint8_t *cmd)
Send command function.
C3GEA_RSP_OK
#define C3GEA_RSP_OK
3G-EA device response for AT commands.
Definition: c3gea.h:92
C3GEA_CMD_CFUN
#define C3GEA_CMD_CFUN
Definition: c3gea.h:75
c3gea_set_sim_apn
void c3gea_set_sim_apn(c3gea_t *ctx, uint8_t *sim_apn)
Set sim card APN.
c3gea_send_cmd_with_par
void c3gea_send_cmd_with_par(c3gea_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
application_task
void application_task(void)
Definition: main.c:244
c3gea_init
err_t c3gea_init(c3gea_t *ctx, c3gea_cfg_t *cfg)
3G-EA initialization function.
C3GEA_CONFIGURE_FOR_NETWORK
@ C3GEA_CONFIGURE_FOR_NETWORK
Definition: main.c:90
C3GEA_OK
@ C3GEA_OK
Definition: c3gea.h:187
C3GEA_CMD_AT
#define C3GEA_CMD_AT
3G-EA control commands.
Definition: c3gea.h:73
c3gea_send_sms_pdu
err_t c3gea_send_sms_pdu(c3gea_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
3G-EA send SMS in PDU mode.
C3GEA_EXAMPLE
@ C3GEA_EXAMPLE
Definition: main.c:93
C3GEA_CONFIGURE_FOR_EXAMPLE
@ C3GEA_CONFIGURE_FOR_EXAMPLE
Definition: main.c:92
c3gea_t
3G-EA Click context object.
Definition: c3gea.h:136
application_init
void application_init(void)
Definition: main.c:198
C3GEA_MAP_MIKROBUS
#define C3GEA_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: c3gea.h:119
c3gea_cfg_setup
void c3gea_cfg_setup(c3gea_cfg_t *cfg)
3G-EA configuration object setup function.
C3GEA_WAIT_FOR_CONNECTION
@ C3GEA_WAIT_FOR_CONNECTION
Definition: main.c:91