Skip to content
This repository was archived by the owner on Jan 28, 2021. It is now read-only.

Commit 7114584

Browse files
PaulZCPaulZC
authored
Merge pull request #133 from sparkfun/UBloxTextChange
Change Ublox to u-blox
2 parents 2816b95 + 872520b commit 7114584

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

‎library.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
name=SparkFun Ublox Arduino Library
1+
name=SparkFun u-blox Arduino Library
22
version=1.8.6
33
author=SparkFun Electronics <techsupport@sparkfun.com>
44
maintainer=SparkFun Electronics <sparkfun.com>
5-
sentence=Library for I2C and Serial Communication with Ublox modules
6-
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.
5+
sentence=Library for I2C and Serial Communication with u-blox modules
6+
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.
77
category=Sensors
88
url=https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
99
architectures=*

‎src/SparkFun_Ublox_Arduino_Library.cpp

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
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
33
SparkFun sells these at its website: www.sparkfun.com
44
Do you like this library? Help support SparkFun. Buy a board!
55
https://www.sparkfun.com/products/15136
@@ -11,7 +11,7 @@
1111
Written by Nathan Seidle @ SparkFun Electronics, September 6th, 2018
1212
1313
This library handles configuring and handling the responses
14-
from a Ublox GPS module. Works with most modules from Ublox including
14+
from a u-blox GPS module. Works with most modules from u-blox including
1515
the Zed-F9P, NEO-M8P-2, NEO-M9N, ZOE-M8Q, SAM-M8Q, and many others.
1616
1717
https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
@@ -239,7 +239,7 @@ void SFE_UBLOX_GPS::hardReset()
239239
sendCommand(&packetCfg, 0); // don't expect ACK
240240
}
241241

242-
//Changes the serial baud rate of the Ublox module, can't return success/fail 'cause ACK from modem
242+
//Changes the serial baud rate of the u-blox module, can't return success/fail 'cause ACK from modem
243243
//is lost due to baud rate change
244244
void SFE_UBLOX_GPS::setSerialRate(uint32_t baudrate, uint8_t uartPort, uint16_t maxWait)
245245
{
@@ -277,7 +277,7 @@ void SFE_UBLOX_GPS::setSerialRate(uint32_t baudrate, uint8_t uartPort, uint16_t
277277
}
278278
}
279279

280-
//Changes the I2C address that the Ublox module responds to
280+
//Changes the I2C address that the u-blox module responds to
281281
//0x42 is the default but can be changed with this command
282282
boolean SFE_UBLOX_GPS::setI2CAddress(uint8_t deviceAddress, uint16_t maxWait)
283283
{
@@ -343,10 +343,10 @@ boolean SFE_UBLOX_GPS::checkUbloxI2C(ubxPacket *incomingUBX, uint8_t requestedCl
343343
uint8_t lsb = _i2cPort->read();
344344
if (lsb == 0xFF)
345345
{
346-
//I believe this is a Ublox bug. Device should never present an 0xFF.
346+
//I believe this is a u-blox bug. Device should never present an 0xFF.
347347
if ((_printDebug == true) || (_printLimitedDebug == true)) // Print this if doing limited debugging
348348
{
349-
_debugSerial->println(F("checkUbloxI2C: Ublox bug, length lsb is 0xFF"));
349+
_debugSerial->println(F("checkUbloxI2C: u-blox bug, length lsb is 0xFF"));
350350
}
351351
if (checksumFailurePin >= 0)
352352
{
@@ -439,7 +439,7 @@ boolean SFE_UBLOX_GPS::checkUbloxI2C(ubxPacket *incomingUBX, uint8_t requestedCl
439439
{
440440
if ((_printDebug == true) || (_printLimitedDebug == true)) // Print this if doing limited debugging
441441
{
442-
_debugSerial->println(F("checkUbloxU2C: Ublox error, module not ready with data"));
442+
_debugSerial->println(F("checkUbloxU2C: u-blox error, module not ready with data"));
443443
}
444444
delay(5); //In logic analyzation, the module starting responding after 1.48ms
445445
if (checksumFailurePin >= 0)
@@ -1641,7 +1641,7 @@ boolean SFE_UBLOX_GPS::factoryDefault(uint16_t maxWait)
16411641

16421642
//Given a group, ID and size, return the value of this config spot
16431643
//The 32-bit key is put together from group/ID/size. See other getVal to send key directly.
1644-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1644+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
16451645
uint8_t SFE_UBLOX_GPS::getVal8(uint16_t group, uint16_t id, uint8_t size, uint8_t layer, uint16_t maxWait)
16461646
{
16471647
//Create key
@@ -1663,7 +1663,7 @@ uint8_t SFE_UBLOX_GPS::getVal8(uint16_t group, uint16_t id, uint8_t size, uint8_
16631663
//Given a key, return its value
16641664
//This function takes a full 32-bit key
16651665
//Default layer is BBR
1666-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1666+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
16671667
uint8_t SFE_UBLOX_GPS::getVal8(uint32_t key, uint8_t layer, uint16_t maxWait)
16681668
{
16691669
packetCfg.cls = UBX_CLASS_CFG;
@@ -1725,7 +1725,7 @@ uint8_t SFE_UBLOX_GPS::getVal8(uint32_t key, uint8_t layer, uint16_t maxWait)
17251725
//Given a key, set a 16-bit value
17261726
//This function takes a full 32-bit key
17271727
//Default layer is BBR
1728-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1728+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
17291729
uint8_t SFE_UBLOX_GPS::setVal(uint32_t key, uint16_t value, uint8_t layer, uint16_t maxWait)
17301730
{
17311731
return setVal16(key, value, layer, maxWait);
@@ -1734,7 +1734,7 @@ uint8_t SFE_UBLOX_GPS::setVal(uint32_t key, uint16_t value, uint8_t layer, uint1
17341734
//Given a key, set a 16-bit value
17351735
//This function takes a full 32-bit key
17361736
//Default layer is BBR
1737-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1737+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
17381738
uint8_t SFE_UBLOX_GPS::setVal16(uint32_t key, uint16_t value, uint8_t layer, uint16_t maxWait)
17391739
{
17401740
packetCfg.cls = UBX_CLASS_CFG;
@@ -1766,7 +1766,7 @@ uint8_t SFE_UBLOX_GPS::setVal16(uint32_t key, uint16_t value, uint8_t layer, uin
17661766
//Given a key, set an 8-bit value
17671767
//This function takes a full 32-bit key
17681768
//Default layer is BBR
1769-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1769+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
17701770
uint8_t SFE_UBLOX_GPS::setVal8(uint32_t key, uint8_t value, uint8_t layer, uint16_t maxWait)
17711771
{
17721772
packetCfg.cls = UBX_CLASS_CFG;
@@ -1797,7 +1797,7 @@ uint8_t SFE_UBLOX_GPS::setVal8(uint32_t key, uint8_t value, uint8_t layer, uint1
17971797
//Given a key, set a 32-bit value
17981798
//This function takes a full 32-bit key
17991799
//Default layer is BBR
1800-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1800+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
18011801
uint8_t SFE_UBLOX_GPS::setVal32(uint32_t key, uint32_t value, uint8_t layer, uint16_t maxWait)
18021802
{
18031803
packetCfg.cls = UBX_CLASS_CFG;
@@ -1831,7 +1831,7 @@ uint8_t SFE_UBLOX_GPS::setVal32(uint32_t key, uint32_t value, uint8_t layer, uin
18311831
//Start defining a new UBX-CFG-VALSET ubxPacket
18321832
//This function takes a full 32-bit key and 32-bit value
18331833
//Default layer is BBR
1834-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1834+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
18351835
uint8_t SFE_UBLOX_GPS::newCfgValset32(uint32_t key, uint32_t value, uint8_t layer)
18361836
{
18371837
packetCfg.cls = UBX_CLASS_CFG;
@@ -1865,7 +1865,7 @@ uint8_t SFE_UBLOX_GPS::newCfgValset32(uint32_t key, uint32_t value, uint8_t laye
18651865
//Start defining a new UBX-CFG-VALSET ubxPacket
18661866
//This function takes a full 32-bit key and 16-bit value
18671867
//Default layer is BBR
1868-
//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
1868+
//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
18691869
uint8_t SFE_UBLOX_GPS::newCfgValset16(uint32_t key, uint16_t value, uint8_t layer)
18701870
{
18711871
packetCfg.cls = UBX_CLASS_CFG;
@@ -1897,7 +1897,7 @@ uint8_t SFE_UBLOX_GPS::newCfgValset16(uint32_t key, uint16_t value, uint8_t laye
18971897
//Start defining a new UBX-CFG-VALSET ubxPacket
18981898
//This function takes a full 32-bit key and 8-bit value
18991899
//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
19011901
uint8_t SFE_UBLOX_GPS::newCfgValset8(uint32_t key, uint8_t value, uint8_t layer)
19021902
{
19031903
packetCfg.cls = UBX_CLASS_CFG;
@@ -3189,7 +3189,7 @@ uint16_t SFE_UBLOX_GPS::getPDOP(uint16_t maxWait)
31893189
return (pDOP);
31903190
}
31913191

3192-
//Get the current protocol version of the Ublox module we're communicating with
3192+
//Get the current protocol version of the u-blox module we're communicating with
31933193
//This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)
31943194
uint8_t SFE_UBLOX_GPS::getProtocolVersionHigh(uint16_t maxWait)
31953195
{
@@ -3198,7 +3198,7 @@ uint8_t SFE_UBLOX_GPS::getProtocolVersionHigh(uint16_t maxWait)
31983198
return (versionHigh);
31993199
}
32003200

3201-
//Get the current protocol version of the Ublox module we're communicating with
3201+
//Get the current protocol version of the u-blox module we're communicating with
32023202
//This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)
32033203
uint8_t SFE_UBLOX_GPS::getProtocolVersionLow(uint16_t maxWait)
32043204
{
@@ -3207,7 +3207,7 @@ uint8_t SFE_UBLOX_GPS::getProtocolVersionLow(uint16_t maxWait)
32073207
return (versionLow);
32083208
}
32093209

3210-
//Get the current protocol version of the Ublox module we're communicating with
3210+
//Get the current protocol version of the u-blox module we're communicating with
32113211
//This is helpful when deciding if we should call the high-precision Lat/Long (HPPOSLLH) or the regular (POSLLH)
32123212
boolean SFE_UBLOX_GPS::getProtocolVersion(uint16_t maxWait)
32133213
{

‎src/SparkFun_Ublox_Arduino_Library.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
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
33
SparkFun sells these at its website: www.sparkfun.com
44
Do you like this library? Help support SparkFun. Buy a board!
55
https://www.sparkfun.com/products/15136
@@ -11,7 +11,7 @@
1111
Written by Nathan Seidle @ SparkFun Electronics, September 6th, 2018
1212
1313
This library handles configuring and handling the responses
14-
from a Ublox GPS module. Works with most modules from Ublox including
14+
from a u-blox GPS module. Works with most modules from u-blox including
1515
the Zed-F9P, NEO-M8P-2, NEO-M9N, ZOE-M8Q, SAM-M8Q, and many others.
1616
1717
https://github.com/sparkfun/SparkFun_Ublox_Arduino_Library
@@ -154,9 +154,9 @@ const uint8_t UBX_CFG_SBAS = 0x16; //SBAS configuration
154154
const uint8_t UBX_CFG_TMODE3 = 0x71; //Time Mode Settings 3. Used to enable Survey In Mode
155155
const uint8_t UBX_CFG_TP5 = 0x31; //Time Pulse Parameters
156156
const uint8_t UBX_CFG_USB = 0x1B; //USB Configuration
157-
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
158-
const uint8_t UBX_CFG_VALGET = 0x8B; //Used for config of higher version Ublox modules (ie protocol v27 and above). Configuration Items
159-
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.
157+
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
158+
const uint8_t UBX_CFG_VALGET = 0x8B; //Used for config of higher version u-blox modules (ie protocol v27 and above). Configuration Items
159+
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.
160160

161161
//The following are used to enable NMEA messages. Descriptions come from the NMEA messages overview in the ZED-F9P Interface Description
162162
const uint8_t UBX_NMEA_MSB = 0xF0; //All NMEA enable commands have 0xF0 as MSB
@@ -461,7 +461,7 @@ class SFE_UBLOX_GPS
461461
//Control the size of the internal I2C transaction amount
462462
void setI2CTransactionSize(uint8_t bufferSize);
463463
uint8_t getI2CTransactionSize(void);
464-
464+
465465
//Set the max number of bytes set in a given I2C transaction
466466
uint8_t i2cTransactionSize = 32; //Default to ATmega328 limit
467467

@@ -494,8 +494,8 @@ class SFE_UBLOX_GPS
494494
void factoryReset(); //Send factory reset sequence (i.e. load "default" configuration and perform hardReset)
495495
void hardReset(); //Perform a reset leading to a cold start (zero info start-up)
496496

497-
boolean setI2CAddress(uint8_t deviceAddress, uint16_t maxTime = 250); //Changes the I2C address of the Ublox module
498-
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
497+
boolean setI2CAddress(uint8_t deviceAddress, uint16_t maxTime = 250); //Changes the I2C address of the u-blox module
498+
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
499499
void setNMEAOutputPort(Stream &nmeaOutputPort); //Sets the internal variable for the port to direct NMEA characters to
500500

501501
boolean setNavigationFrequency(uint8_t navFreq, uint16_t maxWait = defaultMaxWait); //Set the number of nav solutions sent per second

0 commit comments

Comments
 (0)