Adding examples

Author: nseidle

examples/Example1_BasicNMEARead/Example1_BasicNMEARead.ino

@@ -29,19 +29,16 @@ SFE_UBLOX_GPS myGPS;
 void setup()
 {
   Serial.begin(115200);
-  Serial.println("Ublox GPS I2C Test");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
 
-  myGPS.begin();
-  if (myGPS.isConnected() == false)
+  if (myGPS.begin() == false)
   {
     Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
     while (1);
   }
 
-  Wire.setClock(400000); //Increase I2C clock speed to 400kHz
-
   //This will pipe all NMEA sentences to the serial port so we can see them
   myGPS.setNMEAOutputPort(Serial);
 }

examples/Example2_NMEAParsing/Example2_NMEAParsing.ino

@@ -36,18 +36,15 @@ MicroNMEA nmea(nmeaBuffer, sizeof(nmeaBuffer));
 void setup()
 {
   Serial.begin(115200);
-  Serial.println("Ublox GPS I2C Test");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
 
-  myGPS.begin();
-  if (myGPS.isConnected() == false)
+  if (myGPS.begin() == false)
   {
     Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
     while (1);
   }
-
-  Wire.setClock(400000); //Increase I2C clock speed to 400kHz
 }
 
 void loop()

examples/Example3_GetPosition/Example3_GetPosition.ino

@@ -9,7 +9,7 @@
   This example shows how to query a Ublox module for its lat/long/altitude. 
 
   Note: Long/lat are large numbers because they are * 10^7. To convert lat/long
-  to something google maps understands simply divide the numbers by 1,000,000. We 
+  to something google maps understands simply divide the numbers by 10,000,000. We 
   do this so that we don't have to use floating point numbers.
 
   Leave NMEA parsing behind. Now you can simply ask the module for the datums you want!
@@ -31,13 +31,13 @@
 #include "SparkFun_Ublox_Arduino_Library.h" //http://librarymanager/All#SparkFun_Ublox_GPS
 SFE_UBLOX_GPS myGPS;
 
-long lastTime = 0; //Tracks the passing of 2000ms (2 seconds)
+long lastTime = 0; //Simple local timer. Limits amount if I2C traffic to Ublox module.
 
 void setup()
 {
   Serial.begin(115200);
   while (!Serial); //Wait for user to open terminal
-  Serial.println("Reading Lat/Long Example");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
 
@@ -66,7 +66,7 @@ void loop()
     Serial.print(F(" (degrees * 10^-7)"));
 
     long altitude = myGPS.getAltitude();
-    Serial.print(F(" Alt (above mean sea level): "));
+    Serial.print(F(" Alt: "));
     Serial.print(altitude);
     Serial.print(F(" (mm)"));
 

examples/Example4_FixType/Example4_FixType.ino

@@ -43,7 +43,7 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial); //Wait for user to open terminal
-  Serial.println("Reading Lat/Long Example");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
   Wire.setClock(400000); //Optional. Increase I2C clock speed to 400kHz.

examples/Example5_SpeedHeadingPrecision/Example5_SpeedHeadingPrecision.ino

@@ -37,7 +37,7 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial); //Wait for user to open terminal
-  Serial.println("Reading Lat/Long Example");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
 

examples/Example6_OutputRate/Example6_OutputRate.ino

@@ -40,7 +40,7 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial); //Wait for user to open terminal
-  Serial.println("Reading Lat/Long Example");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
   Wire.setClock(400000);

examples/Example8_GetProtocolVersion/Example8_GetProtocolVersion.ino renamed to examples/Example7_GetProtocolVersion/Example7_GetProtocolVersion.ino

@@ -37,7 +37,7 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial); //Wait for user to open terminal
-  Serial.println("Reading Lat/Long Example");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
 
@@ -51,8 +51,8 @@ void setup()
   byte versionHigh = myGPS.getProtocolVersionHigh();
   Serial.print(versionHigh);
   Serial.print(".");
-  //byte versionLow = myGPS.getProtocolVersionLow();
-  //Serial.print(versionLow);
+  byte versionLow = myGPS.getProtocolVersionLow();
+  Serial.print(versionLow);
 }
 
 void loop()

examples/Example8_ChangeI2CAddress/Example8_ChangeI2CAddress.ino

@@ -31,7 +31,7 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial); //Wait for user to open terminal
-  Serial.println("Reading Lat/Long Example");
+  Serial.println("SparkFun Ublox Example");
 
   Wire.begin();
 

examples/Example9_All/Example9_All.ino

@@ -26,7 +26,7 @@
 #include "SparkFun_Ublox_Arduino_Library.h" //http://librarymanager/All#SparkFun_Ublox_GPS
 SFE_UBLOX_GPS myGPS;
 
-long lastTime = 0; //Tracks the passing of 2000ms (2 seconds)
+long lastTime = 0; //Simple local timer. Limits amount if I2C traffic to Ublox module.
 
 void setup()
 {

examples/Example9_AltitudeMSL/Example9_AltitudeMSL.ino

@@ -0,0 +1,82 @@
+/*
+  Reading two altitudes - Mean Sea Level and Ellipsode
+  By: Nathan Seidle
+  SparkFun Electronics
+  Date: January 3rd, 2019
+  License: MIT. See license file for more information but you can
+  basically do whatever you want with this code.
+
+  This example shows how to query a Ublox module for its lat/long/altitude. 
+
+  getAltitude() reports mm above ellipsode model of the globe. There are some
+  instances where altitude above Mean Sea Level is better. This example shows how 
+  to use getAltitudeMSL(). The difference varies but is ~20m.
+  Ellipsoid model: https://www.esri.com/news/arcuser/0703/geoid1of3.html
+  Difference between Ellipsoid Model and Mean Sea Level: https://eos-gnss.com/elevation-for-beginners/
+  
+  Leave NMEA parsing behind. Now you can simply ask the module for the datums you want!
+
+  Feel like supporting open source hardware?
+  Buy a board from SparkFun!
+  ZED-F9P RTK2: https://www.sparkfun.com/products/15136
+  NEO-M8P RTK: https://www.sparkfun.com/products/15005
+  SAM-M8Q: https://www.sparkfun.com/products/15106
+
+  Hardware Connections:
+  Plug a Qwiic cable into the GPS and a BlackBoard
+  If you don't have a platform with a Qwiic connection use the SparkFun Qwiic Breadboard Jumper (https://www.sparkfun.com/products/14425)
+  Open the serial monitor at 115200 baud to see the output
+*/
+
+#include <Wire.h> //Needed for I2C to GPS
+
+#include "SparkFun_Ublox_Arduino_Library.h" //http://librarymanager/All#SparkFun_Ublox_GPS
+SFE_UBLOX_GPS myGPS;
+
+long lastTime = 0; //Tracks the passing of 2000ms (2 seconds)
+
+void setup()
+{
+  Serial.begin(115200);
+  while (!Serial); //Wait for user to open terminal
+  Serial.println("SparkFun Ublox Example");
+
+  Wire.begin();
+
+  if (myGPS.begin() == false) //Connect to the Ublox module using Wire port
+  {
+    Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
+    while (1);
+  }
+}
+
+void loop()
+{
+  //Query module only every second. Doing it more often will just cause I2C traffic.
+  //The module only responds when a new position is available
+  if (millis() - lastTime > 1000)
+  {
+    lastTime = millis(); //Update the timer
+    
+    long latitude = myGPS.getLatitude();
+    Serial.print(F("Lat: "));
+    Serial.print(latitude);
+
+    long longitude = myGPS.getLongitude();
+    Serial.print(F(" Long: "));
+    Serial.print(longitude);
+    Serial.print(F(" (degrees * 10^-7)"));
+
+    long altitude = myGPS.getAltitude();
+    Serial.print(F(" Alt: "));
+    Serial.print(altitude);
+    Serial.print(F(" (mm)"));
+
+    long altitudeMSL = myGPS.getAltitudeMSL();
+    Serial.print(F(" AltMSL: "));
+    Serial.print(altitudeMSL);
+    Serial.print(F(" (mm)"));
+
+    Serial.println();
+  }
+}