gnss13.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 GNSS13_H
#define GNSS13_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"
#include "drv_i2c_master.h"
 
#define GNSS13_RSP_START                            "$"
#define GNSS13_RSP_DELIMITER                        ","
#define GNSS13_RSP_END_SEQ                          "\r\n"
#define GNSS13_RSP_GNGGA                            "$GNGGA"
 
#define GNSS13_GNGGA_ELEMENT_SIZE                   15
#define GNSS13_GNGGA_TIME                           1
#define GNSS13_GNGGA_LATITUDE                       2
#define GNSS13_GNGGA_LATITUDE_SIDE                  3
#define GNSS13_GNGGA_LONGITUDE                      4
#define GNSS13_GNGGA_LONGITUDE_SIDE                 5
#define GNSS13_GNGGA_QUALITY_INDICATOR              6
#define GNSS13_GNGGA_NUMBER_OF_SATELLITES           7
#define GNSS13_GNGGA_H_DILUTION_OF_POS              8
#define GNSS13_GNGGA_ALTITUDE                       9
#define GNSS13_GNGGA_ALTITUDE_UNIT                  10
#define GNSS13_GNGGA_GEOIDAL_SEPARATION             11
#define GNSS13_GNGGA_GEOIDAL_SEPARATION_UNIT        12
#define GNSS13_GNGGA_TIME_SINCE_LAST_DGPS           13
#define GNSS13_GNGGA_DGPS_REFERENCE_STATION_ID      14
 
#define GNSS13_DEVICE_ADDRESS                       0x10
 
#define GNSS13_DRV_TX_BUFFER_SIZE                   100
#define GNSS13_DRV_RX_BUFFER_SIZE                   1200
 
 // gnss13_cmd
 
#define GNSS13_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 );
 
 // gnss13_map
 // gnss13
 
typedef enum
{
    GNSS13_DRV_SEL_UART,        
    GNSS13_DRV_SEL_I2C          
} gnss13_drv_t;
 
typedef err_t ( *gnss13_master_io_t )( struct gnss13_s*, uint8_t*, uint8_t ); 
typedef struct gnss13_s
{
    // Output pins
    digital_out_t rst;          
    digital_out_t wup;          
    // Modules
    uart_t uart;                
    i2c_master_t i2c;           
    // Buffers
    char uart_rx_buffer[ GNSS13_DRV_RX_BUFFER_SIZE ];   
    char uart_tx_buffer[ GNSS13_DRV_TX_BUFFER_SIZE ];   
    uint8_t      slave_address; 
    gnss13_drv_t drv_sel;       
    gnss13_master_io_t write_f; 
    gnss13_master_io_t read_f;  
} gnss13_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;             
    // 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;     
    gnss13_drv_t drv_sel;       
} gnss13_cfg_t;
 
typedef enum
{
    GNSS13_OK = 0,
    GNSS13_ERROR = -1
 
} gnss13_return_value_t;
 
void gnss13_cfg_setup ( gnss13_cfg_t *cfg );
 
void gnss13_drv_interface_selection ( gnss13_cfg_t *cfg, gnss13_drv_t drv_sel );
 
err_t gnss13_init ( gnss13_t *ctx, gnss13_cfg_t *cfg );
 
err_t gnss13_generic_write ( gnss13_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t gnss13_generic_read ( gnss13_t *ctx, uint8_t *data_out, uint8_t len );
 
void gnss13_clear_ring_buffers ( gnss13_t *ctx );
 
void gnss13_set_rst_pin ( gnss13_t *ctx, uint8_t state );
 
void gnss13_set_wup_pin ( gnss13_t *ctx, uint8_t state );
 
err_t gnss13_parse_gngga ( uint8_t *rsp_buf, uint8_t gngga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSS13_H
 
 // gnss13
 
// ------------------------------------------------------------------------ END