Add downloadDeviceConfig

Helper function to pipe u-center friendly formatted file for entire device config.

Author: nseidle

src/SparkFun_u-blox_GNSS_Arduino_Library.cpp

@@ -4818,7 +4818,7 @@ uint32_t SFE_UBLOX_GNSS::createKey(uint16_t group, uint16_t id, uint8_t size)
 //This function takes a full 32-bit key
 //Default layer is RAM
 //Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
-sfe_ublox_status_e SFE_UBLOX_GNSS::getVal(uint32_t key, uint8_t layer, uint16_t maxWait)
+sfe_ublox_status_e SFE_UBLOX_GNSS::getVal(uint32_t key, uint8_t layer, uint16_t skipAmt, uint16_t maxWait)
 {
   packetCfg.cls = UBX_CLASS_CFG;
   packetCfg.id = UBX_CFG_VALGET;
@@ -4842,6 +4842,9 @@ sfe_ublox_status_e SFE_UBLOX_GNSS::getVal(uint32_t key, uint8_t layer, uint16_t
   payloadCfg[0] = 0;        //Message Version - set to 0
   payloadCfg[1] = getLayer; //Layer
 
+  payloadCfg[2] = skipAmt >> 8 * 0; //Position - skip this many key values
+  payloadCfg[3] = skipAmt >> 8 * 1;
+
   //Load key into outgoing payload
   payloadCfg[4] = key >> 8 * 0; //Key LSB
   payloadCfg[5] = key >> 8 * 1;
@@ -4878,21 +4881,21 @@ sfe_ublox_status_e SFE_UBLOX_GNSS::getVal(uint32_t key, uint8_t layer, uint16_t
 //Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GNSS::getVal8(uint32_t key, uint8_t layer, uint16_t maxWait)
 {
-  if (getVal(key, layer, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
+  if (getVal(key, layer, 0, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
     return (0);
 
   return (extractByte(&packetCfg, 8));
 }
 uint16_t SFE_UBLOX_GNSS::getVal16(uint32_t key, uint8_t layer, uint16_t maxWait)
 {
-  if (getVal(key, layer, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
+  if (getVal(key, layer, 0, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
     return (0);
 
   return (extractInt(&packetCfg, 8));
 }
 uint32_t SFE_UBLOX_GNSS::getVal32(uint32_t key, uint8_t layer, uint16_t maxWait)
 {
-  if (getVal(key, layer, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
+  if (getVal(key, layer, 0, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
     return (0);
 
   return (extractLong(&packetCfg, 8));
@@ -5211,6 +5214,38 @@ uint8_t SFE_UBLOX_GNSS::sendCfgValset8(uint32_t key, uint8_t value, uint16_t max
   return (sendCommand(&packetCfg, maxWait) == SFE_UBLOX_STATUS_DATA_SENT); // We are only expecting an ACK
 }
 
+//Read 18 sets of key values, for a total of 1088 keys
+//Format the output to match the config files that u-center can understand
+//Layer number can be 0 (RAM) or layer 7 (Default)
+void SFE_UBLOX_GNSS::downloadDeviceConfig(Stream &downloadPort, uint8_t layerNumber, uint16_t maxWait)
+{
+  for (int x = 0 ; x < 18 ; x++)
+  {
+    getVal(0x0FFF0000, layerNumber, x * 64, maxWait); //Advance by 64 keys each time
+
+    //All lines start with a VALGET
+    downloadPort.print(F("CFG-VALGET - 06 8B "));
+
+    //Pretty print the response length
+    uint16_t responseLength = packetCfg.len;
+    if ((responseLength & 0xFF) < 0x10) downloadPort.print(F("0"));
+    downloadPort.print(responseLength & 0xFF, HEX);
+    downloadPort.print(F(" "));
+    if ((responseLength >> 8) < 0x10) downloadPort.print(F("0"));
+    downloadPort.print(responseLength >> 8, HEX);
+
+    //Pretty print the payload
+    for (int x = 0 ; x < 32 ; x++)
+    {
+      downloadPort.print(F(" "));
+      if (payloadCfg[x] < 0x10) downloadPort.print(F("0"));
+      downloadPort.print(payloadCfg[x], HEX);
+    }
+    downloadPort.println();
+  }
+}
+
+
 //=-=-=-=-=-=-=-= "Automatic" Messages =-=-=-=-=-=-=-==-=-=-=-=-=-=-=
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 

src/SparkFun_u-blox_GNSS_Arduino_Library.h

@@ -747,7 +747,7 @@ class SFE_UBLOX_GNSS
 	//It is probably safe to assume that users of the ZED-F9P will be using I2C / Qwiic.
 	//If they are using Serial then the higher baud rate will also help. So let's leave maxWait set to 250ms.
 	uint32_t createKey(uint16_t group, uint16_t id, uint8_t size); //Form 32-bit key from group/id/size
-	sfe_ublox_status_e getVal(uint32_t keyID, uint8_t layer = VAL_LAYER_RAM, uint16_t maxWait = 250);					 //Load payload with response
+	sfe_ublox_status_e getVal(uint32_t keyID, uint8_t layer = VAL_LAYER_RAM, uint16_t skipAmt = 0, uint16_t maxWait = 250); //Load payload with response
 	uint8_t getVal8(uint32_t keyID, uint8_t layer = VAL_LAYER_RAM, uint16_t maxWait = 250);								 //Returns the value at a given key location
 	uint16_t getVal16(uint32_t keyID, uint8_t layer = VAL_LAYER_RAM, uint16_t maxWait = 250);							 //Returns the value at a given key location
 	uint32_t getVal32(uint32_t keyID, uint8_t layer = VAL_LAYER_RAM, uint16_t maxWait = 250);							 //Returns the value at a given key location
@@ -767,6 +767,7 @@ class SFE_UBLOX_GNSS
 	uint8_t sendCfgValset8(uint32_t keyID, uint8_t value, uint16_t maxWait = 250);										 //Add the final KeyID and 8-bit value to an existing UBX-CFG-VALSET ubxPacket and send it
 	uint8_t sendCfgValset16(uint32_t keyID, uint16_t value, uint16_t maxWait = 250);									 //Add the final KeyID and 16-bit value to an existing UBX-CFG-VALSET ubxPacket and send it
 	uint8_t sendCfgValset32(uint32_t keyID, uint32_t value, uint16_t maxWait = 250);									 //Add the final KeyID and 32-bit value to an existing UBX-CFG-VALSET ubxPacket and send it
+	void downloadDeviceConfig(Stream &port = Serial, uint8_t layerNumber = VAL_LAYER_RAM, uint16_t maxWait = 1000); //Pipe entire device's config data to a user chosen stream
 
 // getPVT will only return data once in each navigation cycle. By default, that is once per second.
 // Therefore we should set defaultMaxWait to slightly longer than that.