Cansat
/
esp32_Adafruit_GPS
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen comments added

This commit is contained in:
Rick Sellens 2020-01-08 13:08:10 -05:00
parent eec5282c19
commit 11c02f691b
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
Adafruit_GPS.h
View File

@ -31,8 +31,8 @@
#define GPS_MAX_I2C_TRANSFER 32 ///< The max number of bytes we'll try to read at once #define GPS_MAX_I2C_TRANSFER 32 ///< The max number of bytes we'll try to read at once
#define GPS_MAX_SPI_TRANSFER 100 ///< The max number of bytes we'll try to read at once #define GPS_MAX_SPI_TRANSFER 100 ///< The max number of bytes we'll try to read at once
#define MAXLINELENGTH 120 ///< how long are max NMEA lines to parse? #define MAXLINELENGTH 120 ///< how long are max NMEA lines to parse?
#define NMEA_MAX_SENTENCE_ID 20 // maximum length of a sentence ID name, including terminating 0 #define NMEA_MAX_SENTENCE_ID 20 ///< maximum length of a sentence ID name, including terminating 0
#define NMEA_MAX_SOURCE_ID 3 // maximum length of a source ID name, including terminating 0 #define NMEA_MAX_SOURCE_ID 3 ///< maximum length of a source ID name, including terminating 0
#include "Arduino.h" #include "Arduino.h"
@ -104,14 +104,14 @@
/**************************************************************************/ /**************************************************************************/
typedef enum { typedef enum {
NMEA_BAD = 0, // passed none of the checks NMEA_BAD = 0, ///< passed none of the checks
NMEA_HAS_DOLLAR = 1, // has a dollar sign in the first position NMEA_HAS_DOLLAR = 1, ///< has a dollar sign in the first position
NMEA_HAS_CHECKSUM = 2, // has a valid checksum at the end NMEA_HAS_CHECKSUM = 2, ///< has a valid checksum at the end
NMEA_HAS_NAME = 4, // there is a token after the $ followed by a comma NMEA_HAS_NAME = 4, ///< there is a token after the $ followed by a comma
NMEA_HAS_SOURCE = 10, // has a recognized source ID NMEA_HAS_SOURCE = 10, ///< has a recognized source ID
NMEA_HAS_SENTENCE = 20, // has a recognized sentence ID NMEA_HAS_SENTENCE = 20, ///< has a recognized sentence ID
NMEA_HAS_SENTENCE_P = 40 // has a recognized parseable sentence ID NMEA_HAS_SENTENCE_P = 40 ///< has a recognized parseable sentence ID
} nmea_check_t; } nmea_check_t; ///< resulting code from running check()
/**************************************************************************/ /**************************************************************************/
/*! /*!
@ -152,11 +152,11 @@ class Adafruit_GPS : public Print{
boolean wakeup(void); boolean wakeup(void);
boolean standby(void); boolean standby(void);
int thisCheck = 0; // the results of the check on the current sentence int thisCheck = 0; ///< the results of the check on the current sentence
char thisSource[NMEA_MAX_SOURCE_ID] = {0}; // the first two letters of the current sentence, e.g. WI, GP char thisSource[NMEA_MAX_SOURCE_ID] = {0}; ///< the first two letters of the current sentence, e.g. WI, GP
char thisSentence[NMEA_MAX_SENTENCE_ID] = {0}; // the next three letters of the current sentence, e.g. GLL, RMC char thisSentence[NMEA_MAX_SENTENCE_ID] = {0}; ///< the next three letters of the current sentence, e.g. GLL, RMC
char lastSource[NMEA_MAX_SOURCE_ID] = {0}; // same for last correctly parsed sentence char lastSource[NMEA_MAX_SOURCE_ID] = {0}; ///< the results of the check on the most recent successfully parsed sentence
char lastSentence[NMEA_MAX_SENTENCE_ID] = {0}; char lastSentence[NMEA_MAX_SENTENCE_ID] = {0}; ///< the next three letters of the most recent successfully parsed sentence, e.g. GLL, RMC
uint8_t hour; ///< GMT hours uint8_t hour; ///< GMT hours
uint8_t minute; ///< GMT minutes uint8_t minute; ///< GMT minutes
@ -218,18 +218,18 @@ class Adafruit_GPS : public Print{
boolean parseLonDir(char *); boolean parseLonDir(char *);
boolean parseFix(char *); boolean parseFix(char *);
// used by check() for validity tests, room for future expansion // used by check() for validity tests, room for future expansion
const char *sources[5] = {"II", "WI", "GP", "GN", "ZZZ"}; const char *sources[5] = {"II", "WI", "GP", "GN", "ZZZ"}; ///< valid source ids
const char *sentences_parsed[5] = {"GGA", "GLL", "GSA", "RMC", "ZZZ"}; const char *sentences_parsed[5] = {"GGA", "GLL", "GSA", "RMC", "ZZZ"}; ///< parseable sentence ids
const char *sentences_known[1] = {"ZZZ"}; const char *sentences_known[1] = {"ZZZ"}; ///< known, but not parseable sentence ids
// Make all of these times far in the past by setting them near the middle of the // Make all of these times far in the past by setting them near the middle of the
// millis() range. Timing assumes that sentences are parsed promptly. // millis() range. Timing assumes that sentences are parsed promptly.
uint32_t lastUpdate = 2000000000L; // millis() when last full sentence successfully parsed uint32_t lastUpdate = 2000000000L; ///< millis() when last full sentence successfully parsed
uint32_t lastFix = 2000000000L; // millis() when last fix received uint32_t lastFix = 2000000000L; ///< millis() when last fix received
uint32_t lastTime = 2000000000L; // millis() when last time received uint32_t lastTime = 2000000000L; ///< millis() when last time received
uint32_t lastDate = 2000000000L; // millis() when last date received uint32_t lastDate = 2000000000L; ///< millis() when last date received
uint32_t recvdTime = 2000000000L; // millis() when last full sentence received uint32_t recvdTime = 2000000000L; ///< millis() when last full sentence received
uint32_t sentTime = 2000000000L; // millis() when first character of last full sentence received uint32_t sentTime = 2000000000L; ///< millis() when first character of last full sentence received
boolean paused; boolean paused;
uint8_t parseResponse(char *response); uint8_t parseResponse(char *response);