gnssmax 2.0.0.0
gnssmax.h File Reference

This file contains API for GNSS MAX 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  gnssmax_t
 GNSS MAX Click context object. More...
 
struct  gnssmax_cfg_t
 GNSS MAX Click configuration object. More...
 

Macros

#define DRV_BUFFER_SIZE_TX   100
 GNSS MAX driver buffer size.
 
#define DRV_BUFFER_SIZE_RX   700
 
#define GNSSMAX_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  gnssmax_return_value_t { GNSSMAX_OK = 0 , GNSSMAX_ERROR = -1 , GNSSMAX_ERROR_NO_DATA = -2 , GNSSMAX_ERROR_OVERFLOW = -3 }
 GNSS MAX Click return value data. More...
 

Functions

void gnssmax_cfg_setup (gnssmax_cfg_t *cfg)
 GNSS MAX configuration object setup function.
 
err_t gnssmax_init (gnssmax_t *ctx, gnssmax_cfg_t *cfg)
 GNSS MAX initialization function.
 
err_t gnssmax_default_cfg (gnssmax_t *ctx)
 GNSS MAX default configuration function.
 
err_t gnssmax_generic_write (gnssmax_t *ctx, char *data_buf, uint16_t len)
 GNSS MAX data writing function.
 
err_t gnssmax_generic_read (gnssmax_t *ctx, char *data_buf, uint16_t max_len)
 GNSS MAX data reading function.
 
void gnssmax_reset (gnssmax_t *ctx)
 GNSS MAX reset function.
 
void gnssmax_set_external_interrupt (gnssmax_t *ctx, uint8_t state)
 GNSS MAX sets state of external interrupt.
 
uint8_t gnssmax_get_pps (gnssmax_t *ctx)
 GNSS MAX reads timestamp pin state.
 

Detailed Description

This file contains API for GNSS MAX Click Driver.

Enumeration Type Documentation

◆ gnssmax_return_value_t

GNSS MAX Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSSMAX_OK 
GNSSMAX_ERROR 
GNSSMAX_ERROR_NO_DATA 
GNSSMAX_ERROR_OVERFLOW