Utilize signals from multiple satellite constellations with ZOE-M8 and PIC32MZ1024EFH064

/*!
 * @file main.c
 * @brief GNSS ZOE Click example
 *
 * # Description
 * This example demonstrates the use of GNSS ZOE click by reading and displaying
 * the GNSS coordinates.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes the driver and resets the click board.
 *
 * ## 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.
 *
 * ## Additional Function
 * - static void gnsszoe_clear_app_buf ( void )
 * - static err_t gnsszoe_process ( gnsszoe_t *ctx )
 * - static void gnsszoe_parser_application ( char *rsp )
 *
 * @author Stefan Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "gnsszoe.h"

#define PROCESS_BUFFER_SIZE 300

static gnsszoe_t gnsszoe;
static log_t logger;

static char app_buf[ PROCESS_BUFFER_SIZE ] = { 0 };
static int32_t app_buf_len = 0;
static int32_t app_buf_cnt = 0;

/**
 * @brief GNSS ZOE clearing application buffer.
 * @details This function clears memory of application buffer and reset its length and counter.
 * @return None.
 * @note None.
 */
static void gnsszoe_clear_app_buf ( void );

/**
 * @brief GNSS ZOE data reading function.
 * @details This function reads data from device and concatenates data to application buffer.
 * @param[in] ctx : Click context object.
 * See #gnsszoe_t object definition for detailed explanation.
 * @return @li @c  0 - Read some data.
 *         @li @c -1 - Nothing is read or Application buffer overflow.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t gnsszoe_process ( gnsszoe_t *ctx );

/**
 * @brief GNSS ZOE parser application.
 * @param[in] rsp Response buffer.
 * @details This function logs GNSS data on the USB UART.
 * @return None.
 * @note None.
 */
static void gnsszoe_parser_application ( char *rsp );

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    gnsszoe_cfg_t gnsszoe_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.
    gnsszoe_cfg_setup( &gnsszoe_cfg );
    GNSSZOE_MAP_MIKROBUS( gnsszoe_cfg, MIKROBUS_1 );
    err_t init_flag = gnsszoe_init( &gnsszoe, &gnsszoe_cfg );
    if ( ( UART_ERROR == init_flag ) || ( I2C_MASTER_ERROR == init_flag ) || ( SPI_MASTER_ERROR == init_flag ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

void application_task ( void )
{
    gnsszoe_process( &gnsszoe );
    if ( app_buf_len > ( sizeof ( GNSSZOE_RSP_GNGGA ) + GNSSZOE_GNGGA_ELEMENT_SIZE ) ) 
    {
        gnsszoe_parser_application( app_buf );
    }
}

void main ( void )
{
    application_init( );

    for ( ; ; )
    {
        application_task( );
    }
}

static void gnsszoe_clear_app_buf ( void ) 
{
    memset( app_buf, 0, app_buf_len );
    app_buf_len = 0;
    app_buf_cnt = 0;
}

static err_t gnsszoe_process ( gnsszoe_t *ctx ) 
{
    int32_t rx_size = 0;
    char rx_buf[ PROCESS_BUFFER_SIZE ] = { 0 };
    if ( GNSSZOE_DRV_SEL_UART == ctx->drv_sel )
    {
        rx_size = gnsszoe_generic_read( ctx, rx_buf, PROCESS_BUFFER_SIZE );
    }
    else if ( ( GNSSZOE_DRV_SEL_I2C == ctx->drv_sel ) || ( GNSSZOE_DRV_SEL_SPI == ctx->drv_sel ) )
    {
        if ( GNSSZOE_OK == gnsszoe_generic_read( ctx, rx_buf, 1 ) )
        {
            if ( GNSSZOE_DUMMY != rx_buf[ 0 ] )
            {
                rx_size = 1;
            }
        }
    }
    if ( rx_size > 0 ) 
    {
        int32_t buf_cnt = 0;
        if ( ( app_buf_len + rx_size ) > PROCESS_BUFFER_SIZE ) 
        {
            gnsszoe_clear_app_buf(  );
            return GNSSZOE_ERROR;
        } 
        else 
        {
            buf_cnt = app_buf_len;
            app_buf_len += rx_size;
        }
        for ( int32_t rx_cnt = 0; rx_cnt < rx_size; rx_cnt++ ) 
        {
            if ( rx_buf[ rx_cnt ] ) 
            {
                app_buf[ ( buf_cnt + rx_cnt ) ] = rx_buf[ rx_cnt ];
            }
            else
            {
                app_buf_len--;
                buf_cnt--;
            }
        }
        return GNSSZOE_OK;
    }
    return GNSSZOE_ERROR;
}

static void gnsszoe_parser_application ( char *rsp )
{
    char element_buf[ 100 ] = { 0 };
    if ( GNSSZOE_OK == gnsszoe_parse_gngga( rsp, GNSSZOE_GNGGA_LATITUDE, element_buf ) )
    {
        static uint8_t wait_for_fix_cnt = 0;
        if ( strlen( element_buf ) > 0 )
        {
            log_printf( &logger, "\r\n Latitude: %.2s degrees, %s minutes \r\n", element_buf, &element_buf[ 2 ] );
            gnsszoe_parse_gngga( rsp, GNSSZOE_GNGGA_LONGITUDE, element_buf );
            log_printf( &logger, " Longitude: %.3s degrees, %s minutes \r\n", element_buf, &element_buf[ 3 ] );
            memset( element_buf, 0, sizeof( element_buf ) );
            gnsszoe_parse_gngga( rsp, GNSSZOE_GNGGA_ALTITUDE, element_buf );
            log_printf( &logger, " Altitude: %s m \r\n", element_buf );
            wait_for_fix_cnt = 0;
        }
        else
        {
            if ( wait_for_fix_cnt % 5 == 0 )
            {
                log_printf( &logger, " Waiting for the position fix...\r\n\n" );
                wait_for_fix_cnt = 0;
            }
            wait_for_fix_cnt++;
        }
        gnsszoe_clear_app_buf(  );
    }
}

// ------------------------------------------------------------------------ END