gnss5.h File Reference

This file contains API for GNSS 5 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	gnss5_t
	GNSS 5 Click context object. More...
struct	gnss5_cfg_t
	GNSS 5 Click configuration object. More...

Macros
#define	GNSS5_RSP_START   "$"
	GNSS 5 response buffer commands.
#define	GNSS5_RSP_DELIMITER   ","
#define	GNSS5_RSP_END_SEQ   "\r\n"
#define	GNSS5_RSP_GNGGA   "$GNGGA"
#define	GNSS5_GNGGA_ELEMENT_SIZE   15
	GNSS 5 GNGGA command elements.
#define	GNSS5_GNGGA_TIME   1
#define	GNSS5_GNGGA_LATITUDE   2
#define	GNSS5_GNGGA_LATITUDE_SIDE   3
#define	GNSS5_GNGGA_LONGITUDE   4
#define	GNSS5_GNGGA_LONGITUDE_SIDE   5
#define	GNSS5_GNGGA_QUALITY_INDICATOR   6
#define	GNSS5_GNGGA_NUMBER_OF_SATELLITES   7
#define	GNSS5_GNGGA_H_DILUTION_OF_POS   8
#define	GNSS5_GNGGA_ALTITUDE   9
#define	GNSS5_GNGGA_ALTITUDE_UNIT   10
#define	GNSS5_GNGGA_GEOIDAL_SEPARATION   11
#define	GNSS5_GNGGA_GEOIDAL_SEPARATION_UNIT   12
#define	GNSS5_GNGGA_TIME_SINCE_LAST_DGPS   13
#define	GNSS5_GNGGA_DGPS_REFERENCE_STATION_ID   14
#define	GNSS5_DRV_TX_BUFFER_SIZE   100
	GNSS 5 driver buffer size.
#define	GNSS5_DRV_RX_BUFFER_SIZE   1000
#define	GNSS5_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	gnss5_return_value_t { GNSS5_OK = 0 , GNSS5_ERROR = -1 }
	GNSS 5 Click return value data. More...

Functions
void	gnss5_cfg_setup (gnss5_cfg_t *cfg)
	GNSS 5 configuration object setup function.
err_t	gnss5_init (gnss5_t *ctx, gnss5_cfg_t *cfg)
	GNSS 5 initialization function.
err_t	gnss5_generic_write (gnss5_t *ctx, char *data_in, uint16_t len)
	GNSS 5 data writing function.
err_t	gnss5_generic_read (gnss5_t *ctx, char *data_out, uint16_t len)
	GNSS 5 data reading function.
void	gnss5_clear_ring_buffers (gnss5_t *ctx)
	GNSS 5 clear ring buffers function.
void	gnss5_set_rst_pin (gnss5_t *ctx, uint8_t state)
	GNSS 5 set RST pin function.
uint8_t	gnss5_get_exi_pin (gnss5_t *ctx)
	GNSS 5 get EXI pin function.
uint8_t	gnss5_get_pps_pin (gnss5_t *ctx)
	GNSS 5 get PPS pin function.
err_t	gnss5_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
	GNSS 5 parse GNGGA function.

Detailed Description

This file contains API for GNSS 5 Click Driver.

Enumeration Type Documentation

gnss5_return_value_t

enum gnss5_return_value_t

GNSS 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSS5_OK
GNSS5_ERROR