gnss14.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 GNSS14_H
#define GNSS14_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 GNSS14_RSP_START                                "$"
#define GNSS14_RSP_DELIMITER                            ","
#define GNSS14_RSP_GNGGA                                "$GNGGA"
 
#define GNSS14_GNGGA_ELEMENT_SIZE                       15
#define GNSS14_GNGGA_TIME                               1
#define GNSS14_GNGGA_LATITUDE                           2
#define GNSS14_GNGGA_LATITUDE_SIDE                      3
#define GNSS14_GNGGA_LONGITUDE                          4
#define GNSS14_GNGGA_LONGITUDE_SIDE                     5
#define GNSS14_GNGGA_QUALITY_INDICATOR                  6
#define GNSS14_GNGGA_NUMBER_OF_SATELLITES               7
#define GNSS14_GNGGA_H_DILUTION_OF_POS                  8
#define GNSS14_GNGGA_ALTITUDE                           9
#define GNSS14_GNGGA_ALTITUDE_UNIT                      10
#define GNSS14_GNGGA_GEOIDAL_SEPARATION                 11
#define GNSS14_GNGGA_GEOIDAL_SEPARATION_UNIT            12
#define GNSS14_GNGGA_TIME_SINCE_LAST_DGPS               13
#define GNSS14_GNGGA_DGPS_REFERENCE_STATION_ID          14
 
#define GNSS14_DUMMY                                    0xFF
 
#define GNSS14_SET_DEV_ADDR                             0x42
 
#define GNSS14_DRV_BUFFER_SIZE                          200
 
 // gnss14_set
 
#define GNSS14_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.io6    = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.rst    = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.eit    = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.tp     = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // gnss14_map
 // gnss14
 
typedef enum
{
    GNSS14_DRV_SEL_UART,            
    GNSS14_DRV_SEL_I2C              
} gnss14_drv_t;
 
typedef err_t ( *gnss14_master_io_t )( struct gnss14_s*, uint8_t*, uint8_t ); 
typedef struct gnss14_s
{
    // Output pins
    digital_out_t io6;    
    digital_out_t rst;    
    // Input pins
    digital_in_t eit;    
    digital_in_t tp;      
    // Modules
    i2c_master_t  i2c;    
    uart_t uart;          
    // Buffers
    uint8_t uart_rx_buffer[ GNSS14_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ GNSS14_DRV_BUFFER_SIZE ];  
    uint8_t       slave_address;    
    pin_name_t    chip_select;      
    gnss14_drv_t  drv_sel;          
    gnss14_master_io_t write_f;     
    gnss14_master_io_t read_f;      
} gnss14_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 io6;    
    pin_name_t rst;    
    pin_name_t eit;    
    pin_name_t tp;     
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
    // 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;                  
    gnss14_drv_t     drv_sel;       
} gnss14_cfg_t;
 
typedef enum
{
    GNSS14_OK = 0,
    GNSS14_ERROR = -1
 
} gnss14_return_value_t;
 
void gnss14_cfg_setup ( gnss14_cfg_t *cfg );
 
err_t gnss14_init ( gnss14_t *ctx, gnss14_cfg_t *cfg );
 
err_t gnss14_generic_write ( gnss14_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t gnss14_generic_read ( gnss14_t *ctx, uint8_t *data_out, uint16_t len );
 
void gnss14_set_io6_pin ( gnss14_t *ctx, uint8_t state );
 
void gnss14_set_rst_pin ( gnss14_t *ctx, uint8_t state );
 
uint8_t gnss14_get_eit_pin ( gnss14_t *ctx );
 
uint8_t gnss14_get_tp_pin ( gnss14_t *ctx );
 
void gnss14_reset_device ( gnss14_t *ctx );
 
err_t gnss14_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSS14_H
 
 // gnss14
 
// ------------------------------------------------------------------------ END