This file contains API for GPS 3 Click Driver. More...

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

Data Structures
struct	gps3_t
	GPS 3 Click context object. More...

struct	gps3_cfg_t
	GPS 3 Click configuration object. More...

Macros
#define	GPS3_RSP_START "$"
	GPS 3 response buffer commands.

#define	GPS3_RSP_DELIMITER ","

#define	GPS3_RSP_END_SEQ "\r\n"

#define	GPS3_RSP_GPGGA "$GPGGA"

#define	GPS3_GPGGA_ELEMENT_SIZE 15
	GPS 3 GPGGA command elements.

#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_DRV_TX_BUFFER_SIZE 100
	GPS 3 driver buffer size.

#define	GPS3_DRV_RX_BUFFER_SIZE 1000

#define	GPS3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	gps3_return_value_t { GPS3_OK = 0 , GPS3_ERROR = -1 }
	GPS 3 Click return value data. More...

Functions
void	gps3_cfg_setup (gps3_cfg_t *cfg)
	GPS 3 configuration object setup function.

err_t	gps3_init (gps3_t ctx, gps3_cfg_t cfg)
	GPS 3 initialization function.

err_t	gps3_generic_write (gps3_t ctx, char data_in, uint16_t len)
	GPS 3 data writing function.

err_t	gps3_generic_read (gps3_t ctx, char data_out, uint16_t len)
	GPS 3 data reading function.

void	gps3_clear_ring_buffers (gps3_t *ctx)
	GPS 3 clear ring buffers function.

void	gps3_set_rst_pin (gps3_t *ctx, uint8_t state)
	GPS 3 set RST pin function.

err_t	gps3_parse_gpgga (char rsp_buf, uint8_t gpgga_element, char element_data)
	GPS 3 parse GPGGA function.

Detailed Description

This file contains API for GPS 3 Click Driver.

Enumeration Type Documentation

GPS 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
GPS3_OK
GPS3_ERROR