rtkrover

---

RTK Rover Click

RTK Rover 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 : Jul 2022.
• Type : UART type

Software Support

Example Description

This example demonstrates the use of RTK Rover Click by reading and displaying the GPS coordinates.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.RTKRover

Example Key Functions

• rtkrover_cfg_setup Config Object Initialization function.

void rtkrover_cfg_setup ( rtkrover_cfg_t *cfg );

• rtkrover_init Initialization function.

err_t rtkrover_init ( rtkrover_t *ctx, rtkrover_cfg_t *cfg );

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

err_t rtkrover_generic_read ( rtkrover_t *ctx, char *data_out, uint16_t len );

• rtkrover_clear_ring_buffers This function clears UART tx and rx ring buffers.

void rtkrover_clear_ring_buffers ( rtkrover_t *ctx );

• rtkrover_parse_gngga This function parses the GNGGA data from the read response buffer.

err_t rtkrover_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );

Application Init

Initializes the driver and logger.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    rtkrover_cfg_t rtkrover_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.
    rtkrover_cfg_setup( &rtkrover_cfg );
    RTKROVER_MAP_MIKROBUS( rtkrover_cfg, MIKROBUS_1 );
    if ( UART_ERROR == rtkrover_init( &rtkrover, &rtkrover_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 ( RTKROVER_OK == rtkrover_process( &rtkrover ) )
    {
        if ( PROCESS_BUFFER_SIZE == app_buf_len )
        {
            rtkrover_parser_application( &rtkrover, app_buf );
        }
    }
}

Note

The Click board comes with the default baud rate of 460800, but the baud rate is set to 115200 in the example due to code portability and speed limitations of some MCUs. So in order to run the example you will need to adjust the baud rate using Quectel QGNSS evaluation software.

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.

---