gnssrtk.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 GNSSRTK_H
#define GNSSRTK_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_i2c_master.h"
#include "drv_spi_master.h"
#include "drv_uart.h"
#include "spi_specifics.h"
 
#define GNSSRTK_RSP_START                              "$"
#define GNSSRTK_RSP_DELIMITER                          ","
#define GNSSRTK_RSP_GNGGA                              "$GNGGA"
 
#define GNSSRTK_GNGGA_ELEMENT_SIZE                     15
#define GNSSRTK_GNGGA_TIME                             1
#define GNSSRTK_GNGGA_LATITUDE                         2
#define GNSSRTK_GNGGA_LATITUDE_SIDE                    3
#define GNSSRTK_GNGGA_LONGITUDE                        4
#define GNSSRTK_GNGGA_LONGITUDE_SIDE                   5
#define GNSSRTK_GNGGA_QUALITY_INDICATOR                6
#define GNSSRTK_GNGGA_NUMBER_OF_SATELLITES             7
#define GNSSRTK_GNGGA_H_DILUTION_OF_POS                8
#define GNSSRTK_GNGGA_ALTITUDE                         9
#define GNSSRTK_GNGGA_ALTITUDE_UNIT                    10
#define GNSSRTK_GNGGA_GEOIDAL_SEPARATION               11
#define GNSSRTK_GNGGA_GEOIDAL_SEPARATION_UNIT          12
#define GNSSRTK_GNGGA_TIME_SINCE_LAST_DGPS             13
#define GNSSRTK_GNGGA_DGPS_REFERENCE_STATION_ID        14
 
#define GNSSRTK_DUMMY                                  0xFF
 
#define GNSSRTK_SET_DEV_ADDR                           0x42
 
#define GNSSRTK_DRV_TX_BUFFER_SIZE                     100
#define GNSSRTK_DRV_RX_BUFFER_SIZE                     300
 
#define GNSSRTK_SET_DATA_SAMPLE_EDGE                   SET_SPI_DATA_SAMPLE_EDGE
#define GNSSRTK_SET_DATA_SAMPLE_MIDDLE                 SET_SPI_DATA_SAMPLE_MIDDLE
 
 // gnssrtk_set
 
#define GNSSRTK_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl    = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda    = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso   = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi   = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck    = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs     = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rdy    = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rtk    = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rst    = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.tmp    = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // gnssrtk_map
 // gnssrtk
 
typedef enum
{
    GNSSRTK_DRV_SEL_UART,      
    GNSSRTK_DRV_SEL_SPI,       
    GNSSRTK_DRV_SEL_I2C        
} gnssrtk_drv_t;
 
typedef err_t ( *gnssrtk_master_io_t )( struct gnssrtk_s*, uint8_t*, uint8_t ); 
typedef struct gnssrtk_s
{
    digital_out_t rst;                      
    digital_in_t  rdy;                      
    digital_in_t  rtk;                      
    digital_in_t  tmp;                      
    i2c_master_t  i2c;                      
    spi_master_t  spi;                      
    uart_t uart;                            
    // Buffers
    char uart_rx_buffer[ GNSSRTK_DRV_RX_BUFFER_SIZE ];  
    char uart_tx_buffer[ GNSSRTK_DRV_TX_BUFFER_SIZE ];  
    uint8_t     slave_address;              
    pin_name_t  chip_select;                
    gnssrtk_drv_t  drv_sel;                 
    gnssrtk_master_io_t  write_f;           
    gnssrtk_master_io_t  read_f;            
} gnssrtk_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  miso;               
    pin_name_t  mosi;               
    pin_name_t  sck;                
    pin_name_t  cs;                 
    pin_name_t  rx_pin;             
    pin_name_t  tx_pin;             
    pin_name_t  rdy;                
    pin_name_t  rtk;                
    pin_name_t  rst;                
    pin_name_t  tmp;                
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
    gnssrtk_drv_t  drv_sel;         
} gnssrtk_cfg_t;
 
typedef enum
{
    GNSSRTK_OK = 0,
    GNSSRTK_ERROR = -1
 
} gnssrtk_return_value_t;
 
void gnssrtk_cfg_setup ( gnssrtk_cfg_t *cfg );
 
void gnssrtk_drv_interface_selection ( gnssrtk_cfg_t *cfg, gnssrtk_drv_t drv_sel );
 
err_t gnssrtk_init ( gnssrtk_t *ctx, gnssrtk_cfg_t *cfg );
 
err_t gnssrtk_generic_write ( gnssrtk_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t gnssrtk_generic_read ( gnssrtk_t *ctx, uint8_t *data_out, uint8_t len );
 
void gnssrtk_set_rst_pin ( gnssrtk_t *ctx, uint8_t state );
 
uint8_t gnssrtk_get_rdy_pin ( gnssrtk_t *ctx );
 
uint8_t gnssrtk_get_rtk_pin ( gnssrtk_t *ctx );
 
uint8_t gnssrtk_get_tmp_pin ( gnssrtk_t *ctx );
 
void gnssrtk_reset_device ( gnssrtk_t *ctx );
 
err_t gnssrtk_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSSRTK_H
 
 // gnssrtk
 
// ------------------------------------------------------------------------ END