gnssmax2  2.1.0.0
Data Structures | Macros | Typedefs | Enumerations | Functions
gnssmax2.h File Reference

This file contains API for GNSS MAX 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  gnssmax2_s
 GNSS MAX 2 Click context object. More...
 
struct  gnssmax2_cfg_t
 GNSS MAX 2 Click configuration object. More...
 

Macros

#define GNSSMAX2_RSP_START   "$"
 GNSS MAX 2 response buffer commands. More...
 
#define GNSSMAX2_RSP_DELIMITER   ","
 
#define GNSSMAX2_RSP_END   "\r\n"
 
#define GNSSMAX2_RSP_GGA   "GGA"
 
#define GNSSMAX2_GGA_ELEMENT_SIZE   15
 GNSS MAX 2 GGA command elements. More...
 
#define GNSSMAX2_GGA_TIME   1
 
#define GNSSMAX2_GGA_LATITUDE   2
 
#define GNSSMAX2_GGA_LATITUDE_SIDE   3
 
#define GNSSMAX2_GGA_LONGITUDE   4
 
#define GNSSMAX2_GGA_LONGITUDE_SIDE   5
 
#define GNSSMAX2_GGA_QUALITY_INDICATOR   6
 
#define GNSSMAX2_GGA_NUMBER_OF_SATELLITES   7
 
#define GNSSMAX2_GGA_H_DILUTION_OF_POS   8
 
#define GNSSMAX2_GGA_ALTITUDE   9
 
#define GNSSMAX2_GGA_ALTITUDE_UNIT   10
 
#define GNSSMAX2_GGA_GEOIDAL_SEPARATION   11
 
#define GNSSMAX2_GGA_GEOIDAL_SEPARATION_UNIT   12
 
#define GNSSMAX2_GGA_TIME_SINCE_LAST_DGPS   13
 
#define GNSSMAX2_GGA_DGPS_REFERENCE_STATION_ID   14
 
#define GNSSMAX2_DUMMY   0xFF
 GNSS MAX 2 dummy data. More...
 
#define GNSSMAX2_TX_DRV_BUFFER_SIZE   100
 GNSS MAX 2 driver buffer size. More...
 
#define GNSSMAX2_RX_DRV_BUFFER_SIZE   1000
 
#define GNSSMAX2_DEVICE_ADDRESS   0x42
 GNSS MAX 2 device address setting. More...
 
#define GNSSMAX2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Typedefs

typedef err_t(* gnssmax2_master_io_t) (struct gnssmax2_s *, uint8_t *, uint16_t)
 
typedef struct gnssmax2_s gnssmax2_t
 GNSS MAX 2 Click context object. More...
 

Enumerations

enum  gnssmax2_drv_t { GNSSMAX2_DRV_SEL_UART, GNSSMAX2_DRV_SEL_I2C }
 GNSS MAX 2 Click driver selector. More...
 
enum  gnssmax2_return_value_t { GNSSMAX2_OK = 0, GNSSMAX2_ERROR = -1 }
 GNSS MAX 2 Click return value data. More...
 

Functions

void gnssmax2_cfg_setup (gnssmax2_cfg_t *cfg)
 GNSS MAX 2 configuration object setup function. More...
 
void gnssmax2_drv_interface_sel (gnssmax2_cfg_t *cfg, gnssmax2_drv_t drv_sel)
 GNSS MAX 2 driver interface setup function. More...
 
err_t gnssmax2_init (gnssmax2_t *ctx, gnssmax2_cfg_t *cfg)
 GNSS MAX 2 initialization function. More...
 
err_t gnssmax2_generic_write (gnssmax2_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS MAX 2 data writing function. More...
 
err_t gnssmax2_generic_read (gnssmax2_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS MAX 2 data reading function. More...
 
uint8_t gnssmax2_get_pps_pin (gnssmax2_t *ctx)
 GNSS MAX 2 get PPS pin function. More...
 
void gnssmax2_set_exi_pin (gnssmax2_t *ctx, uint8_t state)
 GNSS MAX 2 set EXI pin function. More...
 
void gnssmax2_set_rst_pin (gnssmax2_t *ctx, uint8_t state)
 GNSS MAX 2 set RST pin function. More...
 
void gnssmax2_reset_device (gnssmax2_t *ctx)
 GNSS MAX 2 reset device function. More...
 
err_t gnssmax2_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS MAX 2 parse GGA function. More...
 

Detailed Description

This file contains API for GNSS MAX 2 Click Driver.

Typedef Documentation

◆ gnssmax2_master_io_t

typedef err_t( * gnssmax2_master_io_t) (struct gnssmax2_s *, uint8_t *, uint16_t)

Driver serial interface.

◆ gnssmax2_t

typedef struct gnssmax2_s gnssmax2_t

GNSS MAX 2 Click context object.

Context object definition of GNSS MAX 2 Click driver.

Enumeration Type Documentation

◆ gnssmax2_drv_t

GNSS MAX 2 Click driver selector.

Selects target driver interface of GNSS MAX 2 Click driver.

Enumerator
GNSSMAX2_DRV_SEL_UART 

UART driver descriptor.

GNSSMAX2_DRV_SEL_I2C 

I2C driver descriptor.

◆ gnssmax2_return_value_t

GNSS MAX 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSSMAX2_OK 
GNSSMAX2_ERROR