gnss5  2.0.0.0
Main Page

GNSS 5 click

Determine your current position with GNSS 5 click. It carries the NEO-M8N GNSS receiver module from u-blox.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Jul 2022.
  • Type : UART type

Software Support

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

Standard key functions :

Example key functions :

  • gnss5_generic_read This function reads a desired number of data bytes by using UART serial interface.
    err_t gnss5_generic_read ( gnss5_t *ctx, char *data_out, uint16_t len );
  • gnss5_clear_ring_buffers This function clears UART tx and rx ring buffers.
  • gnss5_parse_gngga This function parses the GNGGA data from the read response buffer.
    err_t gnss5_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );

Example Description

This example demonstrates the use of GNSS 5 click by reading and displaying the GPS coordinates.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger.

void application_init ( void )
{
log_cfg_t log_cfg;
gnss5_cfg_t gnss5_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
gnss5_cfg_setup( &gnss5_cfg );
GNSS5_MAP_MIKROBUS( gnss5_cfg, MIKROBUS_1 );
if ( UART_ERROR == gnss5_init( &gnss5, &gnss5_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Reads the received data, parses the GNGGA info from it, and once it receives the position fix it will start displaying the coordinates on the USB UART.

void application_task ( void )
{
if ( GNSS5_OK == gnss5_process( &gnss5 ) )
{
if ( PROCESS_BUFFER_SIZE == app_buf_len )
{
gnss5_parser_application( &gnss5, app_buf );
}
}
}

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

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.


gnss5_parse_gngga
err_t gnss5_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GNSS 5 parse GNGGA function.
GNSS5_OK
@ GNSS5_OK
Definition: gnss5.h:184
gnss5_cfg_setup
void gnss5_cfg_setup(gnss5_cfg_t *cfg)
GNSS 5 configuration object setup function.
gnss5_generic_read
err_t gnss5_generic_read(gnss5_t *ctx, char *data_out, uint16_t len)
GNSS 5 data reading function.
application_task
void application_task(void)
Definition: main.c:101
PROCESS_BUFFER_SIZE
#define PROCESS_BUFFER_SIZE
Definition: main.c:32
gnss5_init
err_t gnss5_init(gnss5_t *ctx, gnss5_cfg_t *cfg)
GNSS 5 initialization function.
gnss5_t
GNSS 5 Click context object.
Definition: gnss5.h:137
gnss5_clear_ring_buffers
void gnss5_clear_ring_buffers(gnss5_t *ctx)
GNSS 5 clear ring buffers function.
application_init
void application_init(void)
Definition: main.c:72
GNSS5_MAP_MIKROBUS
#define GNSS5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: gnss5.h:122
gnss5_cfg_t
GNSS 5 Click configuration object.
Definition: gnss5.h:159