gps5  2.0.0.0
Data Structures | Macros | Enumerations | Functions
gps5.h File Reference

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

#include "mikrosdk_version.h"
#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  gps5_t
 GPS 5 Click context object. More...
 
struct  gps5_cfg_t
 GPS 5 Click configuration object. More...
 

Macros

#define GPS5_RSP_START   "$"
 GPS 5 response buffer commands. More...
 
#define GPS5_RSP_DELIMITER   ","
 
#define GPS5_RSP_GNGGA   "$GNGGA"
 
#define GPS5_GNGGA_ELEMENT_SIZE   15
 GPS 5 GNGGA command elements. More...
 
#define GPS5_GNGGA_TIME   1
 
#define GPS5_GNGGA_LATITUDE   2
 
#define GPS5_GNGGA_LATITUDE_SIDE   3
 
#define GPS5_GNGGA_LONGITUDE   4
 
#define GPS5_GNGGA_LONGITUDE_SIDE   5
 
#define GPS5_GNGGA_QUALITY_INDICATOR   6
 
#define GPS5_GNGGA_NUMBER_OF_SATELLITES   7
 
#define GPS5_GNGGA_H_DILUTION_OF_POS   8
 
#define GPS5_GNGGA_ALTITUDE   9
 
#define GPS5_GNGGA_ALTITUDE_UNIT   10
 
#define GPS5_GNGGA_GEOIDAL_SEPARATION   11
 
#define GPS5_GNGGA_GEOIDAL_SEPARATION_UNIT   12
 
#define GPS5_GNGGA_TIME_SINCE_LAST_DGPS   13
 
#define GPS5_GNGGA_DGPS_REFERENCE_STATION_ID   14
 
#define DRV_RX_BUFFER_SIZE   300
 GPS 5 driver buffer size. More...
 
#define DRV_TX_BUFFER_SIZE   100
 
#define GPS5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  gps5_return_value_t { GPS5_OK = 0, GPS5_ERROR = -1 }
 GPS 5 Click return value data. More...
 

Functions

void gps5_cfg_setup (gps5_cfg_t *cfg)
 GPS 5 configuration object setup function. More...
 
err_t gps5_init (gps5_t *ctx, gps5_cfg_t *cfg)
 GPS 5 initialization function. More...
 
err_t gps5_generic_write (gps5_t *ctx, char *data_buf, uint16_t len)
 GPS 5 data writing function. More...
 
err_t gps5_generic_read (gps5_t *ctx, char *data_buf, uint16_t max_len)
 GPS 5 data reading function. More...
 
void gps5_set_rst_pin (gps5_t *ctx, uint8_t state)
 GPS 5 set RST pin function. More...
 
void gps5_set_stb_pin (gps5_t *ctx, uint8_t state)
 GPS 5 set STB pin function. More...
 
void gps5_set_en_pin (gps5_t *ctx, uint8_t state)
 GPS 5 set EN pin function. More...
 
err_t gps5_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
 GPS 5 parse GNGGA function. More...
 

Detailed Description

This file contains API for GPS 5 Click Driver.

Enumeration Type Documentation

◆ gps5_return_value_t

GPS 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
GPS5_OK 
GPS5_ERROR