Update VALSET and VALGET examples for the template methods

PaulZC · PaulZC · commit a3b52a5fde0d · 2023-01-10T10:55:21.000Z
diff --git a/examples/Callbacks/CallbackExample1_NAV_PVT/CallbackExample1_NAV_PVT.ino b/examples/Callbacks/CallbackExample1_NAV_PVT/CallbackExample1_NAV_PVT.ino
@@ -3,17 +3,18 @@
   By: Paul Clark
   SparkFun Electronics
   Date: December 30th, 2020
-  License: MIT. See license file for more information but you can
-  basically do whatever you want with this code.
+  License: MIT. See license file for more information.
 
   This example shows how to configure the u-blox GNSS to send navigation reports automatically
   and access the data via a callback. No more polling!
 
   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
+  SparkFun GPS-RTK2 - ZED-F9P (GPS-15136)    https://www.sparkfun.com/products/15136
+  SparkFun GPS-RTK-SMA - ZED-F9P (GPS-16481) https://www.sparkfun.com/products/16481
+  SparkFun MAX-M10S Breakout (GPS-18037)     https://www.sparkfun.com/products/18037
+  SparkFun ZED-F9K Breakout (GPS-18719)      https://www.sparkfun.com/products/18719
+  SparkFun ZED-F9R Breakout (GPS-16344)      https://www.sparkfun.com/products/16344
 
   Hardware Connections:
   Plug a Qwiic cable into the GPS and a BlackBoard
diff --git a/examples/Callbacks/CallbackExample2_NAV_ODO/CallbackExample2_NAV_ODO.ino b/examples/Callbacks/CallbackExample2_NAV_ODO/CallbackExample2_NAV_ODO.ino
@@ -3,17 +3,18 @@
   By: Paul Clark
   SparkFun Electronics
   Date: December 30th, 2020
-  License: MIT. See license file for more information but you can
-  basically do whatever you want with this code.
+  License: MIT. See license file for more information.
 
   This example shows how to configure the u-blox GNSS to send odometer reports automatically
   and display the data via a callback. No more polling!
 
   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
+  SparkFun GPS-RTK2 - ZED-F9P (GPS-15136)    https://www.sparkfun.com/products/15136
+  SparkFun GPS-RTK-SMA - ZED-F9P (GPS-16481) https://www.sparkfun.com/products/16481
+  SparkFun MAX-M10S Breakout (GPS-18037)     https://www.sparkfun.com/products/18037
+  SparkFun ZED-F9K Breakout (GPS-18719)      https://www.sparkfun.com/products/18719
+  SparkFun ZED-F9R Breakout (GPS-16344)      https://www.sparkfun.com/products/16344
 
   Hardware Connections:
   Plug a Qwiic cable into the GPS and a BlackBoard
diff --git a/examples/Callbacks/CallbackExample3_TIM_TM2/CallbackExample3_TIM_TM2.ino b/examples/Callbacks/CallbackExample3_TIM_TM2/CallbackExample3_TIM_TM2.ino
@@ -3,8 +3,7 @@
   By: Paul Clark
   SparkFun Electronics
   Date: December 30th, 2020
-  License: MIT. See license file for more information but you can
-  basically do whatever you want with this code.
+  License: MIT. See license file for more information.
 
   This example shows how to configure the u-blox GNSS to send TIM TM2 reports automatically
   and display the data via a callback. No more polling!
diff --git a/examples/Callbacks/CallbackExample4_RAWX/CallbackExample4_RAWX.ino b/examples/Callbacks/CallbackExample4_RAWX/CallbackExample4_RAWX.ino
@@ -3,8 +3,7 @@
   By: Paul Clark
   SparkFun Electronics
   Date: March 11th, 2021
-  License: MIT. See license file for more information but you can
-  basically do whatever you want with this code.
+  License: MIT. See license file for more information.
 
   This example shows how to configure the u-blox GNSS to send RXM RAWX reports automatically
   and access the data via a callback. No more polling!
diff --git a/examples/Callbacks/CallbackExample5_NAV_SAT/CallbackExample5_NAV_SAT.ino b/examples/Callbacks/CallbackExample5_NAV_SAT/CallbackExample5_NAV_SAT.ino
@@ -3,8 +3,7 @@
   By: Paul Clark
   SparkFun Electronics
   Date: December 1st, 2021
-  License: MIT. See license file for more information but you can
-  basically do whatever you want with this code.
+  License: MIT. See license file for more information.
 
   This example shows how to configure the u-blox GNSS to send NAV SAT reports automatically
   and access the data via a callback. No more polling!
diff --git a/examples/Callbacks/CallbackExample6_UseCallbackDataInLoop/CallbackExample6_UseCallbackDataInLoop.ino b/examples/Callbacks/CallbackExample6_UseCallbackDataInLoop/CallbackExample6_UseCallbackDataInLoop.ino
@@ -3,8 +3,7 @@
   By: Paul Clark
   SparkFun Electronics
   Date: April 15th, 2022
-  License: MIT. See license file for more information but you can
-  basically do whatever you want with this code.
+  License: MIT. See license file for more information.
 
   This example shows how to access the callback data from the main loop.
   The simple way to check if new data is available is to use a global flag: set it in the callback, check it and clear it in the main loop.
@@ -13,9 +12,11 @@
 
   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
+  SparkFun GPS-RTK2 - ZED-F9P (GPS-15136)    https://www.sparkfun.com/products/15136
+  SparkFun GPS-RTK-SMA - ZED-F9P (GPS-16481) https://www.sparkfun.com/products/16481
+  SparkFun MAX-M10S Breakout (GPS-18037)     https://www.sparkfun.com/products/18037
+  SparkFun ZED-F9K Breakout (GPS-18719)      https://www.sparkfun.com/products/18719
+  SparkFun ZED-F9R Breakout (GPS-16344)      https://www.sparkfun.com/products/16344
 
   Hardware Connections:
   Plug a Qwiic cable into the GPS and a BlackBoard
diff --git a/examples/NEO-D9S_and_NEO-D9C/Example5_QZSSL6_Corrections_with_NEO-D9C/Example5_QZSSL6_Corrections_with_NEO-D9C.ino b/examples/NEO-D9S_and_NEO-D9C/Example5_QZSSL6_Corrections_with_NEO-D9C/Example5_QZSSL6_Corrections_with_NEO-D9C.ino
@@ -3,8 +3,7 @@
   By: SparkFun Electronics / Paul Clark
   Based on original code by: u-blox AG / Michael Ammann
   Date: September 23rd, 2022
-  License: MIT. See license file for more information but you can
-  basically do whatever you want with this code.
+  License: MIT. See license file for more information.
 
   This example shows how to configure a NEO-D9C QZSS-L6 receiver and have it send coorection data to a ZED-F9x via Serial (UART).
 
diff --git a/examples/VALGET_and_VALSET/Example1_GetVal/Example1_GetVal.ino b/examples/VALGET_and_VALSET/Example1_GetVal/Example1_GetVal.ino
@@ -105,9 +105,9 @@ void setup()
   // The next line creates and initialises the packet information which wraps around the payload
   ubxPacket customCfg = {0, 0, 0, 0, 0, customPayload, 0, 0, SFE_UBLOX_PACKET_VALIDITY_NOT_DEFINED, SFE_UBLOX_PACKET_VALIDITY_NOT_DEFINED};
 
-  myGNSS.newCfgValget(&customCfg, VAL_LAYER_RAM); // Create a new VALGET construct. Read the data from the RAM layer.
+  myGNSS.newCfgValget(&customCfg, 9, VAL_LAYER_RAM); // Create a new VALGET construct. Read the data from the RAM layer.
   
-  myGNSS.addCfgValget8(&customCfg, UBLOX_CFG_I2C_ADDRESS); // Get the I2C address (see u-blox_config_keys.h for details)
+  myGNSS.addCfgValget(&customCfg, UBLOX_CFG_I2C_ADDRESS); // Get the I2C address (see u-blox_config_keys.h for details)
   
   if (myGNSS.sendCfgValget(&customCfg) == true) // Send the VALGET
   {
@@ -121,17 +121,33 @@ void setup()
 
     // We can also use the "extract" helper functions to read the data - useful for 16, 32 and 64-bit values
     // The full list is:
-    //   uint64_t extractLongLong(ubxPacket *msg, uint16_t spotToStart);  // Combine eight bytes from payload into uint64_t
-    //   uint32_t extractLong(ubxPacket *msg, uint16_t spotToStart);      // Combine four bytes from payload into long
-    //   int32_t extractSignedLong(ubxPacket *msg, uint16_t spotToStart); // Combine four bytes from payload into signed long (avoiding any ambiguity caused by casting)
-    //   uint16_t extractInt(ubxPacket *msg, uint16_t spotToStart);       // Combine two bytes from payload into int
+    //   uint64_t extractLongLong(ubxPacket *msg, uint16_t spotToStart);       // Combine eight bytes from payload into uint64_t
+    //   uint64_t extractSignedLongLong(ubxPacket *msg, uint16_t spotToStart); // Combine eight bytes from payload into int64_t
+    //   uint32_t extractLong(ubxPacket *msg, uint16_t spotToStart);           // Combine four bytes from payload into long
+    //   int32_t extractSignedLong(ubxPacket *msg, uint16_t spotToStart);      // Combine four bytes from payload into signed long (avoiding any ambiguity caused by casting)
+    //   uint16_t extractInt(ubxPacket *msg, uint16_t spotToStart);            // Combine two bytes from payload into int
     //   int16_t extractSignedInt(ubxPacket *msg, uint16_t spotToStart);
-    //   uint8_t extractByte(ubxPacket *msg, uint16_t spotToStart);      // Get byte from payload
-    //   int8_t extractSignedChar(ubxPacket *msg, uint16_t spotToStart); // Get signed 8-bit value from payload
+    //   uint8_t extractByte(ubxPacket *msg, uint16_t spotToStart);            // Get byte from payload
+    //   int8_t extractSignedChar(ubxPacket *msg, uint16_t spotToStart);       // Get signed 8-bit value from payload
+    //   float extractFloat(ubxPacket *msg, uint16_t spotToStart);             // Get 32-bit float from payload
+    //   double extractDouble(ubxPacket *msg, uint16_t spotToStart);           // Get 64-bit double from payload
 
     Serial.print("6: Current I2C address (should be 0x42): 0x");
     currentI2Caddress = myGNSS.extractByte(&customCfg, 8);
     Serial.println(currentI2Caddress >> 1, HEX); //u-blox module returns a shifted 8-bit address. Make it 7-bit unshifted.
+
+    // New in v3: we can use a template method to extract the value for us
+    
+    uint8_t i2cAddress; // We still need to know the type...
+    if (myGNSS.extractConfigValueByKey(&customCfg, UBLOX_CFG_I2C_ADDRESS, &i2cAddress, sizeof(i2cAddress))) // Get the I2C address - using the key
+    {
+      Serial.print(F("7: Current I2C address (should be 0x42): 0x"));
+      Serial.println(i2cAddress >> 1, HEX); //We have to shift by 1 to get the common '7-bit' I2C address format
+    }
+    else
+    {
+      Serial.println(F("extractConfigValueByKey failed!"));      
+    }
   }
   else
   {
diff --git a/examples/VALGET_and_VALSET/Example2_SetVal/Example2_SetVal.ino b/examples/VALGET_and_VALSET/Example2_SetVal/Example2_SetVal.ino
@@ -57,7 +57,7 @@ void setup()
   //You can obtain them from the ZED-F9P interface description doc
   //or from u-center's Messages->CFG->VALSET window. Keys must be 32-bit.
   
-  setValueSuccess &= myGNSS.setVal8(UBLOX_CFG_NMEA_HIGHPREC, 0); //Enable high precision NMEA. UBLOX_CFG_NMEA_HIGHPREC is L (bool) but we use 8-bits (uint8_t)
+  setValueSuccess &= myGNSS.setVal8(UBLOX_CFG_NMEA_HIGHPREC, 1); //Enable high precision NMEA. UBLOX_CFG_NMEA_HIGHPREC is L (bool) but we use 8-bits (uint8_t)
   
   //setValueSuccess &= myGNSS.setVal16(UBLOX_CFG_RATE_MEAS, 100); //Set measurement rate to 100ms (10Hz update rate). UBLOX_CFG_RATE_MEAS is 16-bit U2 (uint16_t)
   setValueSuccess &= myGNSS.setVal16(UBLOX_CFG_RATE_MEAS, 1000); //Set measurement rate to 1000ms (1Hz update rate). UBLOX_CFG_RATE_MEAS is 16-bit U2 (uint16_t)
diff --git a/examples/VALGET_and_VALSET/Example4_multiSetVal/Example4_multiSetVal.ino b/examples/VALGET_and_VALSET/Example4_multiSetVal/Example4_multiSetVal.ino
@@ -72,8 +72,8 @@ void setup()
   myGNSS.autoSendCfgValsetAtSpaceRemaining(16); // Trigger an auto-send when packetCfg has less than 16 bytes are remaining
 
   //Begin with newCfgValset
-  setValueSuccess &= myGNSS.newCfgValset(); // Defaults to configuring the setting in Flash, RAM and BBR
-  //setValueSuccess &= myGNSS.newCfgValset(VAL_LAYER_RAM); //Set this and the following settings in RAM only instead of Flash/RAM/BBR
+  setValueSuccess &= myGNSS.newCfgValset(); // Defaults to configuring the setting in RAM and BBR
+  //setValueSuccess &= myGNSS.newCfgValset(VAL_LAYER_RAM); //Set this and the following settings in RAM only
 
   // Add KeyIDs and Values
   setValueSuccess &= myGNSS.addCfgValset8(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1005_I2C, 1); //Set output rate of msg 1005 over the I2C port to once per measurement (value is 8-bit (U1))
@@ -92,6 +92,33 @@ void setup()
   }
   else
     Serial.println("Value set failed");
+
+  delay(1000);
+
+  // New in v3 : we can use the template method addCfgValset to deduce the data size automatically
+
+  //Begin with newCfgValset
+  setValueSuccess = myGNSS.newCfgValset(); // Defaults to configuring the setting in RAM and BBR
+  //setValueSuccess &= myGNSS.newCfgValset(VAL_LAYER_RAM); //Set this and the following settings in RAM only
+
+  // Add KeyIDs and Values
+  setValueSuccess &= myGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1005_I2C, 1); //Set output rate of msg 1005 over the I2C port to once per measurement (value is 8-bit (U1))
+  setValueSuccess &= myGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1077_I2C, 1); //Set output rate of msg 1077 over the I2C port to once per measurement (value is 8-bit (U1))
+  setValueSuccess &= myGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1087_I2C, 1); //Set output rate of msg 1087 over the I2C port to once per measurement (value is 8-bit (U1))
+  setValueSuccess &= myGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1127_I2C, 1); //Set output rate of msg 1127 over the I2C port to once per measurement (value is 8-bit (U1))
+  setValueSuccess &= myGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1097_I2C, 1); //Set output rate of msg 1097 over the I2C port to once per measurement (value is 8-bit (U1))
+  setValueSuccess &= myGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1230_I2C, 10); //Set output rate of msg 1230 over the I2C port to once every 10 measurements (value is 8-bit (U1))
+
+  // Send the packet using sendCfgValset
+  setValueSuccess &= myGNSS.sendCfgValset();
+
+  if (setValueSuccess == true)
+  {
+    Serial.println("Values were successfully set");
+  }
+  else
+    Serial.println("Value set failed");
+
 }
 
 void loop()
diff --git a/examples/VALGET_and_VALSET/Example5_multiGetVal/Example5_multiGetVal.ino b/examples/VALGET_and_VALSET/Example5_multiGetVal/Example5_multiGetVal.ino
@@ -91,9 +91,9 @@ void setup()
   // sfe_ublox_packet_validity_e valid            : Goes from NOT_DEFINED to VALID or NOT_VALID when checksum is checked
   // sfe_ublox_packet_validity_e classAndIDmatch  : Goes from NOT_DEFINED to VALID or NOT_VALID when the Class and ID match the requestedClass and requestedID
 
-  myGNSS.newCfgValget(&customCfg, VAL_LAYER_RAM); // Create a new VALGET construct
-  myGNSS.addCfgValget8(&customCfg, UBLOX_CFG_I2C_ADDRESS); // Get the I2C address (see u-blox_config_keys.h for details)
-  myGNSS.addCfgValget8(&customCfg, UBLOX_CFG_I2COUTPROT_NMEA); // Get the flag indicating is NMEA should be output on I2C
+  myGNSS.newCfgValget(&customCfg, MAX_PAYLOAD_SIZE, VAL_LAYER_RAM); // Create a new VALGET construct
+  myGNSS.addCfgValget(&customCfg, UBLOX_CFG_I2C_ADDRESS); // Get the I2C address (see u-blox_config_keys.h for details)
+  myGNSS.addCfgValget(&customCfg, UBLOX_CFG_I2COUTPROT_NMEA); // Get the flag indicating is NMEA should be output on I2C
   if (myGNSS.sendCfgValget(&customCfg)) // Send the VALGET
   {
     Serial.print(F("2 : I2C Address: 0x"));
@@ -111,18 +111,45 @@ void setup()
 
     // We can also use the "extract" helper functions to read the data - useful for 16, 32 and 64-bit values
     // The full list is:
-    //   uint64_t extractLongLong(ubxPacket *msg, uint16_t spotToStart);  // Combine eight bytes from payload into uint64_t
-    //   uint32_t extractLong(ubxPacket *msg, uint16_t spotToStart);      // Combine four bytes from payload into long
-    //   int32_t extractSignedLong(ubxPacket *msg, uint16_t spotToStart); // Combine four bytes from payload into signed long (avoiding any ambiguity caused by casting)
-    //   uint16_t extractInt(ubxPacket *msg, uint16_t spotToStart);       // Combine two bytes from payload into int
+    //   uint64_t extractLongLong(ubxPacket *msg, uint16_t spotToStart);       // Combine eight bytes from payload into uint64_t
+    //   uint64_t extractSignedLongLong(ubxPacket *msg, uint16_t spotToStart); // Combine eight bytes from payload into int64_t
+    //   uint32_t extractLong(ubxPacket *msg, uint16_t spotToStart);           // Combine four bytes from payload into long
+    //   int32_t extractSignedLong(ubxPacket *msg, uint16_t spotToStart);      // Combine four bytes from payload into signed long (avoiding any ambiguity caused by casting)
+    //   uint16_t extractInt(ubxPacket *msg, uint16_t spotToStart);            // Combine two bytes from payload into int
     //   int16_t extractSignedInt(ubxPacket *msg, uint16_t spotToStart);
-    //   uint8_t extractByte(ubxPacket *msg, uint16_t spotToStart);      // Get byte from payload
-    //   int8_t extractSignedChar(ubxPacket *msg, uint16_t spotToStart); // Get signed 8-bit value from payload
+    //   uint8_t extractByte(ubxPacket *msg, uint16_t spotToStart);            // Get byte from payload
+    //   int8_t extractSignedChar(ubxPacket *msg, uint16_t spotToStart);       // Get signed 8-bit value from payload
+    //   float extractFloat(ubxPacket *msg, uint16_t spotToStart);             // Get 32-bit float from payload
+    //   double extractDouble(ubxPacket *msg, uint16_t spotToStart);           // Get 64-bit double from payload
 
     Serial.print(F("3 : I2C Address: 0x"));
     Serial.println(myGNSS.extractByte(&customCfg, 8) >> 1, HEX); //We have to shift by 1 to get the common '7-bit' I2C address format
     Serial.print(F("3 : Output NMEA over I2C port: 0x"));
     Serial.println(myGNSS.extractByte(&customCfg, 13), HEX);
+
+    // New in v3: we can use a template method to extract the value for us
+    
+    uint8_t i2cAddress; // We still need to know the type...
+    if (myGNSS.extractConfigValueByKey(&customCfg, UBLOX_CFG_I2C_ADDRESS, &i2cAddress, sizeof(i2cAddress))) // Get the I2C address - using the key
+    {
+      Serial.print(F("4 : I2C Address: 0x"));
+      Serial.println(i2cAddress >> 1, HEX); //We have to shift by 1 to get the common '7-bit' I2C address format
+    }
+    else
+    {
+      Serial.println(F("extractConfigValueByKey failed!"));      
+    }
+
+    bool nmeaI2c; // We still need to know the type...
+    if (myGNSS.extractConfigValueByKey(&customCfg, UBLOX_CFG_I2COUTPROT_NMEA, &nmeaI2c, sizeof(nmeaI2c))) // Get the I2COUTPROT_NMEA flag - using the key
+    {
+      Serial.print(F("4 : Output NMEA over I2C port: 0x"));
+      Serial.println(nmeaI2c, HEX);
+    }
+    else
+    {
+      Serial.println(F("extractConfigValueByKey failed!"));      
+    }
   }
   else
   {
diff --git a/examples/VALGET_and_VALSET/Example6_multiSetVal_and_GetVal_Templates/Example6_multiSetVal_and_GetVal_Templates.ino b/examples/VALGET_and_VALSET/Example6_multiSetVal_and_GetVal_Templates/Example6_multiSetVal_and_GetVal_Templates.ino
@@ -42,7 +42,7 @@ void setup()
 
   Wire.begin();
 
-  myGNSS.enableDebugging(); // Uncomment this line to enable debug messages on Serial
+  //myGNSS.enableDebugging(); // Uncomment this line to enable debug messages on Serial
 
   if (myGNSS.begin() == false) //Connect to the u-blox module using Wire port
   {
@@ -70,7 +70,7 @@ void setup()
   // The next line creates and initialises the packet information which wraps around the payload
   ubxPacket customCfg = {0, 0, 0, 0, 0, customPayload, 0, 0, SFE_UBLOX_PACKET_VALIDITY_NOT_DEFINED, SFE_UBLOX_PACKET_VALIDITY_NOT_DEFINED};
 
-  myGNSS.newCfgValget(&customCfg, VAL_LAYER_RAM); // Create a new VALGET construct
+  myGNSS.newCfgValget(&customCfg, MAX_PAYLOAD_SIZE, VAL_LAYER_RAM); // Create a new VALGET construct
   myGNSS.addCfgValget(&customCfg, UBLOX_CFG_I2C_ADDRESS); // Get the I2C address (see u-blox_config_keys.h for details)
   myGNSS.addCfgValget(&customCfg, UBLOX_CFG_I2COUTPROT_NMEA); // Get the flag indicating is NMEA should be output on I2C
   myGNSS.addCfgValget(&customCfg, UBLOX_CFG_UART1_BAUDRATE); // Get the UART1 baud rate 
diff --git a/examples/VALGET_and_VALSET/Example7_TimePulse_Frequency_using_Templates/Example7_TimePulse_Frequency_using_Templates.ino b/examples/VALGET_and_VALSET/Example7_TimePulse_Frequency_using_Templates/Example7_TimePulse_Frequency_using_Templates.ino
diff --git a/examples/ZED-F9P/Example12_setStaticPosition/Example12_setStaticPosition.ino b/examples/ZED-F9P/Example12_setStaticPosition/Example12_setStaticPosition.ino
diff --git a/examples/ZED-F9P/Example2_ValConfigurationMethod/Example2_ValConfigurationMethod.ino b/examples/ZED-F9P/Example2_ValConfigurationMethod/Example2_ValConfigurationMethod.ino
