gps  2.0.0.0
Main Page

GPS click

GPS click is a compact solution for adding GPS functionality to your device. It carries the u-blox LEA-6S high-performance position engine.

click Product page


Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void gps_cfg_setup ( gps_cfg_t *cfg );

  • Initialization function.

    GPS_RETVAL gps_init ( gps_t *ctx, gps_cfg_t *cfg );

Example key functions :

  • Generic parser function.

    gps_error_t gps_generic_parser ( char *rsp, uint8_t command, uint8_t element, char *parser_buf );

  • Generic read function.

    int32_t gps_generic_read ( gps_t *ctx, char *data_buf, uint16_t max_len );

  • Wake-up module.

    void gps_module_wakeup ( gps_t *ctx );

Examples Description

This example reads and processes data from GPS 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;
gps_cfg_t cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
gps_cfg_setup( &cfg );
GPS_MAP_MIKROBUS( cfg, MIKROBUS_1 );
gps_init( &gps, &cfg );
Delay_ms( 5000 );
}

Application Task

Reads the received data and parses it.

void application_task ( void )
{
gps_process( );
parser_application( current_parser_buf );
}

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

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.


GPS_MAP_MIKROBUS
#define GPS_MAP_MIKROBUS(cfg, mikrobus)
Definition: gps.h:53
application_task
void application_task(void)
Definition: main.c:140
gps_cfg_setup
void gps_cfg_setup(gps_cfg_t *cfg)
Config Object Initialization function.
gps_init
GPS_RETVAL gps_init(gps_t *ctx, gps_cfg_t *cfg)
Initialization function.
gps_module_wakeup
void gps_module_wakeup(gps_t *ctx)
Wake-up module.
application_init
void application_init(void)
Definition: main.c:112
gps_cfg_t
Click configuration structure definition.
Definition: gps.h:160