Merge branch 'release_candidate' into Expand-getVal-setVal

PaulZC · web-flow · commit 30bff51d82db · 2020-10-26T15:29:56.000Z
diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
-name=SparkFun Ublox Arduino Library
+name=SparkFun u-blox Arduino Library
 version=1.8.6
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
-sentence=Library for I2C and Serial Communication with Ublox modules
-paragraph=An Arduino Library to enable both I2C and Serial communication for both NMEA reception and binary UBX sending to the module. Useful for interfacing to the <a href="https://www.sparkfun.com/products/15136">SparkFun GPS-RTK2</a> ZED-F9P, <a href="https://www.sparkfun.com/products/14980">SparkFun GPS-RTK</a> NEO-M8P-2, the <a href="https://www.sparkfun.com/products/15210">SparkFun SAM-M8Q</a>, and the <a href="https://www.sparkfun.com/products/15193">SparkFun ZEO-M8Q</a>. Library also works with other Ublox based boards. <br><br>The ZED-F9P and NEO-M8P-2 modules are top-of-the-line modules for high accuracy GNSS and GPS location solutions including RTK. The ZED-F9P is unique in that it is capable of both rover and base station operations allowing the module to become a base station and produce RTCM 3.x correction data.
+sentence=Library for I2C and Serial Communication with u-blox modules
+paragraph=An Arduino Library to enable both I2C and Serial communication for both NMEA reception and binary UBX sending to u-blox modules. Useful for interfacing to the <a href="https://www.sparkfun.com/products/15136">SparkFun GPS-RTK2</a> ZED-F9P, <a href="https://www.sparkfun.com/products/14980">SparkFun GPS-RTK</a> NEO-M8P-2, the <a href="https://www.sparkfun.com/products/15210">SparkFun SAM-M8Q</a>, and the <a href="https://www.sparkfun.com/products/15193">SparkFun ZEO-M8Q</a>. Library also works with other u-lox based boards. <br><br>The ZED-F9P and NEO-M8P-2 modules are top-of-the-line modules for high accuracy GNSS and GPS location solutions including RTK. The ZED-F9P is unique in that it is capable of both rover and base station operations allowing the module to become a base station and produce RTCM 3.x correction data.
 category=Sensors
 url=https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
 architectures=*
diff --git a/src/SparkFun_Ublox_Arduino_Library.cpp b/src/SparkFun_Ublox_Arduino_Library.cpp
@@ -1,5 +1,5 @@
 /*
-	This is a library written for the Ublox ZED-F9P and NEO-M8P-2
+	This is a library written for the u-blox ZED-F9P and NEO-M8P-2
 	SparkFun sells these at its website: www.sparkfun.com
 	Do you like this library? Help support SparkFun. Buy a board!
 	https://www.sparkfun.com/products/16481
@@ -12,7 +12,7 @@
 	Written by Nathan Seidle @ SparkFun Electronics, September 6th, 2018
 
 	This library handles configuring and handling the responses
-	from a Ublox GPS module. Works with most modules from Ublox including
+	from a u-blox GPS module. Works with most modules from u-blox including
 	the Zed-F9P, NEO-M8P-2, NEO-M9N, ZOE-M8Q, SAM-M8Q, and many others.
 
 	https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
@@ -240,7 +240,7 @@ void SFE_UBLOX_GPS::hardReset()
   sendCommand(&packetCfg, 0); // don't expect ACK
 }
 
-//Changes the serial baud rate of the Ublox module, can't return success/fail 'cause ACK from modem
+//Changes the serial baud rate of the u-blox module, can't return success/fail 'cause ACK from modem
 //is lost due to baud rate change
 void SFE_UBLOX_GPS::setSerialRate(uint32_t baudrate, uint8_t uartPort, uint16_t maxWait)
 {
@@ -278,7 +278,7 @@ void SFE_UBLOX_GPS::setSerialRate(uint32_t baudrate, uint8_t uartPort, uint16_t
   }
 }
 
-//Changes the I2C address that the Ublox module responds to
+//Changes the I2C address that the u-blox module responds to
 //0x42 is the default but can be changed with this command
 boolean SFE_UBLOX_GPS::setI2CAddress(uint8_t deviceAddress, uint16_t maxWait)
 {
@@ -344,10 +344,10 @@ boolean SFE_UBLOX_GPS::checkUbloxI2C(ubxPacket *incomingUBX, uint8_t requestedCl
       uint8_t lsb = _i2cPort->read();
       if (lsb == 0xFF)
       {
-        //I believe this is a Ublox bug. Device should never present an 0xFF.
+        //I believe this is a u-blox bug. Device should never present an 0xFF.
         if ((_printDebug == true) || (_printLimitedDebug == true)) // Print this if doing limited debugging
         {
-          _debugSerial->println(F("checkUbloxI2C: Ublox bug, length lsb is 0xFF"));
+          _debugSerial->println(F("checkUbloxI2C: u-blox bug, length lsb is 0xFF"));
         }
         if (checksumFailurePin >= 0)
         {
@@ -440,7 +440,7 @@ boolean SFE_UBLOX_GPS::checkUbloxI2C(ubxPacket *incomingUBX, uint8_t requestedCl
             {
               if ((_printDebug == true) || (_printLimitedDebug == true)) // Print this if doing limited debugging
               {
-                _debugSerial->println(F("checkUbloxU2C: Ublox error, module not ready with data"));
+                _debugSerial->println(F("checkUbloxU2C: u-blox error, module not ready with data"));
               }
               delay(5); //In logic analyzation, the module starting responding after 1.48ms
               if (checksumFailurePin >= 0)
@@ -1863,7 +1863,7 @@ uint8_t SFE_UBLOX_GPS::setVal32(uint32_t key, uint32_t value, uint8_t layer, uin
 //Start defining a new UBX-CFG-VALSET ubxPacket
 //This function takes a full 32-bit key and 32-bit value
 //Default layer is BBR
-//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GPS::newCfgValset32(uint32_t key, uint32_t value, uint8_t layer)
 {
   packetCfg.cls = UBX_CLASS_CFG;
@@ -1897,7 +1897,7 @@ uint8_t SFE_UBLOX_GPS::newCfgValset32(uint32_t key, uint32_t value, uint8_t laye
 //Start defining a new UBX-CFG-VALSET ubxPacket
 //This function takes a full 32-bit key and 16-bit value
 //Default layer is BBR
-//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GPS::newCfgValset16(uint32_t key, uint16_t value, uint8_t layer)
 {
   packetCfg.cls = UBX_CLASS_CFG;
@@ -1929,7 +1929,7 @@ uint8_t SFE_UBLOX_GPS::newCfgValset16(uint32_t key, uint16_t value, uint8_t laye
 //Start defining a new UBX-CFG-VALSET ubxPacket
 //This function takes a full 32-bit key and 8-bit value
 //Default layer is BBR
-//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GPS::newCfgValset8(uint32_t key, uint8_t value, uint8_t layer)
 {
   packetCfg.cls = UBX_CLASS_CFG;
@@ -3221,7 +3221,7 @@ uint16_t SFE_UBLOX_GPS::getPDOP(uint16_t maxWait)
   return (pDOP);
 }
 
-//Get the current protocol version of the Ublox module we're communicating with
+//Get the current protocol version of the u-blox module we're communicating with
 //This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)
 uint8_t SFE_UBLOX_GPS::getProtocolVersionHigh(uint16_t maxWait)
 {
@@ -3230,7 +3230,7 @@ uint8_t SFE_UBLOX_GPS::getProtocolVersionHigh(uint16_t maxWait)
   return (versionHigh);
 }
 
-//Get the current protocol version of the Ublox module we're communicating with
+//Get the current protocol version of the u-blox module we're communicating with
 //This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)
 uint8_t SFE_UBLOX_GPS::getProtocolVersionLow(uint16_t maxWait)
 {
@@ -3239,7 +3239,7 @@ uint8_t SFE_UBLOX_GPS::getProtocolVersionLow(uint16_t maxWait)
   return (versionLow);
 }
 
-//Get the current protocol version of the Ublox module we're communicating with
+//Get the current protocol version of the u-blox module we're communicating with
 //This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)
 boolean SFE_UBLOX_GPS::getProtocolVersion(uint16_t maxWait)
 {
diff --git a/src/SparkFun_Ublox_Arduino_Library.h b/src/SparkFun_Ublox_Arduino_Library.h
@@ -1,5 +1,5 @@
 /*
-	This is a library written for the Ublox ZED-F9P and NEO-M8P-2
+	This is a library written for the u-blox ZED-F9P and NEO-M8P-2
 	SparkFun sells these at its website: www.sparkfun.com
 	Do you like this library? Help support SparkFun. Buy a board!
 	https://www.sparkfun.com/products/16481
@@ -12,7 +12,7 @@
 	Written by Nathan Seidle @ SparkFun Electronics, September 6th, 2018
 
 	This library handles configuring and handling the responses
-	from a Ublox GPS module. Works with most modules from Ublox including
+	from a u-blox GPS module. Works with most modules from u-blox including
 	the Zed-F9P, NEO-M8P-2, NEO-M9N, ZOE-M8Q, SAM-M8Q, and many others.
 
 	https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
@@ -157,9 +157,9 @@ const uint8_t UBX_CFG_SBAS = 0x16;		//SBAS configuration
 const uint8_t UBX_CFG_TMODE3 = 0x71;	//Time Mode Settings 3. Used to enable Survey In Mode
 const uint8_t UBX_CFG_TP5 = 0x31;		//Time Pulse Parameters
 const uint8_t UBX_CFG_USB = 0x1B;		//USB Configuration
-const uint8_t UBX_CFG_VALDEL = 0x8C;	//Used for config of higher version Ublox modules (ie protocol v27 and above). Deletes values corresponding to provided keys/ provided keys with a transaction
-const uint8_t UBX_CFG_VALGET = 0x8B;	//Used for config of higher version Ublox modules (ie protocol v27 and above). Configuration Items
-const uint8_t UBX_CFG_VALSET = 0x8A;	//Used for config of higher version Ublox modules (ie protocol v27 and above). Sets values corresponding to provided key-value pairs/ provided key-value pairs within a transaction.
+const uint8_t UBX_CFG_VALDEL = 0x8C;	//Used for config of higher version u-blox modules (ie protocol v27 and above). Deletes values corresponding to provided keys/ provided keys with a transaction
+const uint8_t UBX_CFG_VALGET = 0x8B;	//Used for config of higher version u-blox modules (ie protocol v27 and above). Configuration Items
+const uint8_t UBX_CFG_VALSET = 0x8A;	//Used for config of higher version u-blox modules (ie protocol v27 and above). Sets values corresponding to provided key-value pairs/ provided key-value pairs within a transaction.
 
 //The following are used to enable NMEA messages. Descriptions come from the NMEA messages overview in the ZED-F9P Interface Description
 const uint8_t UBX_NMEA_MSB = 0xF0;	//All NMEA enable commands have 0xF0 as MSB
@@ -471,8 +471,8 @@ class SFE_UBLOX_GPS
 	void factoryReset(); //Send factory reset sequence (i.e. load "default" configuration and perform hardReset)
 	void hardReset();	 //Perform a reset leading to a cold start (zero info start-up)
 
-	boolean setI2CAddress(uint8_t deviceAddress, uint16_t maxTime = 250);										 //Changes the I2C address of the Ublox module
-	void setSerialRate(uint32_t baudrate, uint8_t uartPort = COM_PORT_UART1, uint16_t maxTime = defaultMaxWait); //Changes the serial baud rate of the Ublox module, uartPort should be COM_PORT_UART1/2
+	boolean setI2CAddress(uint8_t deviceAddress, uint16_t maxTime = 250);										 //Changes the I2C address of the u-blox module
+	void setSerialRate(uint32_t baudrate, uint8_t uartPort = COM_PORT_UART1, uint16_t maxTime = defaultMaxWait); //Changes the serial baud rate of the u-blox module, uartPort should be COM_PORT_UART1/2
 	void setNMEAOutputPort(Stream &nmeaOutputPort);																 //Sets the internal variable for the port to direct NMEA characters to
 
 	boolean setNavigationFrequency(uint8_t navFreq, uint16_t maxWait = defaultMaxWait);	 //Set the number of nav solutions sent per second

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- This is a library written for the Ublox ZED-F9P and NEO-M8P-2`
	`2`	`+ This is a library written for the u-blox ZED-F9P and NEO-M8P-2`
`3`	`3`	`SparkFun sells these at its website: www.sparkfun.com`
`4`	`4`	`Do you like this library? Help support SparkFun. Buy a board!`
`5`	`5`	`https://www.sparkfun.com/products/16481`
`@@ -12,7 +12,7 @@`
`12`	`12`	`Written by Nathan Seidle @ SparkFun Electronics, September 6th, 2018`
`13`	`13`
`14`	`14`	`This library handles configuring and handling the responses`
`15`		`- from a Ublox GPS module. Works with most modules from Ublox including`
	`15`	`+ from a u-blox GPS module. Works with most modules from u-blox including`
`16`	`16`	`the Zed-F9P, NEO-M8P-2, NEO-M9N, ZOE-M8Q, SAM-M8Q, and many others.`
`17`	`17`
`18`	`18`	`https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library`
`@@ -240,7 +240,7 @@ void SFE_UBLOX_GPS::hardReset()`
`240`	`240`	`sendCommand(&packetCfg, 0); // don't expect ACK`
`241`	`241`	`}`
`242`	`242`
`243`		`-//Changes the serial baud rate of the Ublox module, can't return success/fail 'cause ACK from modem`
	`243`	`+//Changes the serial baud rate of the u-blox module, can't return success/fail 'cause ACK from modem`
`244`	`244`	`//is lost due to baud rate change`
`245`	`245`	`void SFE_UBLOX_GPS::setSerialRate(uint32_t baudrate, uint8_t uartPort, uint16_t maxWait)`
`246`	`246`	`{`
`@@ -278,7 +278,7 @@ void SFE_UBLOX_GPS::setSerialRate(uint32_t baudrate, uint8_t uartPort, uint16_t`
`278`	`278`	`}`
`279`	`279`	`}`
`280`	`280`
`281`		`-//Changes the I2C address that the Ublox module responds to`
	`281`	`+//Changes the I2C address that the u-blox module responds to`
`282`	`282`	`//0x42 is the default but can be changed with this command`
`283`	`283`	`boolean SFE_UBLOX_GPS::setI2CAddress(uint8_t deviceAddress, uint16_t maxWait)`
`284`	`284`	`{`
`@@ -344,10 +344,10 @@ boolean SFE_UBLOX_GPS::checkUbloxI2C(ubxPacket *incomingUBX, uint8_t requestedCl`
`344`	`344`	`uint8_t lsb = _i2cPort->read();`
`345`	`345`	`if (lsb == 0xFF)`
`346`	`346`	`{`
`347`		`- //I believe this is a Ublox bug. Device should never present an 0xFF.`
	`347`	`+ //I believe this is a u-blox bug. Device should never present an 0xFF.`
`348`	`348`	`if ((_printDebug == true) \|\| (_printLimitedDebug == true)) // Print this if doing limited debugging`
`349`	`349`	`{`
`350`		`- _debugSerial->println(F("checkUbloxI2C: Ublox bug, length lsb is 0xFF"));`
	`350`	`+ _debugSerial->println(F("checkUbloxI2C: u-blox bug, length lsb is 0xFF"));`
`351`	`351`	`}`
`352`	`352`	`if (checksumFailurePin >= 0)`
`353`	`353`	`{`
`@@ -440,7 +440,7 @@ boolean SFE_UBLOX_GPS::checkUbloxI2C(ubxPacket *incomingUBX, uint8_t requestedCl`
`440`	`440`	`{`
`441`	`441`	`if ((_printDebug == true) \|\| (_printLimitedDebug == true)) // Print this if doing limited debugging`
`442`	`442`	`{`
`443`		`- _debugSerial->println(F("checkUbloxU2C: Ublox error, module not ready with data"));`
	`443`	`+ _debugSerial->println(F("checkUbloxU2C: u-blox error, module not ready with data"));`
`444`	`444`	`}`
`445`	`445`	`delay(5); //In logic analyzation, the module starting responding after 1.48ms`
`446`	`446`	`if (checksumFailurePin >= 0)`
`@@ -1863,7 +1863,7 @@ uint8_t SFE_UBLOX_GPS::setVal32(uint32_t key, uint32_t value, uint8_t layer, uin`
`1863`	`1863`	`//Start defining a new UBX-CFG-VALSET ubxPacket`
`1864`	`1864`	`//This function takes a full 32-bit key and 32-bit value`
`1865`	`1865`	`//Default layer is BBR`
`1866`		`-//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P`
	`1866`	`+//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P`
`1867`	`1867`	`uint8_t SFE_UBLOX_GPS::newCfgValset32(uint32_t key, uint32_t value, uint8_t layer)`
`1868`	`1868`	`{`
`1869`	`1869`	`packetCfg.cls = UBX_CLASS_CFG;`
`@@ -1897,7 +1897,7 @@ uint8_t SFE_UBLOX_GPS::newCfgValset32(uint32_t key, uint32_t value, uint8_t laye`
`1897`	`1897`	`//Start defining a new UBX-CFG-VALSET ubxPacket`
`1898`	`1898`	`//This function takes a full 32-bit key and 16-bit value`
`1899`	`1899`	`//Default layer is BBR`
`1900`		`-//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P`
	`1900`	`+//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P`
`1901`	`1901`	`uint8_t SFE_UBLOX_GPS::newCfgValset16(uint32_t key, uint16_t value, uint8_t layer)`
`1902`	`1902`	`{`
`1903`	`1903`	`packetCfg.cls = UBX_CLASS_CFG;`
`@@ -1929,7 +1929,7 @@ uint8_t SFE_UBLOX_GPS::newCfgValset16(uint32_t key, uint16_t value, uint8_t laye`
`1929`	`1929`	`//Start defining a new UBX-CFG-VALSET ubxPacket`
`1930`	`1930`	`//This function takes a full 32-bit key and 8-bit value`
`1931`	`1931`	`//Default layer is BBR`
`1932`		`-//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P`
	`1932`	`+//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P`
`1933`	`1933`	`uint8_t SFE_UBLOX_GPS::newCfgValset8(uint32_t key, uint8_t value, uint8_t layer)`
`1934`	`1934`	`{`
`1935`	`1935`	`packetCfg.cls = UBX_CLASS_CFG;`
`@@ -3221,7 +3221,7 @@ uint16_t SFE_UBLOX_GPS::getPDOP(uint16_t maxWait)`
`3221`	`3221`	`return (pDOP);`
`3222`	`3222`	`}`
`3223`	`3223`
`3224`		`-//Get the current protocol version of the Ublox module we're communicating with`
	`3224`	`+//Get the current protocol version of the u-blox module we're communicating with`
`3225`	`3225`	`//This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)`
`3226`	`3226`	`uint8_t SFE_UBLOX_GPS::getProtocolVersionHigh(uint16_t maxWait)`
`3227`	`3227`	`{`
`@@ -3230,7 +3230,7 @@ uint8_t SFE_UBLOX_GPS::getProtocolVersionHigh(uint16_t maxWait)`
`3230`	`3230`	`return (versionHigh);`
`3231`	`3231`	`}`
`3232`	`3232`
`3233`		`-//Get the current protocol version of the Ublox module we're communicating with`
	`3233`	`+//Get the current protocol version of the u-blox module we're communicating with`
`3234`	`3234`	`//This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)`
`3235`	`3235`	`uint8_t SFE_UBLOX_GPS::getProtocolVersionLow(uint16_t maxWait)`
`3236`	`3236`	`{`
`@@ -3239,7 +3239,7 @@ uint8_t SFE_UBLOX_GPS::getProtocolVersionLow(uint16_t maxWait)`
`3239`	`3239`	`return (versionLow);`
`3240`	`3240`	`}`
`3241`	`3241`
`3242`		`-//Get the current protocol version of the Ublox module we're communicating with`
	`3242`	`+//Get the current protocol version of the u-blox module we're communicating with`
`3243`	`3243`	`//This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)`
`3244`	`3244`	`boolean SFE_UBLOX_GPS::getProtocolVersion(uint16_t maxWait)`
`3245`	`3245`	`{`