gsm 2.0.0.0
Main Page

GSM click

‍GSM click is a compact and powerful GSM cellular network communication solution, featuring the GSM/GPRS Telit GL865-QUAD module. This module features a full set of options for the cellular networking and communication, such as the network status indication, jamming detection, embedded TCP/IP stack, including TCP, IP, UDP, SMTP, ICMP and FTP protocols, full GPRS class 10 implementation; GSM supplementary functions such as the call barring, waiting, forwarding, and holding, calling line identification presentation or restriction (CLIP/CLIR), integrated voice communication codecs, and more.

click Product page


Click library

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

Software Support

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

Standard key functions :

  • gsm_cfg_setup Config Object Initialization function.
    void gsm_cfg_setup ( gsm_cfg_t *cfg );
    void gsm_cfg_setup(gsm_cfg_t *cfg)
    GSM configuration object setup function.
    GSM Click configuration object.
    Definition gsm.h:160
  • gsm_init Initialization function.
    err_t gsm_init ( gsm_t *ctx, gsm_cfg_t *cfg );
    err_t gsm_init(gsm_t *ctx, gsm_cfg_t *cfg)
    GSM initialization function.
    GSM Click context object.
    Definition gsm.h:136

Example key functions :

  • gsm_set_sim_apn This function sets APN for sim card.
    void gsm_set_sim_apn ( gsm_t *ctx, uint8_t *sim_apn );
    void gsm_set_sim_apn(gsm_t *ctx, uint8_t *sim_apn)
    Set sim card APN.
  • gsm_send_sms_text This function sends text message to a phone number.
    void gsm_send_sms_text ( gsm_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
    void gsm_send_sms_text(gsm_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
    GSM send SMS in text mode.
  • gsm_send_sms_pdu This function sends text message to a phone number in PDU mode.
    err_t gsm_send_sms_pdu ( gsm_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
    err_t gsm_send_sms_pdu(gsm_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
    GSM send SMS in PDU mode.

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;
gsm_cfg_t gsm_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
gsm_cfg_setup( &gsm_cfg );
GSM_MAP_MIKROBUS( gsm_cfg, MIKROBUS_1 );
if ( UART_ERROR == gsm_init( &gsm, &gsm_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
gsm_process( );
gsm_clear_app_buf( );
// Check communication
error_flag = gsm_rsp_check( GSM_RSP_OK );
gsm_error_check( error_flag );
// Restart device
#define RESTART_DEVICE "1,1"
error_flag = gsm_rsp_check( GSM_RSP_OK );
gsm_error_check( error_flag );
log_info( &logger, " Application Task " );
example_state = GSM_CONFIGURE_FOR_NETWORK;
}
#define GSM_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition gsm.h:119
#define GSM_CMD_CFUN
Definition gsm.h:75
#define GSM_CMD_AT
GSM control commands.
Definition gsm.h:73
#define GSM_RSP_OK
GSM device response for AT commands.
Definition gsm.h:92
void gsm_send_cmd_with_par(gsm_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
void gsm_send_cmd(gsm_t *ctx, uint8_t *cmd)
Send command function.
void application_init(void)
Definition main.c:198
#define RESTART_DEVICE
@ GSM_CONFIGURE_FOR_NETWORK
Definition main.c:90

Application Task

‍Application task is split in few stages:

  • GSM_CONFIGURE_FOR_NETWORK: Sets configuration to device to be able to connect to the network.
  • GSM_WAIT_FOR_CONNECTION: Waits for the network registration indicated via CREG URC event and then checks the connection status.
  • GSM_CONFIGURE_FOR_EXAMPLE: Sets the device configuration for sending SMS or TCP/UDP messages depending on the selected demo example.
  • GSM_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 ( GSM_OK == gsm_configure_for_network( ) )
{
example_state = GSM_WAIT_FOR_CONNECTION;
}
break;
}
{
if ( GSM_OK == gsm_check_connection( ) )
{
example_state = GSM_CONFIGURE_FOR_EXAMPLE;
}
break;
}
{
if ( GSM_OK == gsm_configure_for_example( ) )
{
example_state = GSM_EXAMPLE;
}
break;
}
{
gsm_example( );
break;
}
default:
{
log_error( &logger, " Example state." );
break;
}
}
}
@ GSM_OK
Definition gsm.h:187
void application_task(void)
Definition main.c:244
@ GSM_EXAMPLE
Definition main.c:93
@ GSM_WAIT_FOR_CONNECTION
Definition main.c:91
@ GSM_CONFIGURE_FOR_EXAMPLE
Definition main.c:92

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

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.