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

Document time limits of secondsSince*() 

The values returned by Adafruit_GPS::secondsSince{Fix,Time,Date}()
wrap around if larger than 2^32 ms.
This commit is contained in:
Edgar Bonet 2020-02-21 21:04:56 +01:00
parent 939534d580
commit 76526b0b15
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/Adafruit_GPS.cpp
View File

@ -637,7 +637,10 @@ bool Adafruit_GPS::wakeup(void) {
/**************************************************************************/ /**************************************************************************/
/*! /*!
@brief Time in seconds since the last position fix was obtained. @brief Time in seconds since the last position fix was obtained. The
time returned is limited to 2^32 milliseconds, which is about 49.7 days.
It will wrap around to zero if no position fix is received
for this long.
@return nmea_float_t value in seconds since last fix. @return nmea_float_t value in seconds since last fix.
*/ */
/**************************************************************************/ /**************************************************************************/
@ -647,7 +650,9 @@ nmea_float_t Adafruit_GPS::secondsSinceFix() {
/**************************************************************************/ /**************************************************************************/
/*! /*!
@brief Time in seconds since the last GPS time was obtained. @brief Time in seconds since the last GPS time was obtained. The time
returned is limited to 2^32 milliseconds, which is about 49.7 days. It
will wrap around to zero if no GPS time is received for this long.
@return nmea_float_t value in seconds since last GPS time. @return nmea_float_t value in seconds since last GPS time.
*/ */
/**************************************************************************/ /**************************************************************************/
@ -657,7 +662,9 @@ nmea_float_t Adafruit_GPS::secondsSinceTime() {
/**************************************************************************/ /**************************************************************************/
/*! /*!
@brief Time in seconds since the last GPS date was obtained. @brief Time in seconds since the last GPS date was obtained. The time
returned is limited to 2^32 milliseconds, which is about 49.7 days. It
will wrap around to zero if no GPS date is received for this long.
@return nmea_float_t value in seconds since last GPS date. @return nmea_float_t value in seconds since last GPS date.
*/ */
/**************************************************************************/ /**************************************************************************/