Adding extra Data Logging examples

Author: PaulZC

examples/Callbacks/CallbackExample5_ESF/CallbackExample5_ESF.ino

@@ -80,13 +80,13 @@ void printESFMEASdata(UBX_ESF_MEAS_data_t ubxDataStruct)
   Serial.print(F(" numMeas: "));
   Serial.println(ubxDataStruct.flags.bits.numMeas);
 
-  for (uint8_t num = 0; num < ubxDataStruct.flags.bits.numMeas; num++)
+  for (uint8_t num = 0; num < ubxDataStruct.flags.bits.numMeas; num++) // For each sensor
   {
     Serial.print(F("Sensor "));
     Serial.print(num);
 
     UBX_ESF_MEAS_sensorData_t sensorData;
-    myGPS.getSensorFusionMeasurement(&sensorData, ubxDataStruct, num);
+    myGPS.getSensorFusionMeasurement(&sensorData, ubxDataStruct, num); // Extract the data for one sensor
 
     Serial.print(F(": Type: "));
     Serial.print(sensorData.data.bits.dataType);
@@ -106,13 +106,13 @@ void printESFSTATUSdata(UBX_ESF_STATUS_data_t ubxDataStruct)
   Serial.print(F(" numSens: "));
   Serial.println(ubxDataStruct.numSens);
 
-  for (uint8_t num = 0; num < ubxDataStruct.numSens; num++)
+  for (uint8_t num = 0; num < ubxDataStruct.numSens; num++) // For each sensor
   {
     Serial.print(F("Sensor "));
     Serial.print(num);
 
     UBX_ESF_STATUS_sensorStatus_t sensorStatus;
-    myGPS.getSensorFusionStatus(&sensorStatus, ubxDataStruct, num);
+    myGPS.getSensorFusionStatus(&sensorStatus, ubxDataStruct, num); // Extract the data for one sensor
 
     Serial.print(F(": Type: "));
     Serial.print(sensorStatus.sensStatus1.bits.type);

examples/Data_Logging/DataLoggingExample1_NAVPVT/DataLoggingExample1_NAVPVT.ino renamed to examples/Data_Logging/DataLoggingExample1_NAV_PVT/DataLoggingExample1_NAV_PVT.ino

@@ -38,6 +38,8 @@
   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
+
 */
 
 #include <SPI.h>
@@ -54,39 +56,39 @@ File myFile; //File that all GNSS data is written to
 #define packetLength 100 // NAV PVT is 92 + 8 bytes in length (including the sync chars, class, id, length and checksum bytes)
 
 // Callback: printPVTdata will be called when new NAV PVT data arrives
-// See u-blox_structs.h for the full definition of UBX_NAV_PVT_data_t *packetUBXNAVPVTcopy
-void printPVTdata()
+// See u-blox_structs.h for the full definition of UBX_NAV_PVT_data_t
+void printPVTdata(UBX_NAV_PVT_data_t ubxDataStruct)
 {
     Serial.println();
 
     Serial.print(F("Time: ")); // Print the time
-    uint8_t hms = myGPS.packetUBXNAVPVTcopy->hour; // Print the hours
+    uint8_t hms = ubxDataStruct.hour; // Print the hours
     if (hms < 10) Serial.print(F("0")); // Print a leading zero if required
     Serial.print(hms);
     Serial.print(F(":"));
-    hms = myGPS.packetUBXNAVPVTcopy->min; // Print the minutes
+    hms = ubxDataStruct.min; // Print the minutes
     if (hms < 10) Serial.print(F("0")); // Print a leading zero if required
     Serial.print(hms);
     Serial.print(F(":"));
-    hms = myGPS.packetUBXNAVPVTcopy->sec; // Print the seconds
+    hms = ubxDataStruct.sec; // Print the seconds
     if (hms < 10) Serial.print(F("0")); // Print a leading zero if required
     Serial.print(hms);
     Serial.print(F("."));
-    unsigned long millisecs = myGPS.packetUBXNAVPVTcopy->iTOW % 1000; // Print the milliseconds
+    unsigned long millisecs = ubxDataStruct.iTOW % 1000; // Print the milliseconds
     if (millisecs < 100) Serial.print(F("0")); // Print the trailing zeros correctly
     if (millisecs < 10) Serial.print(F("0"));
     Serial.print(millisecs);
 
-    long latitude = myGPS.packetUBXNAVPVTcopy->lat; // Print the latitude
+    long latitude = ubxDataStruct.lat; // Print the latitude
     Serial.print(F(" Lat: "));
     Serial.print(latitude);
 
-    long longitude = myGPS.packetUBXNAVPVTcopy->lon; // Print the longitude
+    long longitude = ubxDataStruct.lon; // Print the longitude
     Serial.print(F(" Long: "));
     Serial.print(longitude);
     Serial.print(F(" (degrees * 10^-7)"));
 
-    long altitude = myGPS.packetUBXNAVPVTcopy->hMSL; // Print the height above mean sea level
+    long altitude = ubxDataStruct.hMSL; // Print the height above mean sea level
     Serial.print(F(" Height above MSL: "));
     Serial.print(altitude);
     Serial.println(F(" (mm)"));  
@@ -145,8 +147,6 @@ void setup()
 
   //myGPS.enableDebugging(); // Uncomment this line to enable helpful GNSS debug messages on Serial
 
-  //myGPS.disableUBX7Fcheck(); // Advanced users only: uncomment this line to disable the "7F" check in checkUbloxI2C
-
   // NAV PVT messages are 100 bytes long.
   // In this example, the data will arrive no faster than one message per second.
   // So, setting the file buffer size to 301 bytes should be more than adequate.
@@ -159,12 +159,16 @@ void setup()
     while (1);
   }
 
+  // Uncomment the next line if you want to reset your module back to the default settings with 1Hz navigation rate
+  // (This will also disable any "auto" messages that were enabled and saved by other examples and reduce the load on the I2C bus)
+  //myGPS.factoryDefault(); delay(5000);
+
   myGPS.setI2COutput(COM_TYPE_UBX); //Set the I2C port to output UBX only (turn off NMEA noise)
   myGPS.saveConfigSelective(VAL_CFG_SUBSEC_IOPORT); //Save (only) the communications port settings to flash and BBR
 
   myGPS.setNavigationFrequency(1); //Produce one navigation solution per second
 
-  myGPS.setAutoPVTcallback(printPVTdata); // Enable automatic NAV PVT messages with callback to printPVTdata
+  myGPS.setAutoPVTcallback(&printPVTdata); // Enable automatic NAV PVT messages with callback to printPVTdata
 
   myGPS.logNAVPVT(); // Enable NAV PVT data logging
 
@@ -180,29 +184,11 @@ void loop()
   {
     uint8_t myBuffer[packetLength]; // Create our own buffer to hold the data while we write it to SD card
 
-    uint16_t numBytesExtracted = myGPS.extractFileBufferData((uint8_t *)&myBuffer, packetLength); // Extract exactly packetLength bytes from the UBX file buffer and put them into myBuffer
+    myGPS.extractFileBufferData((uint8_t *)&myBuffer, packetLength); // Extract exactly packetLength bytes from the UBX file buffer and put them into myBuffer
 
-    if (numBytesExtracted != packetLength) // Check that we did extract exactly packetLength bytes
-    {
-      Serial.println(F("numBytesExtracted does not match packetLength! Something really bad has happened! Freezing..."));
-      myFile.close(); // Close the data file
-      while (1); // Do nothing more
-    }
+    myFile.write(myBuffer, packetLength); // Write exactly packetLength bytes from myBuffer to the ubxDataFile on the SD card
 
-    uint16_t numBytesWritten = myFile.write(myBuffer, packetLength); // Write exactly packetLength bytes from myBuffer to the ubxDataFile on the SD card
-
-    //printBuffer(myBuffer); // Uncomment this line to print the data
-    
-    if (numBytesWritten != packetLength) // Check that we did write exactly packetLength bytes
-    {
-      Serial.println(F("numBytesWritten does not match packetLength! Something really bad has happened! Freezing..."));
-      myFile.close(); // Close the data file
-      while (1);      
-    }
-
-    Serial.print(F("Wrote "));
-    Serial.print(packetLength);
-    Serial.println(F(" bytes of data to NAV_PVT.ubx"));
+    //printBuffer(myBuffer); // Uncomment this line to print the data as Hexadecimal bytes
   }
 
   if (Serial.available()) // Check if the user wants to stop logging
@@ -216,7 +202,7 @@ void loop()
   delay(50);
 }
 
-// Print the buffer contents as Hexadecimal
+// Print the buffer contents as Hexadecimal bytes
 // You should see:
 // SYNC CHAR 1: 0xB5
 // SYNC CHAR 2: 0x62

examples/Data_Logging/DataLoggingExample2_TIMTM2/DataLoggingExample2_TIMTM2.ino renamed to examples/Data_Logging/DataLoggingExample2_TIM_TM2/DataLoggingExample2_TIM_TM2.ino

@@ -34,6 +34,15 @@
   will cause a TIM TM2 message to be produced once per second. You can then study the timing of the
   pulse edges with nanosecond resolution!
 
+  Note: TIM TM2 can only capture the timing of one rising edge and one falling edge per
+  navigation solution. So with setNavigationFrequency set to 1Hz, we can only see the timing
+  of one rising and one falling edge per second. If the frequency of the signal on the INT pin
+  is higher than 1Hz, we will only be able to see the timing of the most recent edges.
+  However, the module can count the number of rising edges too, at rates faster than the navigation rate.
+
+  TIM TM2 messages are only produced when a rising or falling edge is detected on the INT pin.
+  If you disconnect your PPS to INT jumper wire, the messages will stop.
+
   Data is logged in u-blox UBX format. Please see the u-blox protocol specification for more details.
   You can replay and analyze the data using u-center:
   https://www.u-blox.com/en/product/u-center
@@ -42,6 +51,8 @@
   Buy a board from SparkFun!
   ZED-F9P RTK2: https://www.sparkfun.com/products/15136
   NEO-M8P RTK: https://www.sparkfun.com/products/15005
+  NEO-M9N: https://www.sparkfun.com/products/17285
+
 */
 
 #include <SPI.h>
@@ -57,32 +68,36 @@ File myFile; //File that all GNSS data is written to
 
 #define packetLength 36 // TIM TM2 is 28 + 8 bytes in length (including the sync chars, class, id, length and checksum bytes)
 
+int dotsPrinted = 0; // Print dots in rows of 50 while waiting for a TIM TM2 message
+
 // Callback: printTIMTM2data will be called when new TIM TM2 data arrives
-// See u-blox_structs.h for the full definition of UBX_TIM_TM2_data_t *packetUBXTIMTM2copy
-void printTIMTM2data()
+// See u-blox_structs.h for the full definition of UBX_TIM_TM2_data_t
+void printTIMTM2data(UBX_TIM_TM2_data_t ubxDataStruct)
 {
   Serial.println();
 
   Serial.print(F("newFallingEdge: ")); // 1 if a new falling edge was detected
-  Serial.print(myGPS.packetUBXTIMTM2copy->flags.bits.newFallingEdge);
+  Serial.print(ubxDataStruct.flags.bits.newFallingEdge);
 
   Serial.print(F(" newRisingEdge: ")); // 1 if a new rising edge was detected
-  Serial.print(myGPS.packetUBXTIMTM2copy->flags.bits.newRisingEdge);
+  Serial.print(ubxDataStruct.flags.bits.newRisingEdge);
 
   Serial.print(F(" Rising Edge Counter: ")); // Rising edge counter
-  Serial.print(myGPS.packetUBXTIMTM2copy->count);
+  Serial.print(ubxDataStruct.count);
 
   Serial.print(F(" towMsR: ")); // Time Of Week of rising edge (ms)
-  Serial.print(myGPS.packetUBXTIMTM2copy->towMsR);
+  Serial.print(ubxDataStruct.towMsR);
 
   Serial.print(F(" towSubMsR: ")); // Millisecond fraction of Time Of Week of rising edge in nanoseconds
-  Serial.print(myGPS.packetUBXTIMTM2copy->towSubMsR);
+  Serial.print(ubxDataStruct.towSubMsR);
 
   Serial.print(F(" towMsF: ")); // Time Of Week of falling edge (ms)
-  Serial.print(myGPS.packetUBXTIMTM2copy->towMsF);
+  Serial.print(ubxDataStruct.towMsF);
 
   Serial.print(F(" towSubMsF: ")); // Millisecond fraction of Time Of Week of falling edge in nanoseconds
-  Serial.println(myGPS.packetUBXTIMTM2copy->towSubMsF);
+  Serial.println(ubxDataStruct.towSubMsF);
+
+  dotsPrinted = 0; // Reset dotsPrinted
 }
 
 void setup()
@@ -138,8 +153,6 @@ void setup()
 
   //myGPS.enableDebugging(); // Uncomment this line to enable helpful GNSS debug messages on Serial
 
-  //myGPS.disableUBX7Fcheck(); // Advanced users only: uncomment this line to disable the "7F" check in checkUbloxI2C
-
   // TIM TM2 messages are 36 bytes long.
   // In this example, the data will arrive no faster than one message per second.
   // So, setting the file buffer size to 109 bytes should be more than adequate.
@@ -152,12 +165,16 @@ void setup()
     while (1);
   }
 
+  // Uncomment the next line if you want to reset your module back to the default settings with 1Hz navigation rate
+  // (This will also disable any "auto" messages that were enabled and saved by other examples and reduce the load on the I2C bus)
+  //myGPS.factoryDefault(); delay(5000);
+
   myGPS.setI2COutput(COM_TYPE_UBX); //Set the I2C port to output UBX only (turn off NMEA noise)
   myGPS.saveConfigSelective(VAL_CFG_SUBSEC_IOPORT); //Save (only) the communications port settings to flash and BBR
 
   myGPS.setNavigationFrequency(1); //Produce one navigation solution per second
 
-  myGPS.setAutoTIMTM2callback(printTIMTM2data); // Enable automatic TIM TM2 messages with callback to printTIMTM2data
+  myGPS.setAutoTIMTM2callback(&printTIMTM2data); // Enable automatic TIM TM2 messages with callback to printTIMTM2data
 
   myGPS.logTIMTM2(); // Enable TIM TM2 data logging
 
@@ -173,29 +190,11 @@ void loop()
   {
     uint8_t myBuffer[packetLength]; // Create our own buffer to hold the data while we write it to SD card
 
-    uint16_t numBytesExtracted = myGPS.extractFileBufferData((uint8_t *)&myBuffer, packetLength); // Extract exactly packetLength bytes from the UBX file buffer and put them into myBuffer
-
-    if (numBytesExtracted != packetLength) // Check that we did extract exactly packetLength bytes
-    {
-      Serial.println(F("numBytesExtracted does not match packetLength! Something really bad has happened! Freezing..."));
-      myFile.close(); // Close the data file
-      while (1); // Do nothing more
-    }
+    myGPS.extractFileBufferData((uint8_t *)&myBuffer, packetLength); // Extract exactly packetLength bytes from the UBX file buffer and put them into myBuffer
 
-    uint16_t numBytesWritten = myFile.write(myBuffer, packetLength); // Write exactly packetLength bytes from myBuffer to the ubxDataFile on the SD card
+    myFile.write(myBuffer, packetLength); // Write exactly packetLength bytes from myBuffer to the ubxDataFile on the SD card
 
     //printBuffer(myBuffer); // Uncomment this line to print the data
-    
-    if (numBytesWritten != packetLength) // Check that we did write exactly packetLength bytes
-    {
-      Serial.println(F("numBytesWritten does not match packetLength! Something really bad has happened! Freezing..."));
-      myFile.close(); // Close the data file
-      while (1);      
-    }
-
-    Serial.print(F("Wrote "));
-    Serial.print(packetLength);
-    Serial.println(F(" bytes of data to TIM_TM2.ubx"));
   }
 
   if (Serial.available()) // Check if the user wants to stop logging
@@ -205,8 +204,13 @@ void loop()
     while(1); // Do nothing more
   }
 
-  Serial.print(".");
+  Serial.print("."); // Print dots in rows of 50
   delay(50);
+  if (++dotsPrinted > 50)
+  {
+    Serial.println();
+    dotsPrinted = 0;
+  }
 }
 
 // Print the buffer contents as Hexadecimal

examples/Data_Logging/DataLoggingExample3_RXM_SFRBX_and_RAWX/DataLoggingExample3_RXM_SFRBX_and_RAWX.ino

@@ -72,15 +72,15 @@ int numSFRBX = 0; // Keep count of how many SFRBX message groups have been recei
 int numRAWX = 0; // Keep count of how many RAWX message groups have been received (see note above)
 
 // Callback: newSFRBX will be called when new RXM SFRBX data arrives
-// See u-blox_structs.h for the full definition of UBX_RXMSFRBX_data_t *packetUBXRXMSFRBXcopy
-void newSFRBX()
+// See u-blox_structs.h for the full definition of UBX_RXMSFRBX_data_t
+void newSFRBX(UBX_RXM_SFRBX_data_t ubxDataStruct)
 {
   numSFRBX++; // Increment the count
 }
 
 // Callback: newRAWX will be called when new RXM RAWX data arrives
-// See u-blox_structs.h for the full definition of UBX_RXMRAWX_data_t *packetUBXRXMRAWXcopy
-void newRAWX()
+// See u-blox_structs.h for the full definition of UBX_RXMRAWX_data_t
+void newRAWX(UBX_RXM_RAWX_data_t ubxDataStruct)
 {
   numRAWX++; // Increment the count
 }
@@ -157,18 +157,19 @@ void setup()
   }
 
   // Uncomment the next line if you want to reset your module back to the default settings with 1Hz navigation rate
+  // (This will also disable any "auto" messages that were enabled and saved by other examples and reduce the load on the I2C bus)
   //myGPS.factoryDefault(); delay(5000);
 
   myGPS.setI2COutput(COM_TYPE_UBX); //Set the I2C port to output UBX only (turn off NMEA noise)
   myGPS.saveConfigSelective(VAL_CFG_SUBSEC_IOPORT); //Save (only) the communications port settings to flash and BBR
 
   myGPS.setNavigationFrequency(1); //Produce one navigation solution per second (that's plenty for Precise Point Positioning)
 
-  myGPS.setAutoRXMSFRBXcallback(newSFRBX); // Enable automatic RXM SFRBX messages with callback to newSFRBX
+  myGPS.setAutoRXMSFRBXcallback(&newSFRBX); // Enable automatic RXM SFRBX messages with callback to newSFRBX
 
   myGPS.logRXMSFRBX(); // Enable RXM SFRBX data logging
 
-  myGPS.setAutoRXMRAWXcallback(newRAWX); // Enable automatic RXM RAWX messages with callback to newRAWX
+  myGPS.setAutoRXMRAWXcallback(&newRAWX); // Enable automatic RXM RAWX messages with callback to newRAWX
 
   myGPS.logRXMRAWX(); // Enable RXM RAWX data logging
 
@@ -192,23 +193,9 @@ void loop()
 
     uint8_t myBuffer[sdWriteSize]; // Create our own buffer to hold the data while we write it to SD card
 
-    uint16_t numBytesExtracted = myGPS.extractFileBufferData((uint8_t *)&myBuffer, sdWriteSize); // Extract exactly sdWriteSize bytes from the UBX file buffer and put them into myBuffer
+    myGPS.extractFileBufferData((uint8_t *)&myBuffer, sdWriteSize); // Extract exactly sdWriteSize bytes from the UBX file buffer and put them into myBuffer
 
-    if (numBytesExtracted != sdWriteSize) // Check that we did extract exactly sdWriteSize bytes
-    {
-      Serial.println(F("numBytesExtracted does not match sdWriteSize! Something really bad has happened! Freezing..."));
-      myFile.close(); // Close the data file
-      while (1); // Do nothing more
-    }
-
-    uint16_t numBytesWritten = myFile.write(myBuffer, sdWriteSize); // Write exactly sdWriteSize bytes from myBuffer to the ubxDataFile on the SD card
-
-    if (numBytesWritten != sdWriteSize) // Check that we did write exactly sdWriteSize bytes
-    {
-      Serial.println(F("numBytesWritten does not match sdWriteSize! Something really bad has happened! Freezing..."));
-      myFile.close(); // Close the data file
-      while (1);      
-    }
+    myFile.write(myBuffer, sdWriteSize); // Write exactly sdWriteSize bytes from myBuffer to the ubxDataFile on the SD card
 
     // In case the SD writing is slow or there is a lot of data to write, keep checking for the arrival of new data
     myGPS.checkUblox(); // Check for the arrival of new data and process it.
@@ -226,13 +213,14 @@ void loop()
     Serial.print(F(" RAWX: "));
     Serial.println(numRAWX);
 
-    uint16_t maxBufferBytes = myGPS.getMaxFileBufferAvail(); // Print how full the file buffer has been (not how full it is now)
-    Serial.print(F("The maximum number of bytes which the file buffer has contained is: "));
-    Serial.println(maxBufferBytes);
+    uint16_t maxBufferBytes = myGPS.getMaxFileBufferAvail(); // Get how full the file buffer has been (not how full it is now)
+    
+    //Serial.print(F("The maximum number of bytes which the file buffer has contained is: ")); // It is a fun thing to watch how full the buffer gets
+    //Serial.println(maxBufferBytes);
 
     if (maxBufferBytes > ((fileBufferSize / 5) * 4)) // Warn the user if fileBufferSize was more than 80% full
     {
-      Serial.println(F("Warning: the file buffer was almost full. Some data may have been lost."));
+      Serial.println(F("Warning: the file buffer has been over 80% full. Some data may have been lost."));
     }
 
     lastPrint = millis(); // Update lastPrint