Skip to content

Latest commit

 

History

History
126 lines (96 loc) · 3.89 KB

README.md

File metadata and controls

126 lines (96 loc) · 3.89 KB

GPS 5 Click

GPS 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 : Dec 2021.
  • Type : UART type

Software Support

Example Description

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

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.GPS5

Example Key Functions

  • gps5_cfg_setup Config Object Initialization function.
void gps5_cfg_setup ( gps5_cfg_t *cfg );
  • gps5_init Initialization function.
err_t gps5_init ( gps5_t *ctx, gps5_cfg_t *cfg );
  • gps5_set_rst_pin This function sets the RST pin logic state.
void gps5_set_rst_pin ( gps5_t *ctx, uint8_t state );
  • gps5_generic_read This function reads a desired number of data bytes by using UART serial interface.
err_t gps5_generic_read ( gps5_t *ctx, char *data_buf, uint16_t max_len );
  • gps5_parse_gngga This function parses the GNGGA data from the read response buffer.
err_t gps5_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );

Application Init

Initializes the driver and resets the Click board.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    gps5_cfg_t gps5_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.
    gps5_cfg_setup( &gps5_cfg );
    GPS5_MAP_MIKROBUS( gps5_cfg, MIKROBUS_1 );
    if ( UART_ERROR == gps5_init( &gps5, &gps5_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 )
{
    gps5_process( &gps5 );
    if ( app_buf_len > ( sizeof ( ( char * ) GPS5_RSP_GNGGA ) + GPS5_GNGGA_ELEMENT_SIZE ) ) 
    {
        gps5_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.