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 Ilic
  • Date : Jul 2021.
  • 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_module_power This function powers ON/OFF the module.
    void c3gea_module_power ( c3gea_t *ctx, uint8_t state );
  • c3gea_send_cmd_with_parameter This function sends a command with specified parameter to the click module.
    void c3gea_send_cmd_with_parameter ( c3gea_t *ctx, char *at_cmd_buf, char *param_buf );
  • c3gea_send_sms_text This function sends text message to a phone number.
    void c3gea_send_sms_text ( c3gea_t *ctx, char *phone_number, char *sms_text );

Example Description

This example reads and processes data from 3G EA 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;
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 );
c3gea_init( &c3gea, &c3gea_cfg );
// dummy read
c3gea_process( );
c3gea_clear_app_buf( );
// AT
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// ATI - product information
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// CGMR - firmware version
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// CMEE - Report Mobile Equipment Error
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// COPS - deregister from network
Delay_ms( 4000 );
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// CGDCONT - set sim apn
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// CFUN - full funtionality
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// COPS - automatic mode
Delay_ms( 4000 );
app_error_flag = c3gea_rsp_check( );
c3gea_error_check( app_error_flag );
Delay_ms( 500 );
// CREG - network registration status
app_error_flag = c3gea_rsp_check( );
c3gea_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( 5000 );
}

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

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.C3GEA

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_cfg_t
3G-EA Click configuration object.
Definition: c3gea.h:144
c3gea_module_power
void c3gea_module_power(c3gea_t *ctx, uint8_t state)
Power ON/OFF the module.
MESSAGE_CONTENT
#define MESSAGE_CONTENT
Definition: main.c:55
c3gea_send_cmd
void c3gea_send_cmd(c3gea_t *ctx, char *cmd)
Send command function.
c3gea_send_cmd_check
void c3gea_send_cmd_check(c3gea_t *ctx, char *at_cmd_buf)
Check the sent command.
SIM_SMSC
#define SIM_SMSC
Definition: main.c:53
C3GEA_MODULE_POWER_ON
#define C3GEA_MODULE_POWER_ON
3G-EA module power.
Definition: c3gea.h:58
C3GEA_CMD_CFUN
#define C3GEA_CMD_CFUN
Definition: c3gea.h:68
C3GEA_CMD_CSQ
#define C3GEA_CMD_CSQ
Definition: c3gea.h:75
C3GEA_CMD_CMGF
#define C3GEA_CMD_CMGF
Definition: c3gea.h:78
application_task
void application_task(void)
Definition: main.c:221
SIM_APN
#define SIM_APN
Definition: main.c:52
C3GEA_CMD_CGMR
#define C3GEA_CMD_CGMR
Definition: c3gea.h:67
c3gea_send_sms_text
void c3gea_send_sms_text(c3gea_t *ctx, char *phone_number, char *sms_text)
3G-EA send SMS in text mode.
C3GEA_CMD_CMEE
#define C3GEA_CMD_CMEE
Definition: c3gea.h:73
c3gea_init
err_t c3gea_init(c3gea_t *ctx, c3gea_cfg_t *cfg)
3G-EA initialization function.
WAIT_FOR_CONNECTION
#define WAIT_FOR_CONNECTION
Definition: main.c:59
C3GEA_CMD_AT
#define C3GEA_CMD_AT
3G-EA description setting.
Definition: c3gea.h:65
C3GEA_CMD_ATI
#define C3GEA_CMD_ATI
Definition: c3gea.h:66
C3GEA_CMD_CREG
#define C3GEA_CMD_CREG
Definition: c3gea.h:69
c3gea_t
3G-EA Click context object.
Definition: c3gea.h:120
c3gea_set_sim_apn
void c3gea_set_sim_apn(c3gea_t *ctx, char *sim_apn)
Set sim card APN.
c3gea_send_sms_pdu
err_t c3gea_send_sms_pdu(c3gea_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
3G-EA send SMS in PDU mode.
application_init
void application_init(void)
Definition: main.c:129
C3GEA_MAP_MIKROBUS
#define C3GEA_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: c3gea.h:104
c3gea_cfg_setup
void c3gea_cfg_setup(c3gea_cfg_t *cfg)
3G-EA configuration object setup function.
PHONE_NUMBER_TO_MESSAGE
#define PHONE_NUMBER_TO_MESSAGE
Definition: main.c:54
c3gea_send_cmd_with_parameter
void c3gea_send_cmd_with_parameter(c3gea_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
C3GEA_CMD_COPS
#define C3GEA_CMD_COPS
Definition: c3gea.h:76