rtkrover.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 RTKROVER_H
#define RTKROVER_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#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"
 
#define RTKROVER_RSP_START                              "$"
#define RTKROVER_RSP_DELIMITER                          ","
#define RTKROVER_RSP_END_SEQ                            "\r\n"
#define RTKROVER_RSP_GNGGA                              "$GNGGA"
 
#define RTKROVER_GNGGA_ELEMENT_SIZE                     15
#define RTKROVER_GNGGA_TIME                             1
#define RTKROVER_GNGGA_LATITUDE                         2
#define RTKROVER_GNGGA_LATITUDE_SIDE                    3
#define RTKROVER_GNGGA_LONGITUDE                        4
#define RTKROVER_GNGGA_LONGITUDE_SIDE                   5
#define RTKROVER_GNGGA_QUALITY_INDICATOR                6
#define RTKROVER_GNGGA_NUMBER_OF_SATELLITES             7
#define RTKROVER_GNGGA_H_DILUTION_OF_POS                8
#define RTKROVER_GNGGA_ALTITUDE                         9
#define RTKROVER_GNGGA_ALTITUDE_UNIT                    10
#define RTKROVER_GNGGA_GEOIDAL_SEPARATION               11
#define RTKROVER_GNGGA_GEOIDAL_SEPARATION_UNIT          12
#define RTKROVER_GNGGA_TIME_SINCE_LAST_DGPS             13
#define RTKROVER_GNGGA_DGPS_REFERENCE_STATION_ID        14
 
#define DRV_TX_BUFFER_SIZE                              100
#define DRV_RX_BUFFER_SIZE                              1000
 
 // rtkrover_cmd
 
#define RTKROVER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.shd = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.wup = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.bt = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // rtkrover_map
 // rtkrover
 
typedef struct
{
    // Output pins
    digital_out_t shd;          
    digital_out_t rst;          
    digital_out_t wup;          
    digital_out_t bt;           
    // Input pins
    digital_in_t int_pin;       
    // Modules
    uart_t uart;                
    // Buffers
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];  
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];  
} rtkrover_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;          
    pin_name_t tx_pin;          
    // Additional gpio pins
    pin_name_t shd;             
    pin_name_t rst;             
    pin_name_t wup;             
    pin_name_t bt;              
    pin_name_t int_pin;         
    // Static variable
    uint32_t          baud_rate;                
    bool              uart_blocking;            
    uart_data_bits_t  data_bit;                 
    uart_parity_t     parity_bit;               
    uart_stop_bits_t  stop_bit;                 
} rtkrover_cfg_t;
 
typedef enum
{
    RTKROVER_OK = 0,
    RTKROVER_ERROR = -1
 
} rtkrover_return_value_t;
 
void rtkrover_cfg_setup ( rtkrover_cfg_t *cfg );
 
err_t rtkrover_init ( rtkrover_t *ctx, rtkrover_cfg_t *cfg );
 
err_t rtkrover_generic_write ( rtkrover_t *ctx, char *data_in, uint16_t len );
 
err_t rtkrover_generic_read ( rtkrover_t *ctx, char *data_out, uint16_t len );
 
void rtkrover_clear_ring_buffers ( rtkrover_t *ctx );
 
void rtkrover_set_rst_pin ( rtkrover_t *ctx, uint8_t state );
 
void rtkrover_set_wup_pin ( rtkrover_t *ctx, uint8_t state );
 
void rtkrover_set_boot_pin ( rtkrover_t *ctx, uint8_t state );
 
void rtkrover_set_shd_pin ( rtkrover_t *ctx, uint8_t state );
 
uint8_t rtkrover_get_int_pin ( rtkrover_t *ctx );
 
err_t rtkrover_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // RTKROVER_H
 
 // rtkrover
 
// ------------------------------------------------------------------------ END