nanogps2 2.0.0.0
nanogps2.h File Reference

This file contains API for Nano GPS 2 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  nanogps2_t
 Click ctx object definition. More...
 
struct  nanogps2_cfg_t
 Click configuration structure definition. More...
 

Macros

#define NANOGPS2_MAP_MIKROBUS(cfg, mikrobus)
 
#define NANOGPS2_RETVAL   uint8_t
 
#define NANOGPS2_OK   0x00
 
#define NANOGPS2_INIT_ERROR   0xFF
 
#define NANOGPS2_NEMA_GNGGA   1
 
#define NANOGPS2_NEMA_GPGLL   3
 
#define NANOGPS2_NEMA_GNGGA_NUM_ELEMENT   15
 
#define NANOGPS2_NEMA_GPGLL_NUM_ELEMENT   5
 
#define NANOGPS2_GNGGA_TIME   1
 
#define NANOGPS2_GNGGA_LATITUDE   2
 
#define NANOGPS2_GNGGA_LATITUDE_SIDE   3
 
#define NANOGPS2_GNGGA_LONGITUDE   4
 
#define NANOGPS2_GNGGA_LONGITUDE_SIDE   5
 
#define NANOGPS2_GNGGA_QUALITY_INDICATOR   6
 
#define NANOGPS2_GNGGA_NUMBER_OF_SATELLITES   7
 
#define NANOGPS2_GNGGA_H_DILUTION_OF_POS   8
 
#define NANOGPS2_GNGGA_ALTITUDE   9
 
#define NANOGPS2_GNGGA_ALTITUDE_UNIT   10
 
#define NANOGPS2_GNGGA_GEOIDAL_SEPARATION   11
 
#define NANOGPS2_GNGGA_GEOIDAL_SEPARATION_UNIT   12
 
#define NANOGPS2_GNGGA_TIME_SINCE_LAST_DGPS   13
 
#define NANOGPS2_GNGGA_DGPS_REFERENCE_STATION_ID   14
 
#define NANOGPS2_GPGLL_LATITUDE   1
 
#define NANOGPS2_GPGLL_LATITUDE_SIDE   2
 
#define NANOGPS2_GPGLL_LONGITUDE   3
 
#define NANOGPS2_GPGLL_LONGITUDE_SIDE   4
 
#define NANOGPS2_ERROR_COMMAND_OR_ELEMENT   0xFF
 
#define NANOGPS2_ERROR_START_OR_END_COMMAND   0x8F
 
#define NANOGPS2_ERROR_NEXT_ELEMENT   0x4F
 
#define NANOGPS2_ERROR_CURRENT_ELEMENT   0x2F
 
#define NANOGPS2_NO_ERROR   0x00
 
#define DRV_RX_BUFFER_SIZE   600
 
#define DRV_TX_BUFFER_SIZE   50
 

Typedefs

typedef uint8_t nanogps2_error_t
 Error type.
 

Functions

void nanogps2_cfg_setup (nanogps2_cfg_t *cfg)
 Config Object Initialization function.
 
NANOGPS2_RETVAL nanogps2_init (nanogps2_t *ctx, nanogps2_cfg_t *cfg)
 Initialization function.
 
void nanogps2_module_wakeup (nanogps2_t *ctx)
 Wake-up module.
 
void nanogps2_set_fon_pin_state (nanogps2_t *ctx, uint8_t state)
 Generic function for setting fon pin status.
 
void nanogps2_set_cts_pin_state (nanogps2_t *ctx, uint8_t state)
 Generic function for setting cts pin status.
 
uint8_t nanogps2_get_wkp_pin (nanogps2_t *ctx)
 Get WKP pin state.
 
uint8_t nanogps2_get_rts_pin (nanogps2_t *ctx)
 Get RTS pin state.
 
void nanogps2_set_en_pin_state (nanogps2_t *ctx, uint8_t state)
 Generic function for setting en pin status.
 
void nanogps2_generic_write (nanogps2_t *ctx, char *data_buf, uint16_t len)
 Generic write function.
 
int32_t nanogps2_generic_read (nanogps2_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function.
 
nanogps2_error_t nanogps2_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function.
 

Detailed Description

This file contains API for Nano GPS 2 Click driver.