nanogps2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright (c) 2019, MikroElektronika - www.mikroe.com
 * All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
// ----------------------------------------------------------------------------
 
#ifndef NANOGPS2_H
#define NANOGPS2_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define NANOGPS2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.wkp    = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.en     = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.cts    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.fon    = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.rts    = MIKROBUS( mikrobus, MIKROBUS_INT )
#define NANOGPS2_RETVAL  uint8_t
 
#define NANOGPS2_OK           0x00
#define NANOGPS2_INIT_ERROR   0xFF
#define NANOGPS2_NEMA_GNGGA 1
#define NANOGPS2_NEMA_GPGLL 3
#define NANOGPS2_NEMA_GNGGA_NUM_ELEMENT 15
#define NANOGPS2_NEMA_GPGLL_NUM_ELEMENT 5
#define NANOGPS2_GNGGA_TIME                      1 
#define NANOGPS2_GNGGA_LATITUDE                  2
#define NANOGPS2_GNGGA_LATITUDE_SIDE             3
#define NANOGPS2_GNGGA_LONGITUDE                 4
#define NANOGPS2_GNGGA_LONGITUDE_SIDE            5
#define NANOGPS2_GNGGA_QUALITY_INDICATOR         6
#define NANOGPS2_GNGGA_NUMBER_OF_SATELLITES      7
#define NANOGPS2_GNGGA_H_DILUTION_OF_POS         8
#define NANOGPS2_GNGGA_ALTITUDE                  9
#define NANOGPS2_GNGGA_ALTITUDE_UNIT             10
#define NANOGPS2_GNGGA_GEOIDAL_SEPARATION        11
#define NANOGPS2_GNGGA_GEOIDAL_SEPARATION_UNIT   12
#define NANOGPS2_GNGGA_TIME_SINCE_LAST_DGPS      13
#define NANOGPS2_GNGGA_DGPS_REFERENCE_STATION_ID 14
#define NANOGPS2_GPGLL_LATITUDE                  1
#define NANOGPS2_GPGLL_LATITUDE_SIDE             2
#define NANOGPS2_GPGLL_LONGITUDE                 3
#define NANOGPS2_GPGLL_LONGITUDE_SIDE            4
#define NANOGPS2_ERROR_COMMAND_OR_ELEMENT   0xFF
#define NANOGPS2_ERROR_START_OR_END_COMMAND 0x8F
#define NANOGPS2_ERROR_NEXT_ELEMENT         0x4F
#define NANOGPS2_ERROR_CURRENT_ELEMENT      0x2F
#define NANOGPS2_NO_ERROR                   0x00
#define DRV_RX_BUFFER_SIZE 600
#define DRV_TX_BUFFER_SIZE 50
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t en;
    digital_out_t fon;
    digital_out_t cts;
    
    // Input pins 
 
    digital_in_t wkp;
    digital_in_t rts;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
 
} nanogps2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t wkp;
    pin_name_t en;
    pin_name_t fon;
    pin_name_t cts;
    pin_name_t rts;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits.    
 
} nanogps2_cfg_t;
 
typedef uint8_t nanogps2_error_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void nanogps2_cfg_setup ( nanogps2_cfg_t *cfg );
 
NANOGPS2_RETVAL nanogps2_init ( nanogps2_t *ctx, nanogps2_cfg_t *cfg );
 
void nanogps2_module_wakeup ( nanogps2_t *ctx );
 
void nanogps2_set_fon_pin_state ( nanogps2_t *ctx, uint8_t state );
 
void nanogps2_set_cts_pin_state ( nanogps2_t *ctx, uint8_t state );
 
uint8_t nanogps2_get_wkp_pin ( nanogps2_t *ctx );
 
uint8_t nanogps2_get_rts_pin ( nanogps2_t *ctx );
 
void nanogps2_set_en_pin_state ( nanogps2_t *ctx, uint8_t state );
 
void nanogps2_generic_write ( nanogps2_t *ctx, char *data_buf, uint16_t len );
 
int32_t nanogps2_generic_read ( nanogps2_t *ctx, char *data_buf, uint16_t max_len );
 
nanogps2_error_t nanogps2_generic_parser 
( 
    char *rsp,  uint8_t command, 
    uint8_t element, char *parser_buf 
);
 
#ifdef __cplusplus
}
#endif
#endif  // _NANOGPS2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END