gnssrtk4 2.2.0
Loading...
Searching...
No Matches
gnssrtk4.h File Reference

This file contains API for GNSS RTK 4 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  gnssrtk4_t
 GNSS RTK 4 Click context object. More...
struct  gnssrtk4_cfg_t
 GNSS RTK 4 Click configuration object. More...

Macros

#define GNSSRTK4_RSP_START   "$"
 GNSS RTK 4 response buffer commands.
#define GNSSRTK4_RSP_DELIMITER   ","
#define GNSSRTK4_RSP_END   "\r\n"
#define GNSSRTK4_RSP_GGA   "GGA"
#define GNSSRTK4_GGA_ELEMENT_SIZE   15
 GNSS RTK 4 GGA command elements.
#define GNSSRTK4_GGA_TIME   1
#define GNSSRTK4_GGA_LATITUDE   2
#define GNSSRTK4_GGA_LATITUDE_SIDE   3
#define GNSSRTK4_GGA_LONGITUDE   4
#define GNSSRTK4_GGA_LONGITUDE_SIDE   5
#define GNSSRTK4_GGA_QUALITY_INDICATOR   6
#define GNSSRTK4_GGA_NUMBER_OF_SATELLITES   7
#define GNSSRTK4_GGA_H_DILUTION_OF_POS   8
#define GNSSRTK4_GGA_ALTITUDE   9
#define GNSSRTK4_GGA_ALTITUDE_UNIT   10
#define GNSSRTK4_GGA_GEOIDAL_SEPARATION   11
#define GNSSRTK4_GGA_GEOIDAL_SEPARATION_UNIT   12
#define GNSSRTK4_GGA_TIME_SINCE_LAST_DGPS   13
#define GNSSRTK4_GGA_DGPS_REFERENCE_STATION_ID   14
#define GNSSRTK4_TX_DRV_BUFFER_SIZE   100
 GNSS RTK 4 driver buffer size.
#define GNSSRTK4_RX_DRV_BUFFER_SIZE   1000
#define GNSSRTK4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  gnssrtk4_return_value_t { GNSSRTK4_OK = 0 , GNSSRTK4_ERROR = -1 }
 GNSS RTK 4 Click return value data. More...

Functions

void gnssrtk4_cfg_setup (gnssrtk4_cfg_t *cfg)
 GNSS RTK 4 configuration object setup function.
err_t gnssrtk4_init (gnssrtk4_t *ctx, gnssrtk4_cfg_t *cfg)
 GNSS RTK 4 initialization function.
err_t gnssrtk4_generic_write (gnssrtk4_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS RTK 4 data writing function.
err_t gnssrtk4_generic_read (gnssrtk4_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS RTK 4 data reading function.
void gnssrtk4_set_rst_pin (gnssrtk4_t *ctx, uint8_t state)
 GNSS RTK 4 set RST pin function.
void gnssrtk4_set_evt_pin (gnssrtk4_t *ctx, uint8_t state)
 GNSS RTK 4 set EVT pin function.
uint8_t gnssrtk4_get_sta_pin (gnssrtk4_t *ctx)
 GNSS RTK 4 get STA pin function.
uint8_t gnssrtk4_get_pps_pin (gnssrtk4_t *ctx)
 GNSS RTK 4 get PPS pin function.
void gnssrtk4_reset_device (gnssrtk4_t *ctx)
 GNSS RTK 4 reset device function.
err_t gnssrtk4_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS RTK 4 parse GGA function.

Detailed Description

This file contains API for GNSS RTK 4 Click Driver.

Enumeration Type Documentation

◆ gnssrtk4_return_value_t

GNSS RTK 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSSRTK4_OK 
GNSSRTK4_ERROR