gps6.h File Reference

This file contains API for GPS 6 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	gps6_t
	GPS 6 Click context object. More...
struct	gps6_cfg_t
	GPS 6 Click configuration object. More...

Macros
#define	GPS6_RSP_START   "$"
	GPS 6 response buffer commands.
#define	GPS6_RSP_DELIMITER   ","
#define	GPS6_RSP_GPGGA   "$GPGGA"
#define	GPS6_GPGGA_ELEMENT_SIZE   15
	GPS 6 GPGGA command elements.
#define	GPS6_GPGGA_TIME   1
#define	GPS6_GPGGA_LATITUDE   2
#define	GPS6_GPGGA_LATITUDE_SIDE   3
#define	GPS6_GPGGA_LONGITUDE   4
#define	GPS6_GPGGA_LONGITUDE_SIDE   5
#define	GPS6_GPGGA_QUALITY_INDICATOR   6
#define	GPS6_GPGGA_NUMBER_OF_SATELLITES   7
#define	GPS6_GPGGA_H_DILUTION_OF_POS   8
#define	GPS6_GPGGA_ALTITUDE   9
#define	GPS6_GPGGA_ALTITUDE_UNIT   10
#define	GPS6_GPGGA_GEOIDAL_SEPARATION   11
#define	GPS6_GPGGA_GEOIDAL_SEPARATION_UNIT   12
#define	GPS6_GPGGA_TIME_SINCE_LAST_DGPS   13
#define	GPS6_GPGGA_DGPS_REFERENCE_STATION_ID   14
#define	DRV_TX_BUFFER_SIZE   300
	GPS 6 driver buffer size.
#define	DRV_RX_BUFFER_SIZE   100
#define	GPS6_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	gps6_return_value_t { GPS6_OK = 0 , GPS6_ERROR = -1 }
	GPS 6 Click return value data. More...

Functions
void	gps6_cfg_setup (gps6_cfg_t *cfg)
	GPS 6 configuration object setup function.
err_t	gps6_init (gps6_t *ctx, gps6_cfg_t *cfg)
	GPS 6 initialization function.
err_t	gps6_generic_write (gps6_t *ctx, char *data_buf, uint16_t len)
	GPS 6 data writing function.
err_t	gps6_generic_read (gps6_t *ctx, char *data_buf, uint16_t max_len)
	GPS 6 data reading function.
void	gps6_enable_device (gps6_t *ctx)
	GPS 6 enable device function.
void	gps6_disable_device (gps6_t *ctx)
	GPS 6 disable device function.
err_t	gps6_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data)
	GPS 6 parse GPGGA function.

Detailed Description

This file contains API for GPS 6 Click Driver.

Enumeration Type Documentation

gps6_return_value_t

enum gps6_return_value_t

GPS 6 Click return value data.

Predefined enum values for driver return values.

Enumerator
GPS6_OK
GPS6_ERROR