gnssrtk  2.0.0.0
Data Structures | Macros | Typedefs | Functions
gnssrtk.h File Reference

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

Macros

#define GNSSRTK_GNGGA_TIME   1
 GNGGA elements. More...
 
#define GNSSRTK_GNGGA_LATITUDE   2
 
#define GNSSRTK_GNGGA_LATITUDE_SIDE   3
 
#define GNSSRTK_GNGGA_LONGITUDE   4
 
#define GNSSRTK_GNGGA_LONGITUDE_SIDE   5
 
#define GNSSRTK_GNGGA_QUALITY_INDICATOR   6
 
#define GNSSRTK_GNGGA_NUMBER_OF_SATELLITES   7
 
#define GNSSRTK_GNGGA_H_DILUTION_OF_POS   8
 
#define GNSSRTK_GNGGA_ALTITUDE   9
 
#define GNSSRTK_GNGGA_ALTITUDE_UNIT   10
 
#define GNSSRTK_GNGGA_GEOIDAL_SEPARATION   11
 
#define GNSSRTK_GNGGA_GEOIDAL_SEPARATION_UNIT   12
 
#define GNSSRTK_GNGGA_TIME_SINCE_LAST_DGPS   13
 
#define GNSSRTK_GNGGA_DGPS_REFERENCE_STATION_ID   14
 
#define GNSSRTK_GNGLL_LATITUDE   1
 GNGLL elements. More...
 
#define GNSSRTK_GNGLL_LATITUDE_SIDE   2
 
#define GNSSRTK_GNGLL_LONGITUDE   3
 
#define GNSSRTK_GNGLL_LONGITUDE_SIDE   4
 
#define GNSSRTK_ERROR_COMMAND_OR_ELEMENT   0xFF
 GNSS RTK error code. More...
 
#define GNSSRTK_ERROR_START_OR_END_COMMAND   0x8F
 
#define GNSSRTK_ERROR_NEXT_ELEMENT   0x4F
 
#define GNSSRTK_ERROR_CURRENT_ELEMENT   0x2F
 
#define GNSSRTK_NO_ERROR   0x00
 
#define GNSSRTK_NMEA_GNGGA   1
 GNSS RTK support command. More...
 
#define GNSSRTK_NMEA_GNGLL   3
 
#define DRV_BUFFER_SIZE_RX   200
 GNSS RTK driver buffer size. More...
 
#define DRV_BUFFER_SIZE_TX   50
 
#define GNSSRTK_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Typedefs

typedef uint8_t gnssrtk_error_t
 Error type. More...
 

Functions

void gnssrtk_cfg_setup (gnssrtk_cfg_t *cfg)
 GNSS RTK configuration object setup function. More...
 
err_t gnssrtk_init (gnssrtk_t *ctx, gnssrtk_cfg_t *cfg)
 GNSS RTK initialization function. More...
 
void gnssrtk_default_cfg (gnssrtk_t *ctx)
 GNSS RTK default configuration function. More...
 
void gnssrtk_module_cold_start (gnssrtk_t *ctx)
 Module cold start function. More...
 
void gnssrtk_set_rst_pin (gnssrtk_t *ctx, uint8_t state)
 Set rst pin function. More...
 
uint8_t gnssrtk_get_rdy_pin (gnssrtk_t *ctx)
 Check rdy pin function. More...
 
uint8_t gnssrtk_get_rtk_pin (gnssrtk_t *ctx)
 Check rtk pin function. More...
 
uint8_t gnssrtk_get_tmp_pin (gnssrtk_t *ctx)
 Check tmp pin function. More...
 
err_t gnssrtk_generic_write (gnssrtk_t *ctx, char *data_buf, uint16_t len)
 GNSS RTK data writing function. More...
 
err_t gnssrtk_generic_read (gnssrtk_t *ctx, char *data_buf, uint16_t max_len)
 GNSS RTK data reading function. More...
 
gnssrtk_error_t gnssrtk_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function. More...
 

Detailed Description

This file contains API for GNSS RTK Click Driver.

Typedef Documentation

◆ gnssrtk_error_t

typedef uint8_t gnssrtk_error_t

Error type.