gnssrtk5 2.2.1
Loading...
Searching...
No Matches
gnssrtk5.h File Reference

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

Macros

#define GNSSRTK5_CMD_GET_VERSION   "VERSION"
 GNSS RTK 5 commands string.
#define GNSSRTK5_CMD_GET_CONFIG   "CONFIG"
#define GNSSRTK5_CMD_ENABLE_GGA   "GNGGA 1"
#define GNSSRTK5_RSP_RESET   "$devicename"
 GNSS RTK 5 response buffer commands.
#define GNSSRTK5_RSP_COMMAND   "$command"
#define GNSSRTK5_RSP_START   "$"
#define GNSSRTK5_RSP_DELIMITER   ","
#define GNSSRTK5_RSP_END   "\r\n"
#define GNSSRTK5_RSP_GGA   "GGA"
#define GNSSRTK5_GGA_ELEMENT_SIZE   15
 GNSS RTK 5 GGA command elements.
#define GNSSRTK5_GGA_TIME   1
#define GNSSRTK5_GGA_LATITUDE   2
#define GNSSRTK5_GGA_LATITUDE_SIDE   3
#define GNSSRTK5_GGA_LONGITUDE   4
#define GNSSRTK5_GGA_LONGITUDE_SIDE   5
#define GNSSRTK5_GGA_QUALITY_INDICATOR   6
#define GNSSRTK5_GGA_NUMBER_OF_SATELLITES   7
#define GNSSRTK5_GGA_H_DILUTION_OF_POS   8
#define GNSSRTK5_GGA_ALTITUDE   9
#define GNSSRTK5_GGA_ALTITUDE_UNIT   10
#define GNSSRTK5_GGA_GEOIDAL_SEPARATION   11
#define GNSSRTK5_GGA_GEOIDAL_SEPARATION_UNIT   12
#define GNSSRTK5_GGA_TIME_SINCE_LAST_DGPS   13
#define GNSSRTK5_GGA_DGPS_REFERENCE_STATION_ID   14
#define GNSSRTK5_TX_DRV_BUFFER_SIZE   100
 GNSS RTK 5 driver buffer size.
#define GNSSRTK5_RX_DRV_BUFFER_SIZE   800
#define GNSSRTK5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  gnssrtk5_return_value_t { GNSSRTK5_OK = 0 , GNSSRTK5_ERROR = -1 , GNSSRTK5_ERROR_TIMEOUT = -2 }
 GNSS RTK 5 Click return value data. More...

Functions

void gnssrtk5_cfg_setup (gnssrtk5_cfg_t *cfg)
 GNSS RTK 5 configuration object setup function.
err_t gnssrtk5_init (gnssrtk5_t *ctx, gnssrtk5_cfg_t *cfg)
 GNSS RTK 5 initialization function.
err_t gnssrtk5_generic_write (gnssrtk5_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS RTK 5 data writing function.
err_t gnssrtk5_generic_read (gnssrtk5_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS RTK 5 data reading function.
void gnssrtk5_set_rst_pin (gnssrtk5_t *ctx, uint8_t state)
 GNSS RTK 5 set RST pin function.
void gnssrtk5_reset_device (gnssrtk5_t *ctx)
 GNSS RTK 5 reset device function.
void gnssrtk5_set_evt_pin (gnssrtk5_t *ctx, uint8_t state)
 GNSS RTK 5 set EVT pin function.
uint8_t gnssrtk5_get_pvt_pin (gnssrtk5_t *ctx)
 GNSS RTK 5 get PVT pin function.
uint8_t gnssrtk5_get_err_pin (gnssrtk5_t *ctx)
 GNSS RTK 5 get ERR pin function.
err_t gnssrtk5_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS RTK 5 parse GGA function.
void gnssrtk5_cmd_run (gnssrtk5_t *ctx, uint8_t *cmd)
 GNSS RTK 5 cmd run function.

Detailed Description

This file contains API for GNSS RTK 5 Click Driver.

Enumeration Type Documentation

◆ gnssrtk5_return_value_t

GNSS RTK 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSSRTK5_OK 
GNSSRTK5_ERROR 
GNSSRTK5_ERROR_TIMEOUT