gsmgnss  2.0.0.0
Main Page

GSM/GNSS click

GSM/GNSS click combines GPS/GLONASS location tracking with GSM module capability for mobile communication. The click features Quectel’s MC60 quad-band module.

click Product page


Click library

  • Author : MikroE Team
  • Date : apr 2020.
  • Type : UART type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void gsmgnss_cfg_setup ( gsmgnss_cfg_t *cfg );

  • Initialization function.

    GSMGNSS_RETVAL gsmgnss_init ( gsmgnss_t *ctx, gsmgnss_cfg_t *cfg );

  • Power ON/OFF the module.

    void gsmgnss_module_power ( gsmgnss_t *ctx, uint8_t state );

Example key functions :

  • Send command function.

    void gsmgnss_send_cmd ( gsmgnss_t *ctx, char *cmd );

  • Set sim card APN.

    void gsmgnss_set_sim_apn ( gsmgnss_t *ctx, char *sim_apn );

  • GSM GNSS send SMS in PDU mode.

    err_t gsmgnss_send_sms_pdu ( gsmgnss_t *ctx, char *service_center_number, char *phone_number, char *sms_text );

Examples Description

This example reads and processes data from GSM/GNSS clicks.

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;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
GSMGNSS_MAP_MIKROBUS( cfg, MIKROBUS_1 );
gsmgnss_init( &gsmgnss, &cfg );
// dummy read
gsmgnss_process( );
gsmgnss_clear_app_buf( );
// AT
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// ATI - product information
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// CGMR - firmware version
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// CMEE - Report Mobile Equipment Error
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// COPS - deregister from network
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// CGDCONT - set sim apn
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// CFUN - full funtionality
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// COPS - automatic mode
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 2000 );
// CREG - network registration status
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// QGNSSC - power ON GNSS
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_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 the device to connect to network, then waits for the GNSS position fix. Once it get a fix, it sends an SMS with GNSS info to the selected phone number approximately every 40 seconds.

void application_task ( void )
{
if ( app_connection_status == WAIT_FOR_CONNECTION )
{
// CREG - network registration status
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 500 );
// CSQ - signal quality
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 5000 );
}
else
{
log_info( &logger, "CONNECTED TO NETWORK" );
// SMS message format - PDU mode
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 3000 );
for( ; ; )
{
// Get GNSS info
gnss_parser_flag = 1;
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 3000 );
if ( gnss_parser_flag == 0 )
{
log_printf( &logger, "> Sending message to phone number...\r\n" );
gsmgnss_send_sms_pdu ( &gsmgnss, SIM_SMSC, PHONE_NUMBER_TO_MESSAGE, gnss_info_message );
app_error_flag = gsmgnss_rsp_check( );
gsmgnss_error_check( app_error_flag );
Delay_ms( 10000 );
Delay_ms( 10000 );
Delay_ms( 10000 );
}
}
}
}

Note

A passive GPS antenna is required for the GNSS to receive the position fix. It may take several minutes for the module to receive the fix. 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 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.GsmGnss

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.


gsmgnss_init
GSMGNSS_RETVAL gsmgnss_init(gsmgnss_t *ctx, gsmgnss_cfg_t *cfg)
Initialization function.
SIM_SMSC
#define SIM_SMSC
Definition: main.c:57
gsmgnss_set_sim_apn
void gsmgnss_set_sim_apn(gsmgnss_t *ctx, char *sim_apn)
Set sim card APN.
GSMGNSS_CMD_CMGF
#define GSMGNSS_CMD_CMGF
Definition: gsmgnss.h:147
gsmgnss_send_cmd_check
void gsmgnss_send_cmd_check(gsmgnss_t *ctx, char *at_cmd_buf)
Check the sent command.
application_task
void application_task(void)
Definition: main.c:239
SIM_APN
#define SIM_APN
Definition: main.c:56
GSMGNSS_CMD_CMEE
#define GSMGNSS_CMD_CMEE
Definition: gsmgnss.h:142
GSMGNSS_CMD_AT
#define GSMGNSS_CMD_AT
Definition: gsmgnss.h:133
WAIT_FOR_CONNECTION
#define WAIT_FOR_CONNECTION
Definition: main.c:62
GSMGNSS_CMD_CREG
#define GSMGNSS_CMD_CREG
Definition: gsmgnss.h:138
gsmgnss_module_power
void gsmgnss_module_power(gsmgnss_t *ctx, uint8_t state)
Power ON/OFF the module.
GSMGNSS_CMD_CSQ
#define GSMGNSS_CMD_CSQ
Definition: gsmgnss.h:144
GSMGNSS_CMD_QGNSSRD
#define GSMGNSS_CMD_QGNSSRD
Definition: gsmgnss.h:149
GSMGNSS_CMD_CGMR
#define GSMGNSS_CMD_CGMR
Definition: gsmgnss.h:135
gsmgnss_cfg_t
Click configuration structure definition.
Definition: gsmgnss.h:195
gsmgnss_cfg_setup
void gsmgnss_cfg_setup(gsmgnss_cfg_t *cfg)
Config Object Initialization function.
application_init
void application_init(void)
Definition: main.c:142
GSMGNSS_MAP_MIKROBUS
#define GSMGNSS_MAP_MIKROBUS(cfg, mikrobus)
Definition: gsmgnss.h:53
gsmgnss_send_cmd_with_parameter
void gsmgnss_send_cmd_with_parameter(gsmgnss_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
GSMGNSS_CMD_COPS
#define GSMGNSS_CMD_COPS
Definition: gsmgnss.h:145
GSMGNSS_CMD_CFUN
#define GSMGNSS_CMD_CFUN
Definition: gsmgnss.h:137
GSMGNSS_CMD_ATI
#define GSMGNSS_CMD_ATI
Definition: gsmgnss.h:134
PHONE_NUMBER_TO_MESSAGE
#define PHONE_NUMBER_TO_MESSAGE
Definition: main.c:58
GSMGNSS_MODULE_POWER_ON
#define GSMGNSS_MODULE_POWER_ON
Definition: gsmgnss.h:125
gsmgnss_send_cmd
void gsmgnss_send_cmd(gsmgnss_t *ctx, char *cmd)
Send command function.
gsmgnss_send_sms_pdu
err_t gsmgnss_send_sms_pdu(gsmgnss_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
GSM GNSS send SMS in PDU mode.
GSMGNSS_CMD_QGNSSC
#define GSMGNSS_CMD_QGNSSC
Definition: gsmgnss.h:148