Adafruit_GNSS.h

Go to the documentation of this file.

/**************************************************************************/
/**************************************************************************/

#ifndef ADAFRUIT_GNSS_H
#define ADAFRUIT_GNSS_H

#include "Adafruit_NMEA.h"

#define GNSS_COORDINATE_TEXT_SIZE 17

typedef struct {
  nmea_number_status_t status; 
  int32_t degreesE7; 
  uint16_t degrees;  
  uint8_t minutes;   
  uint32_t fractionalMinutes; 
  char hemisphere;            
} gnss_coordinate_t;

typedef struct {
  nmea_number_status_t status; 
  uint8_t hour;                
  uint8_t minute;              
  uint8_t second;              
  uint16_t millisecond; 
} gnss_time_t;

typedef struct {
  nmea_number_status_t status; 
  uint8_t day;                 
  uint8_t month;               
  uint8_t year;                
} gnss_date_t;

typedef enum : uint8_t {
  GNSS_SENTENCE_VALID,          
  GNSS_SENTENCE_UNSUPPORTED,    
  GNSS_SENTENCE_MISSING_FIELDS, 
  GNSS_SENTENCE_INVALID_FIELD,  
  GNSS_SENTENCE_INVALID_FRAME   
} gnss_sentence_status_t;

typedef struct {
  gnss_sentence_status_t status; 
  uint8_t field; 
} gnss_validation_t;

typedef struct {
  gnss_validation_t validation; 
  gnss_coordinate_t latitude;   
  gnss_coordinate_t longitude;  
  gnss_time_t time;             
  gnss_date_t date; 
  nmea_number_status_t fixStatus;        
  bool fix;                              
  nmea_number_status_t fixQualityStatus; 
  uint8_t fixQuality; 
} gnss_position_t;

class Adafruit_GNSS : public Adafruit_NMEA {
public:
  Adafruit_GNSS(volatile char *firstBuffer = NULL,
                volatile char *secondBuffer = NULL, size_t capacity = 0);
  gnss_position_t lastPosition() const;
  static gnss_coordinate_t parseCoordinate(nmea_span_t coordinate,
                                           nmea_span_t hemisphere);
  static size_t formatCoordinate(char *output, size_t capacity,
                                 const gnss_coordinate_t &coordinate);
  static gnss_position_t parsePosition(nmea_span_t type, nmea_span_t fields);
  static gnss_position_t parsePosition(const nmea_sentence_t &sentence);
  static gnss_time_t parseTime(nmea_span_t field);
  static gnss_date_t parseDate(nmea_span_t field);
  static gnss_validation_t validateNavigation(nmea_span_t type,
                                              nmea_span_t fields);

private:
  static uint8_t sentenceType(nmea_span_t type);
  static gnss_validation_t decodeNavigation(uint8_t sentence,
                                            nmea_span_t fields,
                                            gnss_position_t *position);
  enum {
    UNSUPPORTED, 
    GGA,         
    RMC,         
    GLL,         
    GSA          
  };
};

#endif // ADAFRUIT_GNSS_H