gps3  2.0.0.0
Data Structures | Macros | Typedefs | Functions
gps3.h File Reference

This file contains API for GPS3 Click driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  gps3_t
 Click ctx object definition. More...
 
struct  gps3_cfg_t
 Click configuration structure definition. More...
 

Macros

#define GPS3_MAP_MIKROBUS(cfg, mikrobus)
 
#define GPS3_RETVAL   uint8_t
 
#define GPS3_OK   0x00
 
#define GPS3_INIT_ERROR   0xFF
 
#define GPS3_NEMA_GPGGA   1
 
#define GPS3_NEMA_GPGLL   3
 
#define GPS3_NEMA_GPGGA_NUM_ELEMENT   15
 
#define GPS3_NEMA_GPGLL_NUM_ELEMENT   5
 
#define GPS3_GPGGA_TIME   1
 
#define GPS3_GPGGA_LATITUDE   2
 
#define GPS3_GPGGA_LATITUDE_SIDE   3
 
#define GPS3_GPGGA_LONGITUDE   4
 
#define GPS3_GPGGA_LONGITUDE_SIDE   5
 
#define GPS3_GPGGA_QUALITY_INDICATOR   6
 
#define GPS3_GPGGA_NUMBER_OF_SATELLITES   7
 
#define GPS3_GPGGA_H_DILUTION_OF_POS   8
 
#define GPS3_GPGGA_ALTITUDE   9
 
#define GPS3_GPGGA_ALTITUDE_UNIT   10
 
#define GPS3_GPGGA_GEOIDAL_SEPARATION   11
 
#define GPS3_GPGGA_GEOIDAL_SEPARATION_UNIT   12
 
#define GPS3_GPGGA_TIME_SINCE_LAST_DGPS   13
 
#define GPS3_GPGGA_DGPS_REFERENCE_STATION_ID   14
 
#define GPS3_GPGLL_LATITUDE   1
 
#define GPS3_GPGLL_LATITUDE_SIDE   2
 
#define GPS3_GPGLL_LONGITUDE   3
 
#define GPS3_GPGLL_LONGITUDE_SIDE   4
 
#define GPS3_ERROR_COMMAND_OR_ELEMENT   0xFF
 
#define GPS3_ERROR_START_OR_END_COMMAND   0x8F
 
#define GPS3_ERROR_NEXT_ELEMENT   0x4F
 
#define GPS3_ERROR_CURRENT_ELEMENT   0x2F
 
#define GPS3_NO_ERROR   0x00
 
#define DRV_RX_BUFFER_SIZE   1000
 

Typedefs

typedef uint8_t gps3_error_t
 Error type. More...
 

Functions

void gps3_cfg_setup (gps3_cfg_t *cfg)
 Config Object Initialization function. More...
 
GPS3_RETVAL gps3_init (gps3_t *ctx, gps3_cfg_t *cfg)
 Initialization function. More...
 
void gps3_module_wakeup (gps3_t *ctx)
 Wake-up module. More...
 
void gps3_set_rst_pin (gps3_t *ctx, uint8_t state)
 Set RST ( reset ) pin state. More...
 
void gps3_generic_write (gps3_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int16_t gps3_generic_read (gps3_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
gps3_error_t gps3_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function. More...
 

Detailed Description

This file contains API for GPS3 Click driver.