Merge pull request #4 from sparkfun/ParserInLib

Parser in lib

Author: nseidle

examples/Example10_UsbNMEA/Example10_UsbNMEA.ino

@@ -0,0 +1,83 @@
+/*
+  Enable NMEA out COM1 (USB-C) for viewing in u-center (u-blox's software) or UPrecise (Unicore's software)
+  By: Nathan Seidle
+  SparkFun Electronics
+  Date: October 2nd, 2023
+  License: MIT. Please see LICENSE.md for more information.
+
+  This sketch turns on all the major NMEA setences at 2Hz and prints the
+  incoming serial out the Serial port. This is useful for viewing the GNSS
+  data in a program like u-center.
+  These examples are targeted for an ESP32 platform but any platform that has multiple
+  serial UARTs should be compatible.
+
+  Feel like supporting open source hardware?
+  Buy a board from SparkFun!
+  SparkFun Triband GNSS RTK Breakout - UM980 (GPS-23286) https://www.sparkfun.com/products/23286
+
+  Hardware Connections:
+  Connect RX2 of the UM980 to pin 4 on the ESP32
+  Connect TX2 of the UM980 to pin 13 on the ESP32
+  To make this easier, a 4-pin locking JST cable can be purchased here: https://www.sparkfun.com/products/17240
+  Note: Almost any ESP32 pins can be used for serial.
+  Connect a dual or triband GNSS antenna: https://www.sparkfun.com/products/21801
+*/
+
+int pin_UART1_TX = 4;
+int pin_UART1_RX = 13;
+
+#include <SparkFun_Unicore_GNSS_Arduino_Library.h> //http://librarymanager/All#SparkFun_Unicore_GNSS
+
+UM980 myGNSS;
+
+HardwareSerial SerialGNSS(1); //Use UART1 on the ESP32
+
+void setup()
+{
+  Serial.begin(115200);
+  delay(250);
+  Serial.println();
+  Serial.println("SparkFun UM980 Example");
+
+  //We must start the serial port before using it in the library
+  SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);
+
+  myGNSS.enableDebugging(); // Print all debug to Serial
+
+  if (myGNSS.begin(SerialGNSS) == false) //Give the serial port over to the library
+  {
+    Serial.println("UM980 failed to respond. Check ports and baud rates. Freezing...");
+    while (true);
+  }
+  Serial.println("UM980 detected!");
+
+  bool response = true;
+
+  //Turn off all NMEA, RTCM, and any other messages that may be reporting periodic
+  response &= myGNSS.disableOutput();
+
+  float outputRate = 0.5; //0.5 = 2 reports per second.
+
+  char comPort[] = "COM1";
+  response &= myGNSS.setNMEAPortMessage("GPGGA", comPort, outputRate);
+  response &= myGNSS.setNMEAPortMessage("GPGSA", comPort, outputRate);
+  response &= myGNSS.setNMEAPortMessage("GPGST", comPort, outputRate);
+  response &= myGNSS.setNMEAPortMessage("GPGSV", comPort, outputRate);
+  response &= myGNSS.setNMEAPortMessage("GPRMC", comPort, outputRate);
+  response &= myGNSS.saveConfiguration(); //Save the current configuration into non-volatile memory (NVM)
+
+  //If any one command fails, it will force response to false
+  if(response == false)
+  {
+    Serial.println("UM980 failed to configure. Freezing...");
+    while(true);
+  }
+
+  Serial.println("NMEA now reporting on USB-C serial port");
+}
+
+void loop()
+{
+  while(SerialGNSS.available())
+    Serial.write(SerialGNSS.read());
+}

examples/Example12_FactoryReset/Example12_FactoryReset.ino renamed to examples/Example11_FactoryReset/Example11_FactoryReset.ino

@@ -5,7 +5,7 @@
   Date: October 2nd, 2023
   License: MIT. Please see LICENSE.md for more information.
 
-  This example shows how set the UM980 back to defaults.
+  This example shows how to set the UM980 back to defaults.
   These examples are targeted for an ESP32 platform but any platform that has multiple
   serial UARTs should be compatible.
 
@@ -35,7 +35,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);
@@ -59,13 +59,15 @@ void setup()
   else
     Serial.println("Error resetting UM980 to factory defaults");
 
-  Serial.println("Waiting for device to reboot");
+  Serial.println("Waiting for UM980 to reboot");
+
   while (1)
   {
     delay(1000); //Wait for device to reboot
     if (myGNSS.isConnected() == true) break;
     else Serial.println("Device still rebooting");
   }
+
   Serial.println("UM980 has completed reset");
 
 

examples/Example13_SendCommand/Example13_SendCommand.ino renamed to examples/Example12_SendCommand/Example12_SendCommand.ino

@@ -37,7 +37,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);

examples/Example14_SetPPS/Example14_SetPPS.ino renamed to examples/Example13_SetPPS/Example13_SetPPS.ino

@@ -35,7 +35,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);

examples/Example15_PollForValidRTCMMessages/Example15_PollForValidRTCMMessages.ino renamed to examples/Example14_PollForValidRTCMMessages/Example14_PollForValidRTCMMessages.ino

@@ -43,7 +43,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);

examples/Example16_QueryDevice/Example16_QueryDevice.ino renamed to examples/Example15_QueryDevice/Example15_QueryDevice.ino

@@ -40,7 +40,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);
@@ -57,29 +57,49 @@ void setup()
 
 void loop()
 {
+  myGNSS.update(); //Regularly call to parse any new data
+
   if (millis() - lastCheck > 1000)
   {
     lastCheck = millis();
 
-    //This is the polling method and requires a slight delay (around 135ms)
-    //while the device responds to the request
+    //The get methods are updated whenever new data is parsed with the update() call.
+    //By default, this data is updated once per second.
 
     Serial.print("Lat/Long/Alt: ");
     Serial.print(myGNSS.getLatitude(), 11);
     Serial.print("/");
     Serial.print(myGNSS.getLongitude(), 11);
     Serial.print("/");
-    Serial.println(myGNSS.getAltitude(), 4);
+    Serial.print(myGNSS.getAltitude(), 4);
+    Serial.println();
+
+    Serial.print("Horizontal Speed: ");
+    Serial.print(myGNSS.getHorizontalSpeed());
+    Serial.print("m/s Vertical Speed: ");
+    Serial.print(myGNSS.getVerticalSpeed());
+    Serial.print("m/s Direction from North: ");
+    Serial.print(myGNSS.getTrackGround());
+    Serial.print("(degrees)");
+    Serial.println();
 
     Serial.print("Date (yyyy/mm/dd): ");
     Serial.print(myGNSS.getYear());
     Serial.print("/");
     Serial.print(myGNSS.getMonth());
     Serial.print("/");
-    Serial.println(myGNSS.getDay());
+    Serial.print(myGNSS.getDay());
+    Serial.print(" Time (hh:mm:dd): ");
+    Serial.print(myGNSS.getHour());
+    Serial.print(":");
+    Serial.print(myGNSS.getMinute());
+    Serial.print(":");
+    Serial.print(myGNSS.getSecond());
+    Serial.println();
 
     Serial.print("Satellites in view: ");
-    Serial.println(myGNSS.getSIV());
+    Serial.print(myGNSS.getSIV());
+    Serial.println();
 
     Serial.println();
   }

examples/Example1_PositionTime/Example1_PositionTime.ino renamed to examples/Example1_PositionVelocityTime/Example1_PositionVelocityTime.ino

@@ -37,7 +37,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);
@@ -54,7 +54,9 @@ void setup()
 
 void loop()
 {
-  if (millis() - lastCheck > 2000)
+  myGNSS.update(); //Regularly call to parse any new data
+
+  if (millis() - lastCheck > 1000)
   {
     lastCheck = millis();
 
@@ -153,9 +155,9 @@ void loop()
     Serial.print(pseudorangeCorrection);
     Serial.print(" - ");
     if (pseudorangeCorrection == 0) Serial.print("Unknown");
-    else if (pseudorangeCorrection == 0x01) Serial.print("Klobuchar broadcast ephemeris correction");
-    else if (pseudorangeCorrection == 0x10) Serial.print("SBAS ionospheric grid correction");
-    else if (pseudorangeCorrection == 0x11) Serial.print("Multi-frequency correction");
+    else if (pseudorangeCorrection == 0x001) Serial.print("Klobuchar broadcast ephemeris correction");
+    else if (pseudorangeCorrection == 0x010) Serial.print("SBAS ionospheric grid correction");
+    else if (pseudorangeCorrection == 0x011) Serial.print("Multi-frequency correction");
     else if (pseudorangeCorrection == 0x100) Serial.print("Pseudorange differential correction");
     else Serial.print("Unknown");
     Serial.println();

examples/Example2_ECEFAndStats/Example2_ECEFAndStats.ino

@@ -37,7 +37,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);
@@ -53,7 +53,7 @@ void setup()
 
   bool response = true;
 
-  //Turn off all NMEA, RTCM, and any other message that may be reporting periodically
+  //Turn off all NMEA, RTCM, and any other messages that may be reporting periodic
   response &= myGNSS.disableOutput();
 
   float outputRate = 0.5; //0.5 = 2 reports per second.
@@ -66,7 +66,7 @@ void setup()
   response &= myGNSS.setNMEAPortMessage("GPRMC", comPort, outputRate);
   response &= myGNSS.saveConfiguration(); //Save the current configuration into non-volatile memory (NVM)
 
-  //If any one command failed, it will force response to false
+  //If any one command fails, it will force response to false
   if(response == false)
   {
     Serial.println("UM980 failed to configure. Freezing...");

examples/Example2_UsbNMEA/Example2_UsbNMEA.ino

@@ -1,5 +1,5 @@
 /*
-  Setting messages on different ports on the UM980.
+  Enable NMEA messages on different ports on the UM980.
   By: Nathan Seidle
   SparkFun Electronics
   Date: October 2nd, 2023
@@ -9,6 +9,8 @@
   These examples are targeted for an ESP32 platform but any platform that has multiple
   serial UARTs should be compatible.
 
+  This example pipes all NMEA sentences to the UART.
+
   Feel like supporting open source hardware?
   Buy a board from SparkFun!
   SparkFun Triband GNSS RTK Breakout - UM980 (GPS-23286) https://www.sparkfun.com/products/23286
@@ -35,7 +37,7 @@ void setup()
   Serial.begin(115200);
   delay(250);
   Serial.println();
-  Serial.println("UM980 comm over ESP UART1");
+  Serial.println("SparkFun UM980 Example");
 
   //We must start the serial port before using it in the library
   SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);
@@ -49,10 +51,10 @@ void setup()
   }
   Serial.println("UM980 detected!");
 
-  //Set the output rate of NMEA messages. Users can set both of the message type and update rate.
+  //Set the output rate of NMEA messages. Users can set both the message type and update rate.
   //1, 0.5, 0.2, 0.1, 0.05 corresponds to 1Hz, 2Hz, 5Hz, 10Hz, 20Hz respectively.
   //1, 2, 5 corresponds to 1Hz, 0.5Hz, 0.2Hz respectively.
-  //Configure the port we are currently commuicating with on the UM980 (the ESP32 is connected to COM2)
+  //Configure the port we are currently communicating with on the UM980 (the ESP32 is connected to COM2)
   myGNSS.setNMEAMessage("GPGGA", 1); //Message type, 1 report per second.
   myGNSS.setNMEAMessage("GPGSA", 1); //Message type, 1 report per second.
   myGNSS.setNMEAMessage("GPGST", 1); //Message type, 1 report per second.