c3gsara  2.0.0.0
Main Page

3G SARA click

3G SARA click is a versatile cellular network communication solution, featuring the compact 3.75G UMTS/HSPA SARA U-201 modem from u-blox.

click Product page


Click library

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

Software Support

We provide a library for the 3gSara 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for 3gSara Click driver.

Standard key functions :

Example key functions :

  • c3gsara_set_sim_apn This function sets APN for sim card.
    void c3gsara_set_sim_apn ( c3gsara_t *ctx, uint8_t *sim_apn );
  • c3gsara_send_sms_text This function sends text message to a phone number.
    void c3gsara_send_sms_text ( c3gsara_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
  • c3gsara_send_sms_pdu This function sends text message to a phone number in PDU mode.
    err_t c3gsara_send_sms_pdu ( c3gsara_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;
c3gsara_cfg_t c3gsara_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
c3gsara_cfg_setup( &c3gsara_cfg );
C3GSARA_MAP_MIKROBUS( c3gsara_cfg, MIKROBUS_1 );
if ( UART_ERROR == c3gsara_init( &c3gsara, &c3gsara_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
c3gsara_process( );
c3gsara_clear_app_buf( );
// Check communication
error_flag = c3gsara_rsp_check( C3GSARA_RSP_OK );
c3gsara_error_check( error_flag );
// Restart device
#define RESTART_DEVICE "1,1"
error_flag = c3gsara_rsp_check( C3GSARA_RSP_OK );
c3gsara_error_check( error_flag );
log_info( &logger, " Application Task " );
}

Application Task

Application task is split in few stages:

  • C3GSARA_CONFIGURE_FOR_NETWORK:

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

  • C3GSARA_WAIT_FOR_CONNECTION:

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

  • C3GSARA_CONFIGURE_FOR_EXAMPLE:

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

  • C3GSARA_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 ( C3GSARA_OK == c3gsara_configure_for_network( ) )
{
example_state = C3GSARA_WAIT_FOR_CONNECTION;
}
break;
}
{
if ( C3GSARA_OK == c3gsara_check_connection( ) )
{
}
break;
}
{
if ( C3GSARA_OK == c3gsara_configure_for_example( ) )
{
example_state = C3GSARA_EXAMPLE;
}
break;
}
{
c3gsara_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 form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.3gSara

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


RESTART_DEVICE
#define RESTART_DEVICE
c3gsara_set_power_state
void c3gsara_set_power_state(c3gsara_t *ctx, uint8_t state)
3G SARA set power state function.
c3gsara_send_sms_pdu
err_t c3gsara_send_sms_pdu(c3gsara_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
3G SARA send SMS in PDU mode.
c3gsara_init
err_t c3gsara_init(c3gsara_t *ctx, c3gsara_cfg_t *cfg)
3G SARA initialization function.
c3gsara_set_sim_apn
void c3gsara_set_sim_apn(c3gsara_t *ctx, uint8_t *sim_apn)
Set sim card APN.
C3GSARA_CONFIGURE_FOR_NETWORK
@ C3GSARA_CONFIGURE_FOR_NETWORK
Definition: main.c:90
c3gsara_send_cmd
void c3gsara_send_cmd(c3gsara_t *ctx, uint8_t *cmd)
Send command function.
C3GSARA_EXAMPLE
@ C3GSARA_EXAMPLE
Definition: main.c:93
C3GSARA_WAIT_FOR_CONNECTION
@ C3GSARA_WAIT_FOR_CONNECTION
Definition: main.c:91
c3gsara_send_cmd_with_par
void c3gsara_send_cmd_with_par(c3gsara_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:246
C3GSARA_POWER_STATE_ON
#define C3GSARA_POWER_STATE_ON
Definition: c3gsara.h:103
c3gsara_send_sms_text
void c3gsara_send_sms_text(c3gsara_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
3G SARA send SMS in text mode.
C3GSARA_MAP_MIKROBUS
#define C3GSARA_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: c3gsara.h:129
c3gsara_cfg_setup
void c3gsara_cfg_setup(c3gsara_cfg_t *cfg)
3G SARA configuration object setup function.
C3GSARA_CMD_CFUN
#define C3GSARA_CMD_CFUN
Definition: c3gsara.h:75
C3GSARA_OK
@ C3GSARA_OK
Definition: c3gsara.h:197
C3GSARA_RSP_OK
#define C3GSARA_RSP_OK
3G SARA device response for AT commands.
Definition: c3gsara.h:95
c3gsara_cfg_t
3G SARA Click configuration object.
Definition: c3gsara.h:170
C3GSARA_CMD_AT
#define C3GSARA_CMD_AT
3G SARA control commands.
Definition: c3gsara.h:73
c3gsara_t
3G SARA Click context object.
Definition: c3gsara.h:146
application_init
void application_init(void)
Definition: main.c:198
C3GSARA_CONFIGURE_FOR_EXAMPLE
@ C3GSARA_CONFIGURE_FOR_EXAMPLE
Definition: main.c:92