nanogps3.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 NANOGPS3_H
#define NANOGPS3_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"
 
 // nanogps3_reg
 
#define NANOGPS3_RSP_START                      "$"
#define NANOGPS3_RSP_DELIMITER                  ","
#define NANOGPS3_RSP_GNGGA                      "$GNGGA"
#define NANOGPS3_RSP_GPGLL                      "$GPGLL"
 
#define NANOGPS3_NMEA_GNGGA                      1
#define NANOGPS3_NMEA_GPGLL                      3
#define NANOGPS3_NMEA_GNGGA_NUM_ELEMENT          15
#define NANOGPS3_NMEA_GPGLL_NUM_ELEMENT          5
 
#define NANOGPS3_GNGGA_TIME                      1 
#define NANOGPS3_GNGGA_LATITUDE                  2
#define NANOGPS3_GNGGA_LATITUDE_SIDE             3
#define NANOGPS3_GNGGA_LONGITUDE                 4
#define NANOGPS3_GNGGA_LONGITUDE_SIDE            5
#define NANOGPS3_GNGGA_QUALITY_INDICATOR         6
#define NANOGPS3_GNGGA_NUMBER_OF_SATELLITES      7
#define NANOGPS3_GNGGA_H_DILUTION_OF_POS         8
#define NANOGPS3_GNGGA_ALTITUDE                  9
#define NANOGPS3_GNGGA_ALTITUDE_UNIT             10
#define NANOGPS3_GNGGA_GEOIDAL_SEPARATION        11
#define NANOGPS3_GNGGA_GEOIDAL_SEPARATION_UNIT   12
#define NANOGPS3_GNGGA_TIME_SINCE_LAST_DGPS      13
#define NANOGPS3_GNGGA_DGPS_REFERENCE_STATION_ID 14
 
#define NANOGPS3_DUMMY                           0xFF
 
#define NANOGPS3_PIN_STATE_LOW                    0
#define NANOGPS3_PIN_STATE_HIGH                   1
 
#define NANOGPS3_TX_DRV_BUFFER_SIZE              100
#define NANOGPS3_RX_DRV_BUFFER_SIZE              600
 
#define NANOGPS3_DEVICE_ADDRESS                  0x10
 
 // nanogps3_set
 
#define NANOGPS3_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );    \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );    \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS );     \
    cfg.wup = MIKROBUS( mikrobus, MIKROBUS_AN );     \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );    \
    cfg.fon = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // nanogps3_map
 // nanogps3
 
typedef enum
{
    NANOGPS3_DRV_SEL_I2C,       
    NANOGPS3_DRV_SEL_UART       
} nanogps3_drv_t;
 
typedef err_t ( *nanogps3_master_io_t )( struct nanogps3_s*, uint8_t*, uint8_t ); 
typedef struct nanogps3_s
{
    // Output pins
    digital_out_t rts;    
    digital_out_t rst;    
    digital_out_t fon;    
    // Input pins
    digital_in_t wup;     
    digital_in_t cts;     
    // Modules
    i2c_master_t i2c;     
    uart_t uart;          
    // I2C slave address
    uint8_t slave_address;    
    // Buffers
    char uart_rx_buffer[ NANOGPS3_RX_DRV_BUFFER_SIZE ];    
    char uart_tx_buffer[ NANOGPS3_TX_DRV_BUFFER_SIZE ];    
    nanogps3_drv_t drv_sel;          
    nanogps3_master_io_t write_f;    
    nanogps3_master_io_t read_f;     
} nanogps3_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t scl;       
    pin_name_t sda;       
    pin_name_t rx_pin;    
    pin_name_t tx_pin;    
    pin_name_t rts;       
    pin_name_t wup;       
    pin_name_t rst;       
    pin_name_t fon;       
    pin_name_t cts;       
    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;         
    nanogps3_drv_t drv_sel;            
} nanogps3_cfg_t;
 
typedef enum
{
    NANOGPS3_OK = 0,
    NANOGPS3_ERROR = -1
 
} nanogps3_return_value_t;
 
void nanogps3_cfg_setup ( nanogps3_cfg_t *cfg );
 
err_t nanogps3_init ( nanogps3_t *ctx, nanogps3_cfg_t *cfg );
 
void nanogps3_default_cfg ( nanogps3_t *ctx );
 
err_t nanogps3_generic_write ( nanogps3_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t nanogps3_generic_read ( nanogps3_t *ctx, uint8_t *data_out, uint8_t len );
 
void nanogps3_request_to_send ( nanogps3_t *ctx, uint8_t rts );
 
uint8_t nanogps3_clear_to_send ( nanogps3_t *ctx );
 
void nanogps3_set_reset_state ( nanogps3_t *ctx, uint8_t rst_state );
 
void nanogps3_set_force_on_state ( nanogps3_t *ctx, uint8_t pwr_state );
 
uint8_t nanogps3_get_wup_pin ( nanogps3_t *ctx );
 
err_t nanogps3_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // NANOGPS3_H
 
 // nanogps3
 
// ------------------------------------------------------------------------ END