Skip to content

Latest commit

 

History

History
154 lines (100 loc) · 4 KB

README.md

File metadata and controls

154 lines (100 loc) · 4 KB
Raw

\mainpage Main Page

GSM 3 click

GSM3 click is a complete quad-band GSM cellular network communication solution, featuring the SIM800H-BT, a quad-band 2G GSM/GPRS module.

click Product page

Click library

  • Author : MikroE Team
  • Date : Apr 2020.
  • Type : UART GPS/GNSS type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

void gsm3_cfg_setup ( gsm3_cfg_t *cfg );

  • Initialization function.

GSM3_RETVAL gsm3_init ( gsm3_t *ctx, gsm3_cfg_t *cfg );

Example key functions :

  • Enables or disables module power.

void gsm3_module_power( gsm3_t *ctx );

  • Reset module.

void gsm3_reset ( gsm3_t *ctx );

  • Command function.

void gsm3_send_command ( gsm3_t *ctx, char *command );

Examples Description

This example reads and processes data from GSM 3 clicks.

The demo application is composed of two sections :

Application Init

Initializes driver and wake-up module.

void application_init ( void )
{
    log_cfg_t log_cfg;
    gsm3_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    gsm3_cfg_setup( &cfg );
    GSM3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    gsm3_init( &gsm3, &cfg );

    gsm3_module_power( &gsm3 );

    gsm3_process(  );

    while( ( gsm3_get_state_net_led( &gsm3 ) != 0 ) || ( gsm3_get_state_conn_led( &gsm3 ) != 0 ) );
    gsm3_process(  );
    
    gsm3_send_command( &gsm3, GSM3_SINGLE_CMD_AT );
    gsm3_process(  );

    gsm3_send_command( &gsm3, GSM3_SINGLE_CMD_AT );
    gsm3_process(  );

    gsm3_send_command( &gsm3, GSM3_SINGLE_CMD_AT );
    gsm3_process(  );

    gsm3_send_command( &gsm3, GSM3_SINGLE_CMD_ATE0 );
    gsm3_process(  );

    gsm3_send_command( &gsm3, "AT+IFC=2,2" );
    gsm3_process(  );
    
    gsm3_send_command( &gsm3, "AT+CMGF=1" );
    gsm3_process(  );

    Delay_ms( 2000 );
}

Application Task

Reads the received data and parses it.

void application_task ( void )
{
  gsm3_process(  );
}

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

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.