gnssrtk5

---

GNSS RTK 5 Click

GNSS RTK 5 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

• Author : Stefan Filipovic
• Date : Oct 2024.
• Type : UART type

Software Support

Example Description

This example demonstrates the use of GNSS RTK 5 Click by reading and displaying the GNSS coordinates.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.GNSSRTK5

Example Key Functions

• gnssrtk5_cfg_setup Config Object Initialization function.

void gnssrtk5_cfg_setup ( gnssrtk5_cfg_t *cfg );

• gnssrtk5_init Initialization function.

err_t gnssrtk5_init ( gnssrtk5_t *ctx, gnssrtk5_cfg_t *cfg );

• gnssrtk5_cmd_run This function parses the GGA data from the read response buffer.

void gnssrtk5_cmd_run ( gnssrtk5_t *ctx, uint8_t *cmd );

• gnssrtk5_parse_gga This function parses the GGA data from the read response buffer.

err_t gnssrtk5_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );

• gnssrtk5_generic_read This function reads a desired number of data bytes by using UART serial interface.

err_t gnssrtk5_generic_read ( gnssrtk5_t *ctx, uint8_t *data_out, uint16_t len );

Application Init

Initializes the driver, resets the Click board, reads the module version and config, and enables the NMEA GNGGA message output.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    gnssrtk5_cfg_t gnssrtk5_cfg;  /**< Click config object. */

    /** 
     * 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 " );

    // Click initialization.
    gnssrtk5_cfg_setup( &gnssrtk5_cfg );
    GNSSRTK5_MAP_MIKROBUS( gnssrtk5_cfg, MIKROBUS_1 );
    if ( UART_ERROR == gnssrtk5_init( &gnssrtk5, &gnssrtk5_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    log_printf( &logger, ">>> Reset device.\r\n" );
    gnssrtk5_reset_device ( &gnssrtk5 );
    gnssrtk5_read_response ( &gnssrtk5, GNSSRTK5_RSP_RESET );
    
    log_printf( &logger, ">>> Get module version.\r\n" );
    gnssrtk5_cmd_run ( &gnssrtk5, GNSSRTK5_CMD_GET_VERSION );
    gnssrtk5_read_response ( &gnssrtk5, GNSSRTK5_RSP_COMMAND );

    log_printf( &logger, ">>> Get module config.\r\n" );
    gnssrtk5_cmd_run ( &gnssrtk5, GNSSRTK5_CMD_GET_CONFIG );
    gnssrtk5_read_response ( &gnssrtk5, GNSSRTK5_RSP_COMMAND );

    log_printf( &logger, ">>> Enable GNGGA output.\r\n" );
    gnssrtk5_cmd_run ( &gnssrtk5, GNSSRTK5_CMD_ENABLE_GGA );
    gnssrtk5_read_response ( &gnssrtk5, GNSSRTK5_RSP_COMMAND );
    gnssrtk5_clear_app_buf( );

    log_info( &logger, " Application Task " );
}

Application Task

Reads the received data, parses the NMEA GGA 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 ( GNSSRTK5_OK == gnssrtk5_process( &gnssrtk5 ) ) 
    {
        if ( app_buf_len > ( sizeof ( GNSSRTK5_RSP_GGA ) + GNSSRTK5_GGA_ELEMENT_SIZE ) ) 
        {
            gnssrtk5_parser_application( app_buf );
        }
    }
}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

---