gnssrtk3.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 GNSSRTK3_H
#define GNSSRTK3_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_uart.h"
 
#define GNSSRTK3_RSP_START                              "$"
#define GNSSRTK3_RSP_DELIMITER                          ","
#define GNSSRTK3_RSP_END                                "\r\n"
#define GNSSRTK3_RSP_GGA                                "GGA"
 
#define GNSSRTK3_GGA_ELEMENT_SIZE                       15
#define GNSSRTK3_GGA_TIME                               1
#define GNSSRTK3_GGA_LATITUDE                           2
#define GNSSRTK3_GGA_LATITUDE_SIDE                      3
#define GNSSRTK3_GGA_LONGITUDE                          4
#define GNSSRTK3_GGA_LONGITUDE_SIDE                     5
#define GNSSRTK3_GGA_QUALITY_INDICATOR                  6
#define GNSSRTK3_GGA_NUMBER_OF_SATELLITES               7
#define GNSSRTK3_GGA_H_DILUTION_OF_POS                  8
#define GNSSRTK3_GGA_ALTITUDE                           9
#define GNSSRTK3_GGA_ALTITUDE_UNIT                      10
#define GNSSRTK3_GGA_GEOIDAL_SEPARATION                 11
#define GNSSRTK3_GGA_GEOIDAL_SEPARATION_UNIT            12
#define GNSSRTK3_GGA_TIME_SINCE_LAST_DGPS               13
#define GNSSRTK3_GGA_DGPS_REFERENCE_STATION_ID          14
 
#define GNSSRTK3_I2C_SLAVE_CR_CMD                       0xAA51u
#define GNSSRTK3_I2C_SLAVE_CW_CMD                       0xAA53u
#define GNSSRTK3_I2C_SLAVE_CMD_LEN                      8
#define GNSSRTK3_I2C_SLAVE_RX_LEN                       4
#define GNSSRTK3_I2C_SLAVE_TX_LEN_REG_OFFSET            0x0008u
#define GNSSRTK3_I2C_SLAVE_TX_BUF_REG_OFFSET            0x2000u
#define GNSSRTK3_I2C_SLAVE_RX_LEN_REG_OFFSET            0x0004u
#define GNSSRTK3_I2C_SLAVE_RX_BUF_REG_OFFSET            0x1000u
#define GNSSRTK3_I2C_SLAVE_ADDRESS_CR_OR_CW             0x50
#define GNSSRTK3_I2C_SLAVE_ADDRESS_R                    0x54
#define GNSSRTK3_I2C_SLAVE_ADDRESS_W                    0x58
#define GNSSRTK3_I2C_SLAVE_MAX_ERRORS                   10
 
#define GNSSRTK3_TX_DRV_BUFFER_SIZE                     100
#define GNSSRTK3_RX_DRV_BUFFER_SIZE                     1000u
 
 // gnssrtk3_cmd
 
#define GNSSRTK3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl    = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda    = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst    = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cen    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.wup    = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pps    = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // gnssrtk3_map
 // gnssrtk3
 
typedef enum
{
    GNSSRTK3_DRV_SEL_UART,            
    GNSSRTK3_DRV_SEL_I2C              
} gnssrtk3_drv_t;
 
struct gnssrtk3_s;
typedef err_t ( *gnssrtk3_master_io_t )( struct gnssrtk3_s*, uint8_t*, uint16_t ); 
typedef struct gnssrtk3_s
{
    digital_out_t rst;              
    digital_out_t cen;              
    digital_out_t wup;              
    digital_in_t  pps;              
    uart_t        uart;             
    i2c_master_t  i2c;              
    uint8_t uart_rx_buffer[ GNSSRTK3_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ GNSSRTK3_TX_DRV_BUFFER_SIZE ];  
    gnssrtk3_drv_t drv_sel;         
    gnssrtk3_master_io_t write_f;   
    gnssrtk3_master_io_t read_f;    
} gnssrtk3_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
    pin_name_t rst;                 
    pin_name_t cen;                 
    pin_name_t wup;                 
    pin_name_t pps;                 
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
    gnssrtk3_drv_t   drv_sel;       
} gnssrtk3_cfg_t;
 
typedef enum
{
    GNSSRTK3_OK = 0,
    GNSSRTK3_ERROR = -1
 
} gnssrtk3_return_value_t;
 
void gnssrtk3_cfg_setup ( gnssrtk3_cfg_t *cfg );
 
void gnssrtk3_drv_interface_sel ( gnssrtk3_cfg_t *cfg, gnssrtk3_drv_t drv_sel );
 
err_t gnssrtk3_init ( gnssrtk3_t *ctx, gnssrtk3_cfg_t *cfg );
 
err_t gnssrtk3_generic_write ( gnssrtk3_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t gnssrtk3_generic_read ( gnssrtk3_t *ctx, uint8_t *data_out, uint16_t len );
 
void gnssrtk3_set_rst_pin ( gnssrtk3_t *ctx, uint8_t state );
 
void gnssrtk3_set_cen_pin ( gnssrtk3_t *ctx, uint8_t state );
 
void gnssrtk3_set_wup_pin ( gnssrtk3_t *ctx, uint8_t state );
 
uint8_t gnssrtk3_get_pps_pin ( gnssrtk3_t *ctx );
 
void gnssrtk3_enable_device ( gnssrtk3_t *ctx );
 
void gnssrtk3_disable_device ( gnssrtk3_t *ctx );
 
void gnssrtk3_reset_device ( gnssrtk3_t *ctx );
 
err_t gnssrtk3_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSSRTK3_H
 
 // gnssrtk3
 
// ------------------------------------------------------------------------ END