From f11b7bae88eef7d314790c3d732a3c5b9ca8c279 Mon Sep 17 00:00:00 2001 From: Doxygen CI Date: Wed, 16 Sep 2026 17:02:23 +0000 Subject: [PATCH] Deploy docs to GitHub Pages from commit 6a569968e1 Commit: 6a569968e1b4c216aadff59d0a5b07b4e2416cf7 GitHub Actions run: 35124936634 --- html/_adafruit___g_p_s_8h_source.html | 130 ++++++++++++----------- html/class_adafruit___g_p_s-members.html | 127 +++++++++++----------- html/class_adafruit___g_p_s.html | 26 +++++ html/functions.html | 1 + html/functions_func.html | 1 + html/search/all_8.js | 2 +- html/search/functions_6.js | 2 +- 7 files changed, 160 insertions(+), 129 deletions(-) diff --git a/html/_adafruit___g_p_s_8h_source.html b/html/_adafruit___g_p_s_8h_source.html index 8aca149..ab8f2ec 100644 --- a/html/_adafruit___g_p_s_8h_source.html +++ b/html/_adafruit___g_p_s_8h_source.html @@ -66,7 +66,7 @@ $(function() {
Adafruit_GPS.h
-Go to the documentation of this file.
1 /**************************************************************************/
22 /**************************************************************************/
23 
24 #ifndef _ADAFRUIT_GPS_H
25 #define _ADAFRUIT_GPS_H
26 
27 /**************************************************************************/
32 #ifndef NMEA_EXTRAS // inject on the compile command line to force extensions
33 #ifndef ARDUINO_ARCH_AVR
34 #define NMEA_EXTENSIONS
35 #endif
36 #else
37 #if (NMEA_EXTRAS > 0)
38 #define NMEA_EXTENSIONS
39 #endif
40 #endif
41 
42 #if (defined(__AVR__) || ((defined(ARDUINO_UNOR4_WIFI) || defined(ESP8266)) && \
43  !defined(NO_SW_SERIAL)))
44 #define USE_SW_SERIAL
45 #endif
47 #define GPS_DEFAULT_I2C_ADDR \
48  0x10
49 #define GPS_MAX_I2C_TRANSFER \
50  32
51 #define GPS_MAX_SPI_TRANSFER \
52  100
53 #define MAXLINELENGTH 120
54 #define NMEA_MAX_SENTENCE_ID \
55  20
56 #define NMEA_MAX_SOURCE_ID \
57  3
58 
59 #include "Arduino.h"
60 #ifdef USE_SW_SERIAL
61 #include <SoftwareSerial.h>
62 #endif
63 #include <Adafruit_GNSS.h>
64 #include <Adafruit_PMTK.h>
65 #include <NMEA_data.h>
66 #include <SPI.h>
67 #include <Wire.h>
68 
70 typedef enum {
71  NMEA_BAD = 0,
72  NMEA_HAS_DOLLAR =
73  1,
74  NMEA_HAS_CHECKSUM = 2,
75  NMEA_HAS_NAME = 4,
76  NMEA_HAS_SOURCE = 10,
77  NMEA_HAS_SENTENCE = 20,
78  NMEA_HAS_SENTENCE_P = 40
79 } nmea_check_t;
80 
81 /**************************************************************************/
85 class Adafruit_GPS : public Print {
86 public:
87  // Adafruit_GPS.cpp
88  bool begin(uint32_t baud_or_i2caddr);
89 
90 #ifdef USE_SW_SERIAL
91  Adafruit_GPS(SoftwareSerial *ser); // Constructor when using SoftwareSerial
92 #endif
93  Adafruit_GPS(HardwareSerial *ser); // Constructor when using HardwareSerial
94  Adafruit_GPS(Stream *data); // Constructor when using Stream
95  Adafruit_GPS(TwoWire *theWire); // Constructor when using I2C
96  Adafruit_GPS(SPIClass *theSPI, int8_t cspin); // Constructor when using SPI
97  Adafruit_GPS(); // Constructor for no communications, just data storage
98  void common_init(void);
99  virtual ~Adafruit_GPS();
100 
101  size_t available(void);
102  size_t write(uint8_t);
103  char read(void);
104  void sendCommand(const char *);
105  void sendCommand(const __FlashStringHelper *);
106  bool newNMEAreceived();
107  void pause(bool b);
108  char *lastNMEA(void);
109  bool waitForSentence(const char *wait, uint8_t max = MAXWAITSENTENCE,
110  bool usingInterrupts = false, uint32_t timeout = 10000);
111  bool LOCUS_StartLogger(void);
112  bool LOCUS_StopLogger(void);
113  bool LOCUS_ReadStatus(void);
114  bool standby(void);
115  bool wakeup(void);
116  nmea_float_t secondsSinceFix();
117  nmea_float_t secondsSinceTime();
118  nmea_float_t secondsSinceDate();
119  void resetSentTime();
120 
121  // NMEA_parse.cpp
122  bool parse(char *);
123  bool check(char *nmea);
124  bool onList(char *nmea, const char **list);
125  uint8_t parseHex(char c);
126 
127  // NMEA_build.cpp
128 #ifdef NMEA_EXTENSIONS
129  char *build(char *nmea, const char *thisSource, const char *thisSentence,
130  char ref = 'R', bool noCRLF = false);
131 #endif
132  void addChecksum(char *buff);
133 
134  // NMEA_data.cpp
135  void newDataValue(nmea_index_t tag, nmea_float_t v);
136 #ifdef NMEA_EXTENSIONS
137  nmea_float_t get(nmea_index_t idx);
138  nmea_float_t getSmoothed(nmea_index_t idx);
139  void initDataValue(nmea_index_t idx, char *label = NULL, char *fmt = NULL,
140  char *unit = NULL, unsigned long response = 0,
141  nmea_value_type_t type = NMEA_SIMPLE_FLOAT);
142  nmea_history_t *initHistory(nmea_index_t idx, nmea_float_t scale = 10.0,
143  nmea_float_t offset = 0.0,
144  unsigned historyInterval = 20,
145  unsigned historyN = 192);
146  void removeHistory(nmea_index_t idx);
147  void showDataValue(nmea_index_t idx, int n = 7);
148  bool isCompoundAngle(nmea_index_t idx);
149 #endif
150  nmea_float_t boatAngle(nmea_float_t s, nmea_float_t c);
151  nmea_float_t compassAngle(nmea_float_t s, nmea_float_t c);
152 
153  int thisCheck = 0;
154  char thisSource[NMEA_MAX_SOURCE_ID] = {
155  0};
156  char thisSentence[NMEA_MAX_SENTENCE_ID] = {
157  0};
158  char lastSource[NMEA_MAX_SOURCE_ID] = {
159  0};
160  char lastSentence[NMEA_MAX_SENTENCE_ID] = {
162  0};
163 
165  uint8_t hour;
166  uint8_t minute;
167  uint8_t seconds;
168  uint16_t milliseconds;
169  uint8_t year;
170  uint8_t month;
171  uint8_t day;
172 
173  nmea_float_t latitude;
174  nmea_float_t longitude;
176 
181  int32_t latitude_fixed;
182  int32_t longitude_fixed;
184 
186  nmea_float_t latitudeDegrees;
187  nmea_float_t longitudeDegrees;
188  nmea_float_t geoidheight;
189  nmea_float_t altitude;
190  nmea_float_t speed;
191  nmea_float_t angle;
192  nmea_float_t magvariation;
193  nmea_float_t HDOP;
194  nmea_float_t VDOP;
196  nmea_float_t PDOP;
198  char lat = 'X';
200  char lon = 'X';
201  char mag = 'X';
202  bool fix;
203  uint8_t fixquality;
204  uint8_t fixquality_3d;
205  uint8_t satellites;
206  uint8_t antenna;
207 
208  uint16_t LOCUS_serial;
209  uint16_t LOCUS_records;
210  uint8_t LOCUS_type;
211  uint8_t LOCUS_mode;
212  uint8_t LOCUS_config;
213  uint8_t LOCUS_interval;
214  uint8_t LOCUS_distance;
215  uint8_t LOCUS_speed;
216  uint8_t LOCUS_status;
217  uint8_t LOCUS_percent;
218 
219 #ifdef NMEA_EXTENSIONS
220  // NMEA additional public variables
221  nmea_datavalue_t
222  val[NMEA_MAX_INDEX];
223  nmea_float_t depthToKeel =
225  2.4;
226  nmea_float_t depthToTransducer =
227  0.0;
228 
229  char toID[NMEA_MAX_WP_ID] = {
230  0};
231  char fromID[NMEA_MAX_WP_ID] = {
232  0};
233 
234  char txtTXT[63] = {0};
235  int txtTot = 0;
236  int txtID = 0;
237  int txtN = 0;
238 #endif // NMEA_EXTENSIONS
239 
240 private:
241  // void parseLat(char *);
242  // bool parseLatDir(char *);
243  // void parseLon(char *);
244  // bool parseLonDir(char *);
245  // NMEA_data.cpp
246  void data_init();
247  // NMEA_parse.cpp
248  const char *tokenOnList(char *token, const char list[][4]);
249  bool parseCoord(char *p, nmea_float_t *angleDegrees = NULL,
250  nmea_float_t *angle = NULL, int32_t *angle_fixed = NULL,
251  char *dir = NULL);
252  char *parseStr(char *buff, char *p, int n);
253  void setCoordinate(const gnss_coordinate_t &coordinate,
254  nmea_float_t *angleDegrees, nmea_float_t *angle,
255  int32_t *angle_fixed, char *dir);
256  gnss_sentence_status_t updatePosition(nmea_span_t type, nmea_span_t fields);
257  bool parseAntenna(char *);
258  bool isEmpty(char *pStart);
259 
260  // Shared flash tables avoid RAM copies of both the IDs and their pointers.
261  static const char PROGMEM sources[][4];
262  static const char PROGMEM sentences_parsed[][4];
263  static const char PROGMEM sentences_known[][4];
264 
265  // Make all of these times far in the past by setting them near the middle of
266  // the millis() range. Timing assumes that sentences are parsed promptly.
267  uint32_t lastUpdate =
268  2000000000L;
269  uint32_t lastFix = 2000000000L;
270  uint32_t lastTime = 2000000000L;
271  uint32_t lastDate = 2000000000L;
272  uint32_t sentTime = 2000000000L;
273  bool paused;
275 
276  uint8_t parseResponse(char *response);
277 #ifdef USE_SW_SERIAL
278  SoftwareSerial *gpsSwSerial;
279 #endif
280  bool noComms = false;
281  HardwareSerial *gpsHwSerial;
282  Stream *gpsStream;
283  TwoWire *gpsI2C;
284  SPIClass *gpsSPI;
285  int8_t gpsSPI_cs = -1;
286  SPISettings gpsSPI_settings =
287  SPISettings(1000000, MSBFIRST, SPI_MODE0); // default
288  uint8_t _i2caddr;
289  char _i2cbuffer[GPS_MAX_I2C_TRANSFER];
290  int8_t _buff_max = -1, _buff_idx = 0;
291  char last_char = 0;
292 
293  volatile char line1[MAXLINELENGTH];
294  volatile char line2[MAXLINELENGTH];
296  Adafruit_NMEA receiver{line1, line2, MAXLINELENGTH};
297  const char *volatile lastline =
298  (const char *)line2;
299  volatile bool recvdflag;
300  volatile bool inStandbyMode;
301 };
302 /**************************************************************************/
303 
304 #endif
Adafruit_GPS::PDOP
nmea_float_t PDOP
Definition: Adafruit_GPS.h:197
+Go to the documentation of this file.
1 /**************************************************************************/
22 /**************************************************************************/
23 
24 #ifndef _ADAFRUIT_GPS_H
25 #define _ADAFRUIT_GPS_H
26 
27 /**************************************************************************/
32 #ifndef NMEA_EXTRAS // inject on the compile command line to force extensions
33 #ifndef ARDUINO_ARCH_AVR
34 #define NMEA_EXTENSIONS
35 #endif
36 #else
37 #if (NMEA_EXTRAS > 0)
38 #define NMEA_EXTENSIONS
39 #endif
40 #endif
41 
42 #if (defined(__AVR__) || ((defined(ARDUINO_UNOR4_WIFI) || defined(ESP8266)) && \
43  !defined(NO_SW_SERIAL)))
44 #define USE_SW_SERIAL
45 #endif
47 #define GPS_DEFAULT_I2C_ADDR \
48  0x10
49 #define GPS_MAX_I2C_TRANSFER \
50  32
51 #define GPS_MAX_SPI_TRANSFER \
52  100
53 #define MAXLINELENGTH 120
54 #define NMEA_MAX_SENTENCE_ID \
55  20
56 #define NMEA_MAX_SOURCE_ID \
57  3
58 
59 #include "Arduino.h"
60 #ifdef USE_SW_SERIAL
61 #include <SoftwareSerial.h>
62 #endif
63 #include <Adafruit_GNSS.h>
64 #include <Adafruit_PMTK.h>
65 #include <NMEA_data.h>
66 #include <SPI.h>
67 #include <Wire.h>
68 
70 typedef enum {
71  NMEA_BAD = 0,
72  NMEA_HAS_DOLLAR =
73  1,
74  NMEA_HAS_CHECKSUM = 2,
75  NMEA_HAS_NAME = 4,
76  NMEA_HAS_SOURCE = 10,
77  NMEA_HAS_SENTENCE = 20,
78  NMEA_HAS_SENTENCE_P = 40
79 } nmea_check_t;
80 
81 /**************************************************************************/
85 class Adafruit_GPS : public Print {
86 public:
87  // Adafruit_GPS.cpp
88  bool begin(uint32_t baud_or_i2caddr);
89 
90 #ifdef USE_SW_SERIAL
91  Adafruit_GPS(SoftwareSerial *ser); // Constructor when using SoftwareSerial
92 #endif
93  Adafruit_GPS(HardwareSerial *ser); // Constructor when using HardwareSerial
94  Adafruit_GPS(Stream *data); // Constructor when using Stream
95  Adafruit_GPS(TwoWire *theWire); // Constructor when using I2C
96  Adafruit_GPS(SPIClass *theSPI, int8_t cspin); // Constructor when using SPI
97  Adafruit_GPS(); // Constructor for no communications, just data storage
98  void common_init(void);
99  virtual ~Adafruit_GPS();
100 
101  size_t available(void);
102  size_t write(uint8_t);
103  char read(void);
104  void sendCommand(const char *);
105  void sendCommand(const __FlashStringHelper *);
106  bool newNMEAreceived();
107  void pause(bool b);
108  char *lastNMEA(void);
109  gnss_position_t lastPosition() const;
110  bool waitForSentence(const char *wait, uint8_t max = MAXWAITSENTENCE,
111  bool usingInterrupts = false, uint32_t timeout = 10000);
112  bool LOCUS_StartLogger(void);
113  bool LOCUS_StopLogger(void);
114  bool LOCUS_ReadStatus(void);
115  bool standby(void);
116  bool wakeup(void);
117  nmea_float_t secondsSinceFix();
118  nmea_float_t secondsSinceTime();
119  nmea_float_t secondsSinceDate();
120  void resetSentTime();
121 
122  // NMEA_parse.cpp
123  bool parse(char *);
124  bool check(char *nmea);
125  bool onList(char *nmea, const char **list);
126  uint8_t parseHex(char c);
127 
128  // NMEA_build.cpp
129 #ifdef NMEA_EXTENSIONS
130  char *build(char *nmea, const char *thisSource, const char *thisSentence,
131  char ref = 'R', bool noCRLF = false);
132 #endif
133  void addChecksum(char *buff);
134 
135  // NMEA_data.cpp
136  void newDataValue(nmea_index_t tag, nmea_float_t v);
137 #ifdef NMEA_EXTENSIONS
138  nmea_float_t get(nmea_index_t idx);
139  nmea_float_t getSmoothed(nmea_index_t idx);
140  void initDataValue(nmea_index_t idx, char *label = NULL, char *fmt = NULL,
141  char *unit = NULL, unsigned long response = 0,
142  nmea_value_type_t type = NMEA_SIMPLE_FLOAT);
143  nmea_history_t *initHistory(nmea_index_t idx, nmea_float_t scale = 10.0,
144  nmea_float_t offset = 0.0,
145  unsigned historyInterval = 20,
146  unsigned historyN = 192);
147  void removeHistory(nmea_index_t idx);
148  void showDataValue(nmea_index_t idx, int n = 7);
149  bool isCompoundAngle(nmea_index_t idx);
150 #endif
151  nmea_float_t boatAngle(nmea_float_t s, nmea_float_t c);
152  nmea_float_t compassAngle(nmea_float_t s, nmea_float_t c);
153 
154  int thisCheck = 0;
155  char thisSource[NMEA_MAX_SOURCE_ID] = {
156  0};
157  char thisSentence[NMEA_MAX_SENTENCE_ID] = {
158  0};
159  char lastSource[NMEA_MAX_SOURCE_ID] = {
160  0};
161  char lastSentence[NMEA_MAX_SENTENCE_ID] = {
163  0};
164 
166  uint8_t hour;
167  uint8_t minute;
168  uint8_t seconds;
169  uint16_t milliseconds;
170  uint8_t year;
171  uint8_t month;
172  uint8_t day;
173 
174  nmea_float_t latitude;
175  nmea_float_t longitude;
177 
182  int32_t latitude_fixed;
183  int32_t longitude_fixed;
185 
187  nmea_float_t latitudeDegrees;
188  nmea_float_t longitudeDegrees;
189  nmea_float_t geoidheight;
190  nmea_float_t altitude;
191  nmea_float_t speed;
192  nmea_float_t angle;
193  nmea_float_t magvariation;
194  nmea_float_t HDOP;
195  nmea_float_t VDOP;
197  nmea_float_t PDOP;
199  char lat = 'X';
201  char lon = 'X';
202  char mag = 'X';
203  bool fix;
204  uint8_t fixquality;
205  uint8_t fixquality_3d;
206  uint8_t satellites;
207  uint8_t antenna;
208 
209  uint16_t LOCUS_serial;
210  uint16_t LOCUS_records;
211  uint8_t LOCUS_type;
212  uint8_t LOCUS_mode;
213  uint8_t LOCUS_config;
214  uint8_t LOCUS_interval;
215  uint8_t LOCUS_distance;
216  uint8_t LOCUS_speed;
217  uint8_t LOCUS_status;
218  uint8_t LOCUS_percent;
219 
220 #ifdef NMEA_EXTENSIONS
221  // NMEA additional public variables
222  nmea_datavalue_t
223  val[NMEA_MAX_INDEX];
224  nmea_float_t depthToKeel =
226  2.4;
227  nmea_float_t depthToTransducer =
228  0.0;
229 
230  char toID[NMEA_MAX_WP_ID] = {
231  0};
232  char fromID[NMEA_MAX_WP_ID] = {
233  0};
234 
235  char txtTXT[63] = {0};
236  int txtTot = 0;
237  int txtID = 0;
238  int txtN = 0;
239 #endif // NMEA_EXTENSIONS
240 
241 private:
242  // void parseLat(char *);
243  // bool parseLatDir(char *);
244  // void parseLon(char *);
245  // bool parseLonDir(char *);
246  // NMEA_data.cpp
247  void data_init();
248  // NMEA_parse.cpp
249  const char *tokenOnList(char *token, const char list[][4]);
250  bool parseCoord(char *p, nmea_float_t *angleDegrees = NULL,
251  nmea_float_t *angle = NULL, int32_t *angle_fixed = NULL,
252  char *dir = NULL);
253  char *parseStr(char *buff, char *p, int n);
254  void setCoordinate(const gnss_coordinate_t &coordinate,
255  nmea_float_t *angleDegrees, nmea_float_t *angle,
256  int32_t *angle_fixed, char *dir);
257  gnss_sentence_status_t updatePosition(nmea_span_t type, nmea_span_t fields);
258  bool parseAntenna(char *);
259  bool isEmpty(char *pStart);
260 
261  // Shared flash tables avoid RAM copies of both the IDs and their pointers.
262  static const char PROGMEM sources[][4];
263  static const char PROGMEM sentences_parsed[][4];
264  static const char PROGMEM sentences_known[][4];
265 
266  // Make all of these times far in the past by setting them near the middle of
267  // the millis() range. Timing assumes that sentences are parsed promptly.
268  uint32_t lastUpdate =
269  2000000000L;
270  uint32_t lastFix = 2000000000L;
271  uint32_t lastTime = 2000000000L;
272  uint32_t lastDate = 2000000000L;
273  uint32_t sentTime = 2000000000L;
274  bool paused;
276 
277  uint8_t parseResponse(char *response);
278 #ifdef USE_SW_SERIAL
279  SoftwareSerial *gpsSwSerial;
280 #endif
281  bool noComms = false;
282  HardwareSerial *gpsHwSerial;
283  Stream *gpsStream;
284  TwoWire *gpsI2C;
285  SPIClass *gpsSPI;
286  int8_t gpsSPI_cs = -1;
287  SPISettings gpsSPI_settings =
288  SPISettings(1000000, MSBFIRST, SPI_MODE0); // default
289  uint8_t _i2caddr;
290  char _i2cbuffer[GPS_MAX_I2C_TRANSFER];
291  int8_t _buff_max = -1, _buff_idx = 0;
292  char last_char = 0;
293 
294  volatile char line1[MAXLINELENGTH];
295  volatile char line2[MAXLINELENGTH];
297  Adafruit_GNSS receiver{line1, line2, MAXLINELENGTH};
298  const char *volatile lastline =
299  (const char *)line2;
300  volatile bool recvdflag;
301  volatile bool inStandbyMode;
302 };
303 /**************************************************************************/
304 
305 #endif
Adafruit_GPS::PDOP
nmea_float_t PDOP
Definition: Adafruit_GPS.h:198
nmea_history_t
Definition: NMEA_data.h:51
Adafruit_GPS::showDataValue
void showDataValue(nmea_index_t idx, int n=7)
Print out the current state of a data value. Primarily useful as a debugging aid. ...
Definition: NMEA_data.cpp:442
Adafruit_PMTK.h
@@ -74,116 +74,118 @@ $(function() {
NMEA_MAX_SENTENCE_ID
#define NMEA_MAX_SENTENCE_ID
maximum length of a sentence ID name, including terminating 0
Definition: Adafruit_GPS.h:54
Adafruit_GPS::onList
bool onList(char *nmea, const char **list)
Check if an NMEA string is valid and is on a list, perhaps to decide if it should be passed to a part...
Definition: NMEA_parse.cpp:657
gnss_sentence_status_t
gnss_sentence_status_t
Result of validating fields used by a standard navigation decoder.
Definition: Adafruit_GNSS.h:49
-
Adafruit_NMEA
Definition: Adafruit_NMEA.h:70
-
Adafruit_GPS::angle
nmea_float_t angle
Course in degrees from true north.
Definition: Adafruit_GPS.h:191
-
Adafruit_GPS::txtN
int txtN
the TXT sentence number
Definition: Adafruit_GPS.h:237
-
Adafruit_GPS::day
uint8_t day
GMT day.
Definition: Adafruit_GPS.h:171
-
Adafruit_GPS::speed
nmea_float_t speed
Current speed over ground in knots.
Definition: Adafruit_GPS.h:190
-
Adafruit_GPS::minute
uint8_t minute
GMT minutes.
Definition: Adafruit_GPS.h:166
-
Adafruit_GPS::HDOP
nmea_float_t HDOP
Definition: Adafruit_GPS.h:193
+
Adafruit_GPS::angle
nmea_float_t angle
Course in degrees from true north.
Definition: Adafruit_GPS.h:192
+
Adafruit_GPS::txtN
int txtN
the TXT sentence number
Definition: Adafruit_GPS.h:238
+
Adafruit_GPS::day
uint8_t day
GMT day.
Definition: Adafruit_GPS.h:172
+
Adafruit_GPS::speed
nmea_float_t speed
Current speed over ground in knots.
Definition: Adafruit_GPS.h:191
+
Adafruit_GPS::minute
uint8_t minute
GMT minutes.
Definition: Adafruit_GPS.h:167
+
Adafruit_GPS::HDOP
nmea_float_t HDOP
Definition: Adafruit_GPS.h:194
gnss_coordinate_t
Definition: Adafruit_GNSS.h:22
Adafruit_GPS::removeHistory
void removeHistory(nmea_index_t idx)
Remove history from a data value table entry, if it has been added.
Definition: NMEA_data.cpp:423
NMEA_HAS_SOURCE
has a recognized source ID
Definition: Adafruit_GPS.h:76
-
Adafruit_GPS::txtTXT
char txtTXT[63]
text content from most recent TXT sentence
Definition: Adafruit_GPS.h:234
-
Adafruit_GPS::LOCUS_percent
uint8_t LOCUS_percent
Log life used percentage.
Definition: Adafruit_GPS.h:217
-
Adafruit_GPS::year
uint8_t year
GMT year.
Definition: Adafruit_GPS.h:169
-
Adafruit_GPS::fix
bool fix
Have a fix?
Definition: Adafruit_GPS.h:202
-
Adafruit_GPS::lat
char lat
N/S.
Definition: Adafruit_GPS.h:199
+
Adafruit_GPS::txtTXT
char txtTXT[63]
text content from most recent TXT sentence
Definition: Adafruit_GPS.h:235
+
gnss_position_t
Definition: Adafruit_GNSS.h:67
+
Adafruit_GPS::LOCUS_percent
uint8_t LOCUS_percent
Log life used percentage.
Definition: Adafruit_GPS.h:218
+
Adafruit_GPS::year
uint8_t year
GMT year.
Definition: Adafruit_GPS.h:170
+
Adafruit_GPS::fix
bool fix
Have a fix?
Definition: Adafruit_GPS.h:203
+
Adafruit_GPS::lat
char lat
N/S.
Definition: Adafruit_GPS.h:200
nmea_datavalue_t
Definition: NMEA_data.h:96
Adafruit_GPS::addChecksum
void addChecksum(char *buff)
Add *CS where CS is the two character hex checksum for all but the first character in the string...
Definition: NMEA_build.cpp:596
-
Adafruit_GPS::LOCUS_distance
uint8_t LOCUS_distance
Distance setting.
Definition: Adafruit_GPS.h:214
-
Adafruit_GPS::latitude_fixed
int32_t latitude_fixed
Definition: Adafruit_GPS.h:181
+
Adafruit_GPS::LOCUS_distance
uint8_t LOCUS_distance
Distance setting.
Definition: Adafruit_GPS.h:215
+
Adafruit_GPS::latitude_fixed
int32_t latitude_fixed
Definition: Adafruit_GPS.h:182
Adafruit_GPS::Adafruit_GPS
Adafruit_GPS()
Constructor when there are no communications attached.
Definition: Adafruit_GPS.cpp:141
-
Adafruit_GPS::seconds
uint8_t seconds
GMT seconds.
Definition: Adafruit_GPS.h:167
-
Adafruit_GPS::wakeup
bool wakeup(void)
Wake the sensor up.
Definition: Adafruit_GPS.cpp:548
+
Adafruit_GPS::seconds
uint8_t seconds
GMT seconds.
Definition: Adafruit_GPS.h:168
+
Adafruit_GPS::wakeup
bool wakeup(void)
Wake the sensor up.
Definition: Adafruit_GPS.cpp:574
NMEA_BAD
passed none of the checks
Definition: Adafruit_GPS.h:71
Adafruit_GPS::lastNMEA
char * lastNMEA(void)
Returns the last NMEA line received and unsets the received flag.
Definition: Adafruit_GPS.cpp:403
Adafruit_GPS::common_init
void common_init(void)
Initialization code used by all constructor types.
Definition: Adafruit_GPS.cpp:151
-
Adafruit_GPS::LOCUS_config
uint8_t LOCUS_config
Contents of configuration.
Definition: Adafruit_GPS.h:212
-
Adafruit_GPS::depthToKeel
nmea_float_t depthToKeel
depth from surface to bottom of keel in metres
Definition: Adafruit_GPS.h:224
+
Adafruit_GPS::LOCUS_config
uint8_t LOCUS_config
Contents of configuration.
Definition: Adafruit_GPS.h:213
+
Adafruit_GPS::depthToKeel
nmea_float_t depthToKeel
depth from surface to bottom of keel in metres
Definition: Adafruit_GPS.h:225
Adafruit_GPS::boatAngle
nmea_float_t boatAngle(nmea_float_t s, nmea_float_t c)
Estimate a direction in -180 to 180 degree range from the values of the sine and cosine of the compou...
Definition: NMEA_data.cpp:518
Adafruit_GPS::initHistory
nmea_history_t * initHistory(nmea_index_t idx, nmea_float_t scale=10.0, nmea_float_t offset=0.0, unsigned historyInterval=20, unsigned historyN=192)
Attempt to add history to a data value table entry. If it fails to malloc the space, history will not be added. Test the pointer for a check if needed. Select scale and offset values carefully so that operations and results will fit inside 16 bit integer limits. For example a scale of 1.0 and an offset of 100000.0 would be a good choice for atmospheric pressure in Pa with values ranging ~ +/- 3500, while a scale of 10.0 would be pushing the integer limits.
Definition: NMEA_data.cpp:382
Adafruit_GPS::available
size_t available(void)
How many bytes are available to read - part of &#39;Print&#39;-class functionality.
Definition: Adafruit_GPS.cpp:198
+
Adafruit_GNSS
Definition: Adafruit_GNSS.h:84
NMEA_HAS_SENTENCE
has a recognized sentence ID
Definition: Adafruit_GPS.h:77
Adafruit_GPS::build
char * build(char *nmea, const char *thisSource, const char *thisSentence, char ref='R', bool noCRLF=false)
Build an NMEA sentence string based on the relevant variables. Sentences start with a $...
Definition: NMEA_build.cpp:68
-
Adafruit_GPS::LOCUS_type
uint8_t LOCUS_type
Log type, 0: Overlap, 1: FullStop.
Definition: Adafruit_GPS.h:210
+
Adafruit_GPS::LOCUS_type
uint8_t LOCUS_type
Log type, 0: Overlap, 1: FullStop.
Definition: Adafruit_GPS.h:211
NMEA_HAS_SENTENCE_P
has a recognized parseable sentence ID
Definition: Adafruit_GPS.h:78
-
Adafruit_GPS::thisCheck
int thisCheck
the results of the check on the current sentence
Definition: Adafruit_GPS.h:153
-
Adafruit_GPS::thisSource
char thisSource[NMEA_MAX_SOURCE_ID]
the first two letters of the current sentence, e.g. WI, GP
Definition: Adafruit_GPS.h:154
-
Adafruit_GPS::secondsSinceFix
nmea_float_t secondsSinceFix()
Time in seconds since the last position fix was obtained. The time returned is limited to 2^32 millis...
Definition: Adafruit_GPS.cpp:570
-
Adafruit_GPS::LOCUS_StopLogger
bool LOCUS_StopLogger(void)
Stop the LOCUS logger.
Definition: Adafruit_GPS.cpp:462
+
Adafruit_GPS::thisCheck
int thisCheck
the results of the check on the current sentence
Definition: Adafruit_GPS.h:154
+
Adafruit_GPS::thisSource
char thisSource[NMEA_MAX_SOURCE_ID]
the first two letters of the current sentence, e.g. WI, GP
Definition: Adafruit_GPS.h:155
+
Adafruit_GPS::secondsSinceFix
nmea_float_t secondsSinceFix()
Time in seconds since the last position fix was obtained. The time returned is limited to 2^32 millis...
Definition: Adafruit_GPS.cpp:596
+
Adafruit_GPS::LOCUS_StopLogger
bool LOCUS_StopLogger(void)
Stop the LOCUS logger.
Definition: Adafruit_GPS.cpp:488
Adafruit_GPS::isCompoundAngle
bool isCompoundAngle(nmea_index_t idx)
Check if it is a compound angle.
Definition: NMEA_data.cpp:503
NMEA_MAX_INDEX
Definition: NMEA_data.h:190
-
Adafruit_GPS::fixquality_3d
uint8_t fixquality_3d
3D fix quality (1, 3, 3 = Nofix, 2D fix, 3D fix)
Definition: Adafruit_GPS.h:204
-
Adafruit_GPS::mag
char mag
Magnetic variation direction.
Definition: Adafruit_GPS.h:201
-
Adafruit_GPS::hour
uint8_t hour
GMT hours.
Definition: Adafruit_GPS.h:165
+
Adafruit_GPS::fixquality_3d
uint8_t fixquality_3d
3D fix quality (1, 3, 3 = Nofix, 2D fix, 3D fix)
Definition: Adafruit_GPS.h:205
+
Adafruit_GPS::mag
char mag
Magnetic variation direction.
Definition: Adafruit_GPS.h:202
+
Adafruit_GPS::hour
uint8_t hour
GMT hours.
Definition: Adafruit_GPS.h:166
Adafruit_GPS
The GPS class.
Definition: Adafruit_GPS.h:85
-
Adafruit_GPS::magvariation
nmea_float_t magvariation
Magnetic variation in degrees (vs. true north)
Definition: Adafruit_GPS.h:192
-
Adafruit_GPS::depthToTransducer
nmea_float_t depthToTransducer
depth of transducer below the surface in metres
Definition: Adafruit_GPS.h:226
-
Adafruit_GPS::txtID
int txtID
id of the text message
Definition: Adafruit_GPS.h:236
+
Adafruit_GPS::magvariation
nmea_float_t magvariation
Magnetic variation in degrees (vs. true north)
Definition: Adafruit_GPS.h:193
+
Adafruit_GPS::depthToTransducer
nmea_float_t depthToTransducer
depth of transducer below the surface in metres
Definition: Adafruit_GPS.h:227
+
Adafruit_GPS::txtID
int txtID
id of the text message
Definition: Adafruit_GPS.h:237
Adafruit_GPS::begin
bool begin(uint32_t baud_or_i2caddr)
Start the HW or SW serial port.
Definition: Adafruit_GPS.cpp:42
-
Adafruit_GPS::secondsSinceTime
nmea_float_t secondsSinceTime()
Time in seconds since the last GPS time was obtained. The time returned is limited to 2^32 millisecon...
Definition: Adafruit_GPS.cpp:582
-
Adafruit_GPS::txtTot
int txtTot
total TXT sentences in group
Definition: Adafruit_GPS.h:235
-
Adafruit_GPS::LOCUS_status
uint8_t LOCUS_status
0: Logging, 1: Stop logging
Definition: Adafruit_GPS.h:216
+
Adafruit_GPS::secondsSinceTime
nmea_float_t secondsSinceTime()
Time in seconds since the last GPS time was obtained. The time returned is limited to 2^32 millisecon...
Definition: Adafruit_GPS.cpp:608
+
Adafruit_GPS::txtTot
int txtTot
total TXT sentences in group
Definition: Adafruit_GPS.h:236
+
Adafruit_GPS::LOCUS_status
uint8_t LOCUS_status
0: Logging, 1: Stop logging
Definition: Adafruit_GPS.h:217
NMEA_data.h
-
Adafruit_GPS::longitude
nmea_float_t longitude
Definition: Adafruit_GPS.h:175
+
Adafruit_GPS::longitude
nmea_float_t longitude
Definition: Adafruit_GPS.h:176
Adafruit_GPS::~Adafruit_GPS
virtual ~Adafruit_GPS()
Destroy the object.
Definition: Adafruit_GPS.cpp:184
Adafruit_GPS::newDataValue
void newDataValue(nmea_index_t tag, nmea_float_t v)
Update the value and history information with a new value. Call whenever a new data value is received...
Definition: NMEA_data.cpp:44
-
Adafruit_GPS::altitude
nmea_float_t altitude
Altitude in meters above MSL.
Definition: Adafruit_GPS.h:189
+
Adafruit_GPS::altitude
nmea_float_t altitude
Altitude in meters above MSL.
Definition: Adafruit_GPS.h:190
Adafruit_GNSS.h
Transport-independent decoding of standard GNSS fields.
-
Adafruit_GPS::antenna
uint8_t antenna
1=problem, 2=internal, 3=external (PGTOP or PCD)
Definition: Adafruit_GPS.h:206
+
Adafruit_GPS::antenna
uint8_t antenna
1=problem, 2=internal, 3=external (PGTOP or PCD)
Definition: Adafruit_GPS.h:207
nmea_index_t
nmea_index_t
Definition: NMEA_data.h:121
-
Adafruit_GPS::LOCUS_interval
uint8_t LOCUS_interval
Interval setting.
Definition: Adafruit_GPS.h:213
+
Adafruit_GPS::LOCUS_interval
uint8_t LOCUS_interval
Interval setting.
Definition: Adafruit_GPS.h:214
NMEA_HAS_CHECKSUM
has a valid checksum at the end
Definition: Adafruit_GPS.h:74
-
Adafruit_GPS::standby
bool standby(void)
Standby Mode Switches.
Definition: Adafruit_GPS.cpp:526
+
Adafruit_GPS::lastPosition
gnss_position_t lastPosition() const
Decode the latest received sentence with exact coordinate precision.
Definition: Adafruit_GPS.cpp:430
+
Adafruit_GPS::standby
bool standby(void)
Standby Mode Switches.
Definition: Adafruit_GPS.cpp:552
MAXWAITSENTENCE
#define MAXWAITSENTENCE
maximum number of sentences to examine when looking for a response
Definition: Adafruit_PMTK.h:117
-
Adafruit_GPS::val
nmea_datavalue_t val[NMEA_MAX_INDEX]
Definition: Adafruit_GPS.h:222
-
Adafruit_GPS::satellites
uint8_t satellites
Number of satellites in use.
Definition: Adafruit_GPS.h:205
+
Adafruit_GPS::val
nmea_datavalue_t val[NMEA_MAX_INDEX]
Definition: Adafruit_GPS.h:223
+
Adafruit_GPS::satellites
uint8_t satellites
Number of satellites in use.
Definition: Adafruit_GPS.h:206
Adafruit_GPS::check
bool check(char *nmea)
Validate NMEA framing and checksum, then recognize its source and complete sentence ID...
Definition: NMEA_parse.cpp:587
NMEA_MAX_SOURCE_ID
#define NMEA_MAX_SOURCE_ID
maximum length of a source ID name, including terminating 0
Definition: Adafruit_GPS.h:56
Adafruit_GPS::parse
bool parse(char *)
Parse a standard NMEA string and update the relevant variables. Sentences start with a $...
Definition: NMEA_parse.cpp:70
-
Adafruit_GPS::latitudeDegrees
nmea_float_t latitudeDegrees
Latitude in decimal degrees.
Definition: Adafruit_GPS.h:186
-
Adafruit_GPS::secondsSinceDate
nmea_float_t secondsSinceDate()
Time in seconds since the last GPS date was obtained. The time returned is limited to 2^32 millisecon...
Definition: Adafruit_GPS.cpp:594
-
Adafruit_GPS::resetSentTime
void resetSentTime()
Fakes time of receipt of a sentence. Use between build() and parse() to make the timing look like the...
Definition: Adafruit_GPS.cpp:604
+
Adafruit_GPS::latitudeDegrees
nmea_float_t latitudeDegrees
Latitude in decimal degrees.
Definition: Adafruit_GPS.h:187
+
Adafruit_GPS::secondsSinceDate
nmea_float_t secondsSinceDate()
Time in seconds since the last GPS date was obtained. The time returned is limited to 2^32 millisecon...
Definition: Adafruit_GPS.cpp:620
+
Adafruit_GPS::resetSentTime
void resetSentTime()
Fakes time of receipt of a sentence. Use between build() and parse() to make the timing look like the...
Definition: Adafruit_GPS.cpp:630
Adafruit_GPS::newNMEAreceived
bool newNMEAreceived()
Check to see if a new NMEA line has been received.
Definition: Adafruit_GPS.cpp:387
-
Adafruit_GPS::LOCUS_speed
uint8_t LOCUS_speed
Speed setting.
Definition: Adafruit_GPS.h:215
+
Adafruit_GPS::LOCUS_speed
uint8_t LOCUS_speed
Speed setting.
Definition: Adafruit_GPS.h:216
MAXLINELENGTH
#define MAXLINELENGTH
how long are max NMEA lines to parse?
Definition: Adafruit_GPS.h:53
nmea_span_t
Definition: Adafruit_NMEA.h:33
Adafruit_GPS::parseHex
uint8_t parseHex(char c)
Parse a hex character and return the appropriate decimal value.
Definition: NMEA_parse.cpp:873
-
Adafruit_GPS::LOCUS_ReadStatus
bool LOCUS_ReadStatus(void)
Read the logger status.
Definition: Adafruit_GPS.cpp:474
+
Adafruit_GPS::LOCUS_ReadStatus
bool LOCUS_ReadStatus(void)
Read the logger status.
Definition: Adafruit_GPS.cpp:500
Adafruit_GPS::write
size_t write(uint8_t)
Write a byte to the underlying transport - part of &#39;Print&#39;-class functionality.
Definition: Adafruit_GPS.cpp:229
nmea_check_t
nmea_check_t
type for resulting code from running check()
Definition: Adafruit_GPS.h:70
-
Adafruit_GPS::latitude
nmea_float_t latitude
Definition: Adafruit_GPS.h:173
-
Adafruit_GPS::LOCUS_records
uint16_t LOCUS_records
Log number of data record.
Definition: Adafruit_GPS.h:209
-
Adafruit_GPS::fromID
char fromID[NMEA_MAX_WP_ID]
id of waypoint coming from on this segment of the route
Definition: Adafruit_GPS.h:231
-
Adafruit_GPS::LOCUS_mode
uint8_t LOCUS_mode
Logging mode, 0x08 interval logger.
Definition: Adafruit_GPS.h:211
-
Adafruit_GPS::thisSentence
char thisSentence[NMEA_MAX_SENTENCE_ID]
the next three letters of the current sentence, e.g. GLL, RMC
Definition: Adafruit_GPS.h:156
+
Adafruit_GPS::latitude
nmea_float_t latitude
Definition: Adafruit_GPS.h:174
+
Adafruit_GPS::LOCUS_records
uint16_t LOCUS_records
Log number of data record.
Definition: Adafruit_GPS.h:210
+
Adafruit_GPS::fromID
char fromID[NMEA_MAX_WP_ID]
id of waypoint coming from on this segment of the route
Definition: Adafruit_GPS.h:232
+
Adafruit_GPS::LOCUS_mode
uint8_t LOCUS_mode
Logging mode, 0x08 interval logger.
Definition: Adafruit_GPS.h:212
+
Adafruit_GPS::thisSentence
char thisSentence[NMEA_MAX_SENTENCE_ID]
the next three letters of the current sentence, e.g. GLL, RMC
Definition: Adafruit_GPS.h:157
NMEA_HAS_DOLLAR
has a dollar sign or exclamation mark in the first position
Definition: Adafruit_GPS.h:72
GPS_MAX_I2C_TRANSFER
#define GPS_MAX_I2C_TRANSFER
The max number of bytes we&#39;ll try to read at once.
Definition: Adafruit_GPS.h:49
Adafruit_GPS::compassAngle
nmea_float_t compassAngle(nmea_float_t s, nmea_float_t c)
Estimate a direction in 0 to 360 degree range from the values of the sine and cosine of the compound ...
Definition: NMEA_data.cpp:559
-
Adafruit_GPS::longitudeDegrees
nmea_float_t longitudeDegrees
Longitude in decimal degrees.
Definition: Adafruit_GPS.h:187
-
Adafruit_GPS::milliseconds
uint16_t milliseconds
GMT milliseconds.
Definition: Adafruit_GPS.h:168
-
Adafruit_GPS::month
uint8_t month
GMT month.
Definition: Adafruit_GPS.h:170
-
Adafruit_GPS::waitForSentence
bool waitForSentence(const char *wait, uint8_t max=MAXWAITSENTENCE, bool usingInterrupts=false, uint32_t timeout=10000)
Wait for a specified sentence from the device.
Definition: Adafruit_GPS.cpp:422
+
Adafruit_GPS::longitudeDegrees
nmea_float_t longitudeDegrees
Longitude in decimal degrees.
Definition: Adafruit_GPS.h:188
+
Adafruit_GPS::milliseconds
uint16_t milliseconds
GMT milliseconds.
Definition: Adafruit_GPS.h:169
+
Adafruit_GPS::month
uint8_t month
GMT month.
Definition: Adafruit_GPS.h:171
+
Adafruit_GPS::waitForSentence
bool waitForSentence(const char *wait, uint8_t max=MAXWAITSENTENCE, bool usingInterrupts=false, uint32_t timeout=10000)
Wait for a specified sentence from the device.
Definition: Adafruit_GPS.cpp:448
Adafruit_GPS::initDataValue
void initDataValue(nmea_index_t idx, char *label=NULL, char *fmt=NULL, char *unit=NULL, unsigned long response=0, nmea_value_type_t type=NMEA_SIMPLE_FLOAT)
Initialize the contents of a data value table entry.
Definition: NMEA_data.cpp:341
nmea_value_type_t
nmea_value_type_t
Definition: NMEA_data.h:71
-
Adafruit_GPS::lon
char lon
E/W.
Definition: Adafruit_GPS.h:200
-
Adafruit_GPS::LOCUS_StartLogger
bool LOCUS_StartLogger(void)
Start the LOCUS logger.
Definition: Adafruit_GPS.cpp:450
+
Adafruit_GPS::lon
char lon
E/W.
Definition: Adafruit_GPS.h:201
+
Adafruit_GPS::LOCUS_StartLogger
bool LOCUS_StartLogger(void)
Start the LOCUS logger.
Definition: Adafruit_GPS.cpp:476
Adafruit_GPS::getSmoothed
nmea_float_t getSmoothed(nmea_index_t idx)
Clearer approach to retrieving NMEA values.
Definition: NMEA_data.cpp:320
-
Adafruit_GPS::fixquality
uint8_t fixquality
Fix quality (0, 1, 2 = Invalid, GPS, DGPS)
Definition: Adafruit_GPS.h:203
-
Adafruit_GPS::geoidheight
nmea_float_t geoidheight
Diff between geoid height and WGS84 height.
Definition: Adafruit_GPS.h:188
-
Adafruit_GPS::LOCUS_serial
uint16_t LOCUS_serial
Log serial number.
Definition: Adafruit_GPS.h:208
-
Adafruit_GPS::longitude_fixed
int32_t longitude_fixed
Definition: Adafruit_GPS.h:183
-
Adafruit_GPS::lastSource
char lastSource[NMEA_MAX_SOURCE_ID]
Definition: Adafruit_GPS.h:158
+
Adafruit_GPS::fixquality
uint8_t fixquality
Fix quality (0, 1, 2 = Invalid, GPS, DGPS)
Definition: Adafruit_GPS.h:204
+
Adafruit_GPS::geoidheight
nmea_float_t geoidheight
Diff between geoid height and WGS84 height.
Definition: Adafruit_GPS.h:189
+
Adafruit_GPS::LOCUS_serial
uint16_t LOCUS_serial
Log serial number.
Definition: Adafruit_GPS.h:209
+
Adafruit_GPS::longitude_fixed
int32_t longitude_fixed
Definition: Adafruit_GPS.h:184
+
Adafruit_GPS::lastSource
char lastSource[NMEA_MAX_SOURCE_ID]
Definition: Adafruit_GPS.h:159
Adafruit_GPS::read
char read(void)
Read one character from the GPS device.
Definition: Adafruit_GPS.cpp:279
-
Adafruit_GPS::lastSentence
char lastSentence[NMEA_MAX_SENTENCE_ID]
Definition: Adafruit_GPS.h:161
+
Adafruit_GPS::lastSentence
char lastSentence[NMEA_MAX_SENTENCE_ID]
Definition: Adafruit_GPS.h:162
NMEA_MAX_WP_ID
#define NMEA_MAX_WP_ID
maximum length of a waypoint ID name, including terminating 0
Definition: NMEA_data.h:10
Adafruit_GPS::sendCommand
void sendCommand(const char *)
Send a command to the GPS device.
Definition: Adafruit_GPS.cpp:371
NMEA_SIMPLE_FLOAT
A simple floating point number.
Definition: NMEA_data.h:72
-
Adafruit_GPS::VDOP
nmea_float_t VDOP
Definition: Adafruit_GPS.h:195
+
Adafruit_GPS::VDOP
nmea_float_t VDOP
Definition: Adafruit_GPS.h:196
nmea_float_t
NMEA_FLOAT_T nmea_float_t
the type of variables to use for floating point
Definition: NMEA_data.h:35
NMEA_HAS_NAME
there is a token after the $ followed by a comma
Definition: Adafruit_GPS.h:75
-
Adafruit_GPS::toID
char toID[NMEA_MAX_WP_ID]
id of waypoint going to on this segment of the route
Definition: Adafruit_GPS.h:229
+
Adafruit_GPS::toID
char toID[NMEA_MAX_WP_ID]
id of waypoint going to on this segment of the route
Definition: Adafruit_GPS.h:230
diff --git a/html/class_adafruit___g_p_s-members.html b/html/class_adafruit___g_p_s-members.html index e044c9f..73dfdfa 100644 --- a/html/class_adafruit___g_p_s-members.html +++ b/html/class_adafruit___g_p_s-members.html @@ -97,69 +97,70 @@ $(function() { initHistory(nmea_index_t idx, nmea_float_t scale=10.0, nmea_float_t offset=0.0, unsigned historyInterval=20, unsigned historyN=192)Adafruit_GPS isCompoundAngle(nmea_index_t idx)Adafruit_GPS lastNMEA(void)Adafruit_GPS - lastSentenceAdafruit_GPS - lastSourceAdafruit_GPS - latAdafruit_GPS - latitudeAdafruit_GPS - latitude_fixedAdafruit_GPS - latitudeDegreesAdafruit_GPS - LOCUS_configAdafruit_GPS - LOCUS_distanceAdafruit_GPS - LOCUS_intervalAdafruit_GPS - LOCUS_modeAdafruit_GPS - LOCUS_percentAdafruit_GPS - LOCUS_ReadStatus(void)Adafruit_GPS - LOCUS_recordsAdafruit_GPS - LOCUS_serialAdafruit_GPS - LOCUS_speedAdafruit_GPS - LOCUS_StartLogger(void)Adafruit_GPS - LOCUS_statusAdafruit_GPS - LOCUS_StopLogger(void)Adafruit_GPS - LOCUS_typeAdafruit_GPS - lonAdafruit_GPS - longitudeAdafruit_GPS - longitude_fixedAdafruit_GPS - longitudeDegreesAdafruit_GPS - magAdafruit_GPS - magvariationAdafruit_GPS - millisecondsAdafruit_GPS - minuteAdafruit_GPS - monthAdafruit_GPS - newDataValue(nmea_index_t tag, nmea_float_t v)Adafruit_GPS - newNMEAreceived()Adafruit_GPS - onList(char *nmea, const char **list)Adafruit_GPS - parse(char *)Adafruit_GPS - parseHex(char c)Adafruit_GPS - pause(bool b)Adafruit_GPS - PDOPAdafruit_GPS - read(void)Adafruit_GPS - removeHistory(nmea_index_t idx)Adafruit_GPS - resetSentTime()Adafruit_GPS - satellitesAdafruit_GPS - secondsAdafruit_GPS - secondsSinceDate()Adafruit_GPS - secondsSinceFix()Adafruit_GPS - secondsSinceTime()Adafruit_GPS - sendCommand(const char *)Adafruit_GPS - sendCommand(const __FlashStringHelper *)Adafruit_GPS - showDataValue(nmea_index_t idx, int n=7)Adafruit_GPS - speedAdafruit_GPS - standby(void)Adafruit_GPS - thisCheckAdafruit_GPS - thisSentenceAdafruit_GPS - thisSourceAdafruit_GPS - toIDAdafruit_GPS - txtIDAdafruit_GPS - txtNAdafruit_GPS - txtTotAdafruit_GPS - txtTXTAdafruit_GPS - valAdafruit_GPS - VDOPAdafruit_GPS - waitForSentence(const char *wait, uint8_t max=MAXWAITSENTENCE, bool usingInterrupts=false, uint32_t timeout=10000)Adafruit_GPS - wakeup(void)Adafruit_GPS - write(uint8_t)Adafruit_GPS - yearAdafruit_GPS - ~Adafruit_GPS()Adafruit_GPSvirtual + lastPosition() constAdafruit_GPS + lastSentenceAdafruit_GPS + lastSourceAdafruit_GPS + latAdafruit_GPS + latitudeAdafruit_GPS + latitude_fixedAdafruit_GPS + latitudeDegreesAdafruit_GPS + LOCUS_configAdafruit_GPS + LOCUS_distanceAdafruit_GPS + LOCUS_intervalAdafruit_GPS + LOCUS_modeAdafruit_GPS + LOCUS_percentAdafruit_GPS + LOCUS_ReadStatus(void)Adafruit_GPS + LOCUS_recordsAdafruit_GPS + LOCUS_serialAdafruit_GPS + LOCUS_speedAdafruit_GPS + LOCUS_StartLogger(void)Adafruit_GPS + LOCUS_statusAdafruit_GPS + LOCUS_StopLogger(void)Adafruit_GPS + LOCUS_typeAdafruit_GPS + lonAdafruit_GPS + longitudeAdafruit_GPS + longitude_fixedAdafruit_GPS + longitudeDegreesAdafruit_GPS + magAdafruit_GPS + magvariationAdafruit_GPS + millisecondsAdafruit_GPS + minuteAdafruit_GPS + monthAdafruit_GPS + newDataValue(nmea_index_t tag, nmea_float_t v)Adafruit_GPS + newNMEAreceived()Adafruit_GPS + onList(char *nmea, const char **list)Adafruit_GPS + parse(char *)Adafruit_GPS + parseHex(char c)Adafruit_GPS + pause(bool b)Adafruit_GPS + PDOPAdafruit_GPS + read(void)Adafruit_GPS + removeHistory(nmea_index_t idx)Adafruit_GPS + resetSentTime()Adafruit_GPS + satellitesAdafruit_GPS + secondsAdafruit_GPS + secondsSinceDate()Adafruit_GPS + secondsSinceFix()Adafruit_GPS + secondsSinceTime()Adafruit_GPS + sendCommand(const char *)Adafruit_GPS + sendCommand(const __FlashStringHelper *)Adafruit_GPS + showDataValue(nmea_index_t idx, int n=7)Adafruit_GPS + speedAdafruit_GPS + standby(void)Adafruit_GPS + thisCheckAdafruit_GPS + thisSentenceAdafruit_GPS + thisSourceAdafruit_GPS + toIDAdafruit_GPS + txtIDAdafruit_GPS + txtNAdafruit_GPS + txtTotAdafruit_GPS + txtTXTAdafruit_GPS + valAdafruit_GPS + VDOPAdafruit_GPS + waitForSentence(const char *wait, uint8_t max=MAXWAITSENTENCE, bool usingInterrupts=false, uint32_t timeout=10000)Adafruit_GPS + wakeup(void)Adafruit_GPS + write(uint8_t)Adafruit_GPS + yearAdafruit_GPS + ~Adafruit_GPS()Adafruit_GPSvirtual
diff --git a/html/class_adafruit___g_p_s.html b/html/class_adafruit___g_p_s.html index 0967e7d..4a9c347 100644 --- a/html/class_adafruit___g_p_s.html +++ b/html/class_adafruit___g_p_s.html @@ -132,6 +132,9 @@ void char * lastNMEA (void)  Returns the last NMEA line received and unsets the received flag. More...
  +gnss_position_t lastPosition () const + Decode the latest received sentence with exact coordinate precision. More...
+  bool waitForSentence (const char *wait, uint8_t max=MAXWAITSENTENCE, bool usingInterrupts=false, uint32_t timeout=10000)  Wait for a specified sentence from the device. More...
  @@ -768,6 +771,29 @@ int 
Returns
Pointer to the last line string
+ + + +

◆ lastPosition()

+ +
+
+ + + + + + + +
gnss_position_t Adafruit_GPS::lastPosition () const
+
+ +

Decode the latest received sentence with exact coordinate precision.

+
Returns
Independent GGA/RMC/GLL position data and per-field status.
+

Call after read() completes a line. This does not acknowledge the receive flag, update legacy GPS fields, or merge data from earlier sentences. Use lastNMEA() to acknowledge the line and parse() to update legacy fields. Parsing a caller-supplied string does not replace the received sentence.

+

Check validation and each field's status; a valid fix flag does not imply populated coordinates. Exact components can be passed to Adafruit_GNSS::formatCoordinate() even when nmea_float_t is float. No stored fix or extra receive buffer is added. The result owns its values and survives subsequent input. Calls must be synchronized with read(), including when read() runs in an interrupt.

+

Before reception or after common_init(), returns INVALID_FRAME. Invalid complete lines return INVALID_FRAME; valid non-position sentences return UNSUPPORTED. Partial or oversized input preserves the last complete line.

+
diff --git a/html/functions.html b/html/functions.html index ec393be..39f2338 100644 --- a/html/functions.html +++ b/html/functions.html @@ -255,6 +255,7 @@ $(function() {
  • lastPosition() : Adafruit_GNSS +, Adafruit_GPS
  • lastSentence : Adafruit_GPS diff --git a/html/functions_func.html b/html/functions_func.html index 202ecb7..2471ba8 100644 --- a/html/functions_func.html +++ b/html/functions_func.html @@ -147,6 +147,7 @@ $(function() {
  • lastPosition() : Adafruit_GNSS +, Adafruit_GPS
  • lastSentence() : Adafruit_NMEA diff --git a/html/search/all_8.js b/html/search/all_8.js index 12f8cf0..a80cd5d 100644 --- a/html/search/all_8.js +++ b/html/search/all_8.js @@ -3,7 +3,7 @@ var searchData= ['label',['label',['../structnmea__datavalue__t.html#ad69698d60e94d53ad38c9b2b6f74547f',1,'nmea_datavalue_t']]], ['lasthistory',['lastHistory',['../structnmea__history__t.html#a44a9259e5426c52c809e44ae22d67fa6',1,'nmea_history_t']]], ['lastnmea',['lastNMEA',['../class_adafruit___g_p_s.html#a6938dadca5d72ec6e89e86a5b01b9b67',1,'Adafruit_GPS']]], - ['lastposition',['lastPosition',['../class_adafruit___g_n_s_s.html#aaf32a92103e32ef61379414c1b152c2a',1,'Adafruit_GNSS']]], + ['lastposition',['lastPosition',['../class_adafruit___g_n_s_s.html#aaf32a92103e32ef61379414c1b152c2a',1,'Adafruit_GNSS::lastPosition()'],['../class_adafruit___g_p_s.html#add173e9cb6547f3b265dd15491f893aa',1,'Adafruit_GPS::lastPosition()']]], ['lastsentence',['lastSentence',['../class_adafruit___g_p_s.html#a35d9d4c069a8ac93cbcbc98cf1c86ba0',1,'Adafruit_GPS::lastSentence()'],['../class_adafruit___n_m_e_a.html#a144bf137d190ef58c95ed1f170d2f6eb',1,'Adafruit_NMEA::lastSentence()']]], ['lastsource',['lastSource',['../class_adafruit___g_p_s.html#a8c44f113dda3b54b41a7d05f516c9ec0',1,'Adafruit_GPS']]], ['lasttext',['lastText',['../class_adafruit___n_m_e_a.html#a818739ffc3a6a2b9f93f0f72ef82e75e',1,'Adafruit_NMEA']]], diff --git a/html/search/functions_6.js b/html/search/functions_6.js index a8cbc33..a34f92a 100644 --- a/html/search/functions_6.js +++ b/html/search/functions_6.js @@ -1,7 +1,7 @@ var searchData= [ ['lastnmea',['lastNMEA',['../class_adafruit___g_p_s.html#a6938dadca5d72ec6e89e86a5b01b9b67',1,'Adafruit_GPS']]], - ['lastposition',['lastPosition',['../class_adafruit___g_n_s_s.html#aaf32a92103e32ef61379414c1b152c2a',1,'Adafruit_GNSS']]], + ['lastposition',['lastPosition',['../class_adafruit___g_n_s_s.html#aaf32a92103e32ef61379414c1b152c2a',1,'Adafruit_GNSS::lastPosition()'],['../class_adafruit___g_p_s.html#add173e9cb6547f3b265dd15491f893aa',1,'Adafruit_GPS::lastPosition()']]], ['lastsentence',['lastSentence',['../class_adafruit___n_m_e_a.html#a144bf137d190ef58c95ed1f170d2f6eb',1,'Adafruit_NMEA']]], ['lasttext',['lastText',['../class_adafruit___n_m_e_a.html#a818739ffc3a6a2b9f93f0f72ef82e75e',1,'Adafruit_NMEA']]], ['locus_5freadstatus',['LOCUS_ReadStatus',['../class_adafruit___g_p_s.html#adb6139e84c64156b5654dfce2a2e6e3f',1,'Adafruit_GPS']]],