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

This file contains API for GNSS 21 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  gnss21_s
 GNSS 21 Click context object. More...
struct  gnss21_cfg_t
 GNSS 21 Click configuration object. More...

Macros

#define GNSS21_RSP_START   "$"
 GNSS 21 response buffer commands.
#define GNSS21_RSP_DELIMITER   ","
#define GNSS21_RSP_END   "\r\n"
#define GNSS21_RSP_GGA   "GGA"
#define GNSS21_RSP_NO_FIX   "0000.00000"
#define GNSS21_GGA_ELEMENT_SIZE   15
 GNSS 21 GGA command elements.
#define GNSS21_GGA_TIME   1
#define GNSS21_GGA_LATITUDE   2
#define GNSS21_GGA_LATITUDE_SIDE   3
#define GNSS21_GGA_LONGITUDE   4
#define GNSS21_GGA_LONGITUDE_SIDE   5
#define GNSS21_GGA_QUALITY_INDICATOR   6
#define GNSS21_GGA_NUMBER_OF_SATELLITES   7
#define GNSS21_GGA_H_DILUTION_OF_POS   8
#define GNSS21_GGA_ALTITUDE   9
#define GNSS21_GGA_ALTITUDE_UNIT   10
#define GNSS21_GGA_GEOIDAL_SEPARATION   11
#define GNSS21_GGA_GEOIDAL_SEPARATION_UNIT   12
#define GNSS21_GGA_TIME_SINCE_LAST_DGPS   13
#define GNSS21_GGA_DGPS_REFERENCE_STATION_ID   14
#define GNSS21_DUMMY   0xFF
 GNSS 21 dummy data.
#define GNSS21_TX_DRV_BUFFER_SIZE   100
 GNSS 21 driver buffer size.
#define GNSS21_RX_DRV_BUFFER_SIZE   1000
#define GNSS21_DEVICE_ADDRESS   0x3A
 GNSS 21 device address setting.
#define GNSS21_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Typedefs

typedef err_t(* gnss21_master_io_t) (struct gnss21_s *, uint8_t *, uint16_t)
typedef struct gnss21_s gnss21_t
 GNSS 21 Click context object.

Enumerations

enum  gnss21_drv_t { GNSS21_DRV_SEL_UART , GNSS21_DRV_SEL_I2C }
 GNSS 21 Click driver selector. More...
enum  gnss21_return_value_t { GNSS21_OK = 0 , GNSS21_ERROR = -1 }
 GNSS 21 Click return value data. More...

Functions

void gnss21_cfg_setup (gnss21_cfg_t *cfg)
 GNSS 21 configuration object setup function.
void gnss21_drv_interface_sel (gnss21_cfg_t *cfg, gnss21_drv_t drv_sel)
 GNSS 21 driver interface setup function.
err_t gnss21_init (gnss21_t *ctx, gnss21_cfg_t *cfg)
 GNSS 21 initialization function.
err_t gnss21_generic_write (gnss21_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS 21 data writing function.
err_t gnss21_generic_read (gnss21_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS 21 data reading function.
uint8_t gnss21_get_pps_pin (gnss21_t *ctx)
 GNSS 21 get PPS pin function.
void gnss21_set_rst_pin (gnss21_t *ctx, uint8_t state)
 GNSS 21 set RST pin function.
void gnss21_reset_device (gnss21_t *ctx)
 GNSS 21 reset device function.
err_t gnss21_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS 21 parse GGA function.

Detailed Description

This file contains API for GNSS 21 Click Driver.

Typedef Documentation

◆ gnss21_master_io_t

typedef err_t(* gnss21_master_io_t) (struct gnss21_s *, uint8_t *, uint16_t)

Driver serial interface.

◆ gnss21_t

typedef struct gnss21_s gnss21_t

GNSS 21 Click context object.

Context object definition of GNSS 21 Click driver.

Enumeration Type Documentation

◆ gnss21_drv_t

GNSS 21 Click driver selector.

Selects target driver interface of GNSS 21 Click driver.

Enumerator
GNSS21_DRV_SEL_UART 

UART driver descriptor.

GNSS21_DRV_SEL_I2C 

I2C driver descriptor.

◆ gnss21_return_value_t

GNSS 21 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSS21_OK 
GNSS21_ERROR