c3gaa  2.0.0.0
Main Page

3G-AA click

3G-AA 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 C3GAA 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 C3GAA Click driver.

Standard key functions :

Example key functions :

  • c3gaa_module_power This function powers ON/OFF the module.
    void c3gaa_module_power ( c3gaa_t *ctx, uint8_t state );
  • c3gaa_send_cmd_with_parameter This function sends a command with specified parameter to the click module.
    void c3gaa_send_cmd_with_parameter ( c3gaa_t *ctx, char *at_cmd_buf, char *param_buf );
  • c3gaa_send_sms_text This function sends text message to a phone number.
    void c3gaa_send_sms_text ( c3gaa_t *ctx, char *phone_number, char *sms_text );

Example Description

This example reads and processes data from 3G AA 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;
c3gaa_cfg_t c3gaa_cfg;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.level = LOG_LEVEL_DEBUG;
log_cfg.baud = 115200;
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
c3gaa_cfg_setup( &c3gaa_cfg );
C3GAA_MAP_MIKROBUS( c3gaa_cfg, MIKROBUS_1 );
c3gaa_init( &c3gaa, &c3gaa_cfg );
// dummy read
c3gaa_process( );
c3gaa_clear_app_buf( );
// AT
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// ATI - product information
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// CGMR - firmware version
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// CMEE - Report Mobile Equipment Error
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// COPS - deregister from network
Delay_ms( 4000 );
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// CGDCONT - set sim apn
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// CFUN - full funtionality
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// COPS - automatic mode
Delay_ms( 4000 );
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// CREG - network registration status
app_error_flag = c3gaa_rsp_check( );
c3gaa_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 = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 500 );
// CSQ - signal quality
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 3000 );
} else {
log_info( &logger, "CONNECTED TO NETWORK" );
// SMS message format - PDU mode
app_error_flag = c3gaa_rsp_check( );
c3gaa_error_check( app_error_flag );
Delay_ms( 3000 );
for( ; ; ) {
log_printf( &logger, "> Sending message to phone number...\r\n" );
app_error_flag = c3gaa_rsp_check( );
c3gaa_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.C3GAA

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.


c3gaa_send_sms_pdu
err_t c3gaa_send_sms_pdu(c3gaa_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
3G-AA send SMS in PDU mode.
MESSAGE_CONTENT
#define MESSAGE_CONTENT
Definition: main.c:55
C3GAA_CMD_CMEE
#define C3GAA_CMD_CMEE
Definition: c3gaa.h:74
C3GAA_MODULE_POWER_ON
#define C3GAA_MODULE_POWER_ON
3G-AA module power.
Definition: c3gaa.h:59
SIM_SMSC
#define SIM_SMSC
Definition: main.c:53
c3gaa_cfg_t
3G-AA Click configuration object.
Definition: c3gaa.h:146
c3gaa_send_cmd_with_parameter
void c3gaa_send_cmd_with_parameter(c3gaa_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
application_task
void application_task(void)
Definition: main.c:216
SIM_APN
#define SIM_APN
Definition: main.c:52
C3GAA_MAP_MIKROBUS
#define C3GAA_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: c3gaa.h:105
C3GAA_CMD_AT
#define C3GAA_CMD_AT
3G-AA description setting.
Definition: c3gaa.h:66
C3GAA_CMD_CSQ
#define C3GAA_CMD_CSQ
Definition: c3gaa.h:76
c3gaa_module_power
void c3gaa_module_power(c3gaa_t *ctx, uint8_t state)
Power ON/OFF the module.
WAIT_FOR_CONNECTION
#define WAIT_FOR_CONNECTION
Definition: main.c:59
c3gaa_send_cmd_check
void c3gaa_send_cmd_check(c3gaa_t *ctx, char *at_cmd_buf)
Check the sent command.
c3gaa_cfg_setup
void c3gaa_cfg_setup(c3gaa_cfg_t *cfg)
3G-AA configuration object setup function.
C3GAA_CMD_COPS
#define C3GAA_CMD_COPS
Definition: c3gaa.h:77
c3gaa_set_sim_apn
void c3gaa_set_sim_apn(c3gaa_t *ctx, char *sim_apn)
Set sim card APN.
C3GAA_CMD_ATI
#define C3GAA_CMD_ATI
Definition: c3gaa.h:67
C3GAA_CMD_CREG
#define C3GAA_CMD_CREG
Definition: c3gaa.h:70
c3gaa_t
3G-AA Click context object.
Definition: c3gaa.h:122
application_init
void application_init(void)
Definition: main.c:129
c3gaa_send_sms_text
void c3gaa_send_sms_text(c3gaa_t *ctx, char *phone_number, char *sms_text)
3G-AA send SMS in text mode.
C3GAA_CMD_CGMR
#define C3GAA_CMD_CGMR
Definition: c3gaa.h:68
c3gaa_init
err_t c3gaa_init(c3gaa_t *ctx, c3gaa_cfg_t *cfg)
3G-AA initialization function.
c3gaa_send_cmd
void c3gaa_send_cmd(c3gaa_t *ctx, char *cmd)
Send command function.
PHONE_NUMBER_TO_MESSAGE
#define PHONE_NUMBER_TO_MESSAGE
Definition: main.c:54
C3GAA_CMD_CFUN
#define C3GAA_CMD_CFUN
Definition: c3gaa.h:69
C3GAA_CMD_CMGF
#define C3GAA_CMD_CMGF
Definition: c3gaa.h:79