gnss17  2.1.0.0
Data Structures | Macros | Enumerations | Functions
gnss17.h File Reference

This file contains API for GNSS 17 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  gnss17_t
 GNSS 17 Click context object. More...
 
struct  gnss17_cfg_t
 GNSS 17 Click configuration object. More...
 

Macros

#define GNSS17_RSP_START   "$"
 GNSS 17 response buffer commands. More...
 
#define GNSS17_RSP_DELIMITER   ","
 
#define GNSS17_RSP_END   "\r\n"
 
#define GNSS17_RSP_GGA   "GGA"
 
#define GNSS17_GGA_ELEMENT_SIZE   15
 GNSS 17 GGA command elements. More...
 
#define GNSS17_GGA_TIME   1
 
#define GNSS17_GGA_LATITUDE   2
 
#define GNSS17_GGA_LATITUDE_SIDE   3
 
#define GNSS17_GGA_LONGITUDE   4
 
#define GNSS17_GGA_LONGITUDE_SIDE   5
 
#define GNSS17_GGA_QUALITY_INDICATOR   6
 
#define GNSS17_GGA_NUMBER_OF_SATELLITES   7
 
#define GNSS17_GGA_H_DILUTION_OF_POS   8
 
#define GNSS17_GGA_ALTITUDE   9
 
#define GNSS17_GGA_ALTITUDE_UNIT   10
 
#define GNSS17_GGA_GEOIDAL_SEPARATION   11
 
#define GNSS17_GGA_GEOIDAL_SEPARATION_UNIT   12
 
#define GNSS17_GGA_TIME_SINCE_LAST_DGPS   13
 
#define GNSS17_GGA_DGPS_REFERENCE_STATION_ID   14
 
#define GNSS17_TX_DRV_BUFFER_SIZE   100
 GNSS 17 driver buffer size. More...
 
#define GNSS17_RX_DRV_BUFFER_SIZE   1000
 
#define GNSS17_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  gnss17_return_value_t { GNSS17_OK = 0, GNSS17_ERROR = -1 }
 GNSS 17 Click return value data. More...
 

Functions

void gnss17_cfg_setup (gnss17_cfg_t *cfg)
 GNSS 17 configuration object setup function. More...
 
err_t gnss17_init (gnss17_t *ctx, gnss17_cfg_t *cfg)
 GNSS 17 initialization function. More...
 
err_t gnss17_generic_write (gnss17_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS 17 data writing function. More...
 
err_t gnss17_generic_read (gnss17_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS 17 data reading function. More...
 
void gnss17_set_en_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set EN pin function. More...
 
void gnss17_set_aon_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set AON pin function. More...
 
void gnss17_set_rts_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set RTS pin function. More...
 
void gnss17_set_rtc_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set RTC pin function. More...
 
void gnss17_reset_device (gnss17_t *ctx)
 GNSS 17 reset device function. More...
 
err_t gnss17_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS 17 parse GGA function. More...
 

Detailed Description

This file contains API for GNSS 17 Click Driver.

Enumeration Type Documentation

◆ gnss17_return_value_t

GNSS 17 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSS17_OK 
GNSS17_ERROR