irnss.h File Reference

This file contains API for IRNSS 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	irnss_t
	IRNSS Click context object. More...
struct	irnss_cfg_t
	IRNSS Click configuration object. More...

Macros
#define	IRNSS_RSP_START   "$"
	IRNSS response buffer commands.
#define	IRNSS_RSP_DELIMITER   ","
#define	IRNSS_RSP_GNGGA   "$GNGGA"
#define	IRNSS_GNGGA_ELEMENT_SIZE   15
	IRNSS GNGGA command elements.
#define	IRNSS_GNGGA_TIME   1
#define	IRNSS_GNGGA_LATITUDE   2
#define	IRNSS_GNGGA_LATITUDE_SIDE   3
#define	IRNSS_GNGGA_LONGITUDE   4
#define	IRNSS_GNGGA_LONGITUDE_SIDE   5
#define	IRNSS_GNGGA_QUALITY_INDICATOR   6
#define	IRNSS_GNGGA_NUMBER_OF_SATELLITES   7
#define	IRNSS_GNGGA_H_DILUTION_OF_POS   8
#define	IRNSS_GNGGA_ALTITUDE   9
#define	IRNSS_GNGGA_ALTITUDE_UNIT   10
#define	IRNSS_GNGGA_GEOIDAL_SEPARATION   11
#define	IRNSS_GNGGA_GEOIDAL_SEPARATION_UNIT   12
#define	IRNSS_GNGGA_TIME_SINCE_LAST_DGPS   13
#define	IRNSS_GNGGA_DGPS_REFERENCE_STATION_ID   14
#define	DRV_RX_BUFFER_SIZE   300
	IRNSS driver buffer size.
#define	DRV_TX_BUFFER_SIZE   100
#define	IRNSS_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	irnss_return_value_t { IRNSS_OK = 0 , IRNSS_ERROR = -1 }
	IRNSS Click return value data. More...

Functions
void	irnss_cfg_setup (irnss_cfg_t *cfg)
	IRNSS configuration object setup function.
err_t	irnss_init (irnss_t *ctx, irnss_cfg_t *cfg)
	IRNSS initialization function.
err_t	irnss_generic_write (irnss_t *ctx, char *data_buf, uint16_t len)
	IRNSS data writing function.
err_t	irnss_generic_read (irnss_t *ctx, char *data_buf, uint16_t max_len)
	IRNSS data reading function.
void	irnss_set_rst_pin_state (irnss_t *ctx, uint8_t state)
	Sets state of the rst pin setting.
void	irnss_set_wkp_pin_state (irnss_t *ctx, uint8_t state)
	Sets state of the wkp pin setting.
err_t	irnss_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
	IRNSS parse GNGGA function.

Detailed Description

This file contains API for IRNSS Click Driver.

Enumeration Type Documentation

irnss_return_value_t

enum irnss_return_value_t

IRNSS Click return value data.

Predefined enum values for driver return values.

Enumerator
IRNSS_OK
IRNSS_ERROR