gnss6.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 GNSS6_H
#define GNSS6_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 GNSS6_RSP_START                             "$"
#define GNSS6_RSP_DELIMITER                         ","
#define GNSS6_RSP_END_SEQ                           "\r\n"
#define GNSS6_RSP_GPGGA                             "$GPGGA"
#define GNSS6_RSP_NO_FIX                            "0000.00000"
 
#define GNSS6_GPGGA_ELEMENT_SIZE                    15
#define GNSS6_GPGGA_TIME                            1
#define GNSS6_GPGGA_LATITUDE                        2
#define GNSS6_GPGGA_LATITUDE_SIDE                   3
#define GNSS6_GPGGA_LONGITUDE                       4
#define GNSS6_GPGGA_LONGITUDE_SIDE                  5
#define GNSS6_GPGGA_QUALITY_INDICATOR               6
#define GNSS6_GPGGA_NUMBER_OF_SATELLITES            7
#define GNSS6_GPGGA_H_DILUTION_OF_POS               8
#define GNSS6_GPGGA_ALTITUDE                        9
#define GNSS6_GPGGA_ALTITUDE_UNIT                   10
#define GNSS6_GPGGA_GEOIDAL_SEPARATION              11
#define GNSS6_GPGGA_GEOIDAL_SEPARATION_UNIT         12
#define GNSS6_GPGGA_TIME_SINCE_LAST_DGPS            13
#define GNSS6_GPGGA_DGPS_REFERENCE_STATION_ID       14
 
#define GNSS6_DUMMY                                 0xFF
 
#define GNSS6_DEVICE_ADDRESS                        0x3A
 
#define GNSS6_DRV_TX_BUFFER_SIZE                    100
#define GNSS6_DRV_RX_BUFFER_SIZE                    300
 
 // gnss6_cmd
 
#define GNSS6_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.wup     = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pps     = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // gnss6_map
 // gnss6
 
typedef enum
{
    GNSS6_DRV_SEL_UART,      
    GNSS6_DRV_SEL_I2C        
} gnss6_drv_t;
 
typedef err_t ( *gnss6_master_io_t )( struct gnss6_s*, uint8_t*, uint8_t ); 
typedef struct gnss6_s
{
    // Output pins
    digital_out_t rst;      
    digital_out_t wup;      
    // Input pins
    digital_in_t pps;       
    // Modules
    i2c_master_t i2c;       
    uart_t uart;            
    // Buffers
    uint8_t uart_rx_buffer[ GNSS6_DRV_RX_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ GNSS6_DRV_TX_BUFFER_SIZE ];  
    uint8_t slave_address;  
    gnss6_drv_t drv_sel;    
    gnss6_master_io_t  write_f;     
    gnss6_master_io_t  read_f;      
} gnss6_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t scl;         
    pin_name_t sda;         
    pin_name_t rx_pin;      
    pin_name_t tx_pin;      
    // Additional gpio pins
    pin_name_t rst;         
    pin_name_t wup;         
    pin_name_t pps;         
    // 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;                  
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
    gnss6_drv_t drv_sel;    
} gnss6_cfg_t;
 
typedef enum
{
    GNSS6_OK = 0,
    GNSS6_ERROR = -1
 
} gnss6_return_value_t;
 
void gnss6_cfg_setup ( gnss6_cfg_t *cfg );
 
void gnss6_drv_interface_selection ( gnss6_cfg_t *cfg, gnss6_drv_t drv_sel );
 
err_t gnss6_init ( gnss6_t *ctx, gnss6_cfg_t *cfg );
 
err_t gnss6_generic_write ( gnss6_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t gnss6_generic_read ( gnss6_t *ctx, uint8_t *data_out, uint8_t len );
 
void gnss6_set_rst_pin ( gnss6_t *ctx, uint8_t state );
 
void gnss6_set_wup_pin ( gnss6_t *ctx, uint8_t state );
 
uint8_t gnss6_get_pps_pin ( gnss6_t *ctx );
 
void gnss6_reset_device ( gnss6_t *ctx );
 
err_t gnss6_parse_gpgga ( uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSS6_H
 
 // gnss6
 
// ------------------------------------------------------------------------ END