rtkrover.h File Reference

This file contains API for RTK Rover 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	rtkrover_t
	RTK Rover Click context object. More...
struct	rtkrover_cfg_t
	RTK Rover Click configuration object. More...

Macros
#define	RTKROVER_RSP_START   "$"
	RTK Rover response buffer commands.
#define	RTKROVER_RSP_DELIMITER   ","
#define	RTKROVER_RSP_END_SEQ   "\r\n"
#define	RTKROVER_RSP_GNGGA   "$GNGGA"
#define	RTKROVER_GNGGA_ELEMENT_SIZE   15
	RTK Rover GNGGA command elements.
#define	RTKROVER_GNGGA_TIME   1
#define	RTKROVER_GNGGA_LATITUDE   2
#define	RTKROVER_GNGGA_LATITUDE_SIDE   3
#define	RTKROVER_GNGGA_LONGITUDE   4
#define	RTKROVER_GNGGA_LONGITUDE_SIDE   5
#define	RTKROVER_GNGGA_QUALITY_INDICATOR   6
#define	RTKROVER_GNGGA_NUMBER_OF_SATELLITES   7
#define	RTKROVER_GNGGA_H_DILUTION_OF_POS   8
#define	RTKROVER_GNGGA_ALTITUDE   9
#define	RTKROVER_GNGGA_ALTITUDE_UNIT   10
#define	RTKROVER_GNGGA_GEOIDAL_SEPARATION   11
#define	RTKROVER_GNGGA_GEOIDAL_SEPARATION_UNIT   12
#define	RTKROVER_GNGGA_TIME_SINCE_LAST_DGPS   13
#define	RTKROVER_GNGGA_DGPS_REFERENCE_STATION_ID   14
#define	DRV_TX_BUFFER_SIZE   100
	RTK Rover driver buffer size.
#define	DRV_RX_BUFFER_SIZE   1000
#define	RTKROVER_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	rtkrover_return_value_t { RTKROVER_OK = 0 , RTKROVER_ERROR = -1 }
	RTK Rover Click return value data. More...

Functions
void	rtkrover_cfg_setup (rtkrover_cfg_t *cfg)
	RTK Rover configuration object setup function.
err_t	rtkrover_init (rtkrover_t *ctx, rtkrover_cfg_t *cfg)
	RTK Rover initialization function.
err_t	rtkrover_generic_write (rtkrover_t *ctx, char *data_in, uint16_t len)
	RTK Rover data writing function.
err_t	rtkrover_generic_read (rtkrover_t *ctx, char *data_out, uint16_t len)
	RTK Rover data reading function.
void	rtkrover_clear_ring_buffers (rtkrover_t *ctx)
	RTK Rover clear ring buffers function.
void	rtkrover_set_rst_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set RST pin function.
void	rtkrover_set_wup_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set WUP pin function.
void	rtkrover_set_boot_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set BOOT pin function.
void	rtkrover_set_shd_pin (rtkrover_t *ctx, uint8_t state)
	RTK Rover set SHD pin function.
uint8_t	rtkrover_get_int_pin (rtkrover_t *ctx)
	RTK Rover get INT pin function.
err_t	rtkrover_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
	RTK Rover parse GNGGA function.

Detailed Description

This file contains API for RTK Rover Click Driver.

Enumeration Type Documentation

rtkrover_return_value_t

enum rtkrover_return_value_t

RTK Rover Click return value data.

Predefined enum values for driver return values.

Enumerator
RTKROVER_OK
RTKROVER_ERROR