Add deprecated (backward-compatible) newCfgValset and sendCfgValset

Author: PaulZC

src/sfe_bus.cpp

@@ -337,7 +337,9 @@ namespace SparkFun_UBLOX_GNSS
 
     for (i = 0; i < length; i++)
     {
-      *readData++ = _spiPort->transfer(*data++);
+      *readData = _spiPort->transfer(*data);
+      data++;
+      readData++;
     }
 
     // End transaction

src/u-blox_GNSS.cpp

@@ -7774,7 +7774,7 @@ bool DevUBLOXGNSS::newCfgValset(uint8_t layer)
   packetCfg.len = 4; // 4 byte header
   packetCfg.startingSpot = 0;
 
-  _numCfgKeyIDs = 0;
+  _numCfgKeys = 0;
 
   // Clear all of packet payload
   memset(payloadCfg, 0, packetCfgPayloadSize);
@@ -7786,7 +7786,7 @@ bool DevUBLOXGNSS::newCfgValset(uint8_t layer)
   return (true);
 }
 
-// Add another keyID and value to an existing UBX-CFG-VALSET ubxPacket
+// Add another key and value to an existing UBX-CFG-VALSET ubxPacket
 // This function takes a full 32-bit key and N-bit value
 bool DevUBLOXGNSS::addCfgValsetN(uint32_t key, uint8_t *value, uint8_t N)
 {
@@ -7799,7 +7799,7 @@ bool DevUBLOXGNSS::addCfgValsetN(uint32_t key, uint8_t *value, uint8_t N)
     sendCommand(&packetCfg);
     packetCfg.len = 4; // 4 byte header
     packetCfg.startingSpot = 0;
-    _numCfgKeyIDs = 0;
+    _numCfgKeys = 0;
     memset(&payloadCfg[4], 0, packetCfgPayloadSize - 4);
   }
 
@@ -7812,7 +7812,7 @@ bool DevUBLOXGNSS::addCfgValsetN(uint32_t key, uint8_t *value, uint8_t N)
     return false;
   }
 
-  if (_numCfgKeyIDs == CFG_VALSET_MAX_KEYS)
+  if (_numCfgKeys == CFG_VALSET_MAX_KEYS)
   {
 #ifndef SFE_UBLOX_REDUCED_PROG_MEM
     if ((_printDebug == true) || (_printLimitedDebug == true)) // This is important. Print this if doing limited debugging
@@ -7832,13 +7832,13 @@ bool DevUBLOXGNSS::addCfgValsetN(uint32_t key, uint8_t *value, uint8_t N)
   // Update packet length: 4 byte key ID, 8 bytes of value
   packetCfg.len = packetCfg.len + 4 + (N / 8);
 
-  _numCfgKeyIDs++;
+  _numCfgKeys++;
 
   // All done
   return (true);
 }
 
-// Add another keyID and value to an existing UBX-CFG-VALSET ubxPacket
+// Add another key and value to an existing UBX-CFG-VALSET ubxPacket
 // This function takes a full 32-bit key and 64-bit value
 bool DevUBLOXGNSS::addCfgValset64(uint32_t key, uint64_t value)
 {
@@ -7851,23 +7851,23 @@ bool DevUBLOXGNSS::addCfgValset64(uint32_t key, uint64_t value)
   return (addCfgValsetN(key, val, 64));
 }
 
-// Add another keyID and value to an existing UBX-CFG-VALSET ubxPacket
+// Add another key and value to an existing UBX-CFG-VALSET ubxPacket
 // This function takes a full 32-bit key and 32-bit value
 bool DevUBLOXGNSS::addCfgValset32(uint32_t key, uint32_t value)
 {
   uint8_t val[4] = {(uint8_t)(value >> 0), (uint8_t)(value >> 8), (uint8_t)(value >> 16), (uint8_t)(value >> 24)};
   return (addCfgValsetN(key, val, 32));
 }
 
-// Add another keyID and value to an existing UBX-CFG-VALSET ubxPacket
+// Add another key and value to an existing UBX-CFG-VALSET ubxPacket
 // This function takes a full 32-bit key and 16-bit value
 bool DevUBLOXGNSS::addCfgValset16(uint32_t key, uint16_t value)
 {
   uint8_t val[2] = {(uint8_t)(value >> 0), (uint8_t)(value >> 8)};
   return (addCfgValsetN(key, val, 16));
 }
 
-// Add another keyID and value to an existing UBX-CFG-VALSET ubxPacket
+// Add another key and value to an existing UBX-CFG-VALSET ubxPacket
 // This function takes a full 32-bit key and 8-bit value
 bool DevUBLOXGNSS::addCfgValset8(uint32_t key, uint8_t value)
 {
@@ -7878,22 +7878,22 @@ bool DevUBLOXGNSS::addCfgValset8(uint32_t key, uint8_t value)
 // Send the UBX-CFG-VALSET ubxPacket
 bool DevUBLOXGNSS::sendCfgValset(uint16_t maxWait)
 {
-  if (_numCfgKeyIDs == 0)
+  if (_numCfgKeys == 0)
     return true; // Nothing to send...
 
   // Send VALSET command with this key and value
   bool success = sendCommand(&packetCfg, maxWait) == SFE_UBLOX_STATUS_DATA_SENT; // We are only expecting an ACK
 
   if (success)
-    _numCfgKeyIDs = 0;
+    _numCfgKeys = 0;
 
   return success;
 }
 
 // Return the number of keys in the CfgValset
 uint8_t DevUBLOXGNSS::getCfgValsetLen()
 {
-  return _numCfgKeyIDs;
+  return _numCfgKeys;
 }
 
 // Return the number of free bytes remaining in packetCfgPayload
@@ -7902,6 +7902,56 @@ size_t DevUBLOXGNSS::getCfgValsetSpaceRemaining()
   return getPacketCfgSpaceRemaining();
 }
 
+// Deprecated - only included for backward-compatibility. Use newCfgValset and sendCfgValset
+bool DevUBLOXGNSS::newCfgValset8(uint32_t key, uint8_t value, uint8_t layer)
+{
+  bool result = newCfgValset(layer);
+  result &= addCfgValset8(key, value);
+  return result;
+}
+bool DevUBLOXGNSS::newCfgValset16(uint32_t key, uint16_t value, uint8_t layer)
+{
+  bool result = newCfgValset(layer);
+  result &= addCfgValset16(key, value);
+  return result;
+}
+bool DevUBLOXGNSS::newCfgValset32(uint32_t key, uint32_t value, uint8_t layer)
+{
+  bool result = newCfgValset(layer);
+  result &= addCfgValset32(key, value);
+  return result;
+}
+bool DevUBLOXGNSS::newCfgValset64(uint32_t key, uint64_t value, uint8_t layer)
+{
+  bool result = newCfgValset(layer);
+  result &= addCfgValset64(key, value);
+  return result;
+}
+bool DevUBLOXGNSS::sendCfgValset8(uint32_t key, uint8_t value, uint16_t maxWait)
+{
+  bool result = addCfgValset8(key, value);
+  result &= sendCfgValset(maxWait);
+  return result;
+}
+bool DevUBLOXGNSS::sendCfgValset16(uint32_t key, uint16_t value, uint16_t maxWait)
+{
+  bool result = addCfgValset16(key, value);
+  result &= sendCfgValset(maxWait);
+  return result;
+}
+bool DevUBLOXGNSS::sendCfgValset32(uint32_t key, uint32_t value, uint16_t maxWait)
+{
+  bool result = addCfgValset32(key, value);
+  result &= sendCfgValset(maxWait);
+  return result;
+}
+bool DevUBLOXGNSS::sendCfgValset64(uint32_t key, uint64_t value, uint16_t maxWait)
+{
+  bool result = addCfgValset64(key, value);
+  result &= sendCfgValset(maxWait);
+  return result;
+}
+
 bool DevUBLOXGNSS::newCfgValget(uint8_t layer) // Create a new, empty UBX-CFG-VALGET. Add entries with addCfgValget8/16/32/64
 {
   return (newCfgValget(&packetCfg, layer));
@@ -7914,7 +7964,7 @@ bool DevUBLOXGNSS::newCfgValget(ubxPacket *pkt, uint8_t layer) // Create a new,
   pkt->len = 4; // 4 byte header
   pkt->startingSpot = 0;
 
-  _numGetCfgKeyIDs = 0;
+  _numGetCfgKeys = 0;
   _lenCfgValGetResponse = 0;
 
   // Clear all of packet payload
@@ -7941,12 +7991,12 @@ bool DevUBLOXGNSS::newCfgValget(ubxPacket *pkt, uint8_t layer) // Create a new,
   return (true);
 }
 
-bool DevUBLOXGNSS::addCfgValgetN(uint32_t key, uint8_t N) // Add a new KeyID to an existing UBX-CFG-VALGET ubxPacket
+bool DevUBLOXGNSS::addCfgValgetN(uint32_t key, uint8_t N) // Add a new key to an existing UBX-CFG-VALGET ubxPacket
 {
   return (addCfgValgetN(&packetCfg, key, N));
 }
 
-bool DevUBLOXGNSS::addCfgValgetN(ubxPacket *pkt, uint32_t key, uint8_t N) // Add a new KeyID to an existing UBX-CFG-VALGET ubxPacket
+bool DevUBLOXGNSS::addCfgValgetN(ubxPacket *pkt, uint32_t key, uint8_t N) // Add a new key to an existing UBX-CFG-VALGET ubxPacket
 {
   if (pkt == &packetCfg) // The user will need to do this manually for a custom packet
   {
@@ -7964,7 +8014,7 @@ bool DevUBLOXGNSS::addCfgValgetN(ubxPacket *pkt, uint32_t key, uint8_t N) // Add
     }
   }
 
-  if (_numGetCfgKeyIDs == CFG_VALSET_MAX_KEYS)
+  if (_numGetCfgKeys == CFG_VALSET_MAX_KEYS)
   {
 #ifndef SFE_UBLOX_REDUCED_PROG_MEM
     if ((_printDebug == true) || (_printLimitedDebug == true)) // This is important. Print this if doing limited debugging
@@ -7990,29 +8040,29 @@ bool DevUBLOXGNSS::addCfgValgetN(ubxPacket *pkt, uint32_t key, uint8_t N) // Add
   // Update packet length: 4 byte key ID
   pkt->len += 4;
 
-  _numGetCfgKeyIDs++;
+  _numGetCfgKeys++;
   _lenCfgValGetResponse += 4 + (N / 8); // 4 byte key ID, N byte value
 
   // All done
   return (true);
 }
 
-bool DevUBLOXGNSS::addCfgValget8(ubxPacket *pkt, uint32_t key) // Add a new KeyID to an existing UBX-CFG-VALGET ubxPacket
+bool DevUBLOXGNSS::addCfgValget8(ubxPacket *pkt, uint32_t key) // Add a new key to an existing UBX-CFG-VALGET ubxPacket
 {
   return (addCfgValgetN(pkt, key, 8));
 }
 
-bool DevUBLOXGNSS::addCfgValget16(ubxPacket *pkt, uint32_t key) // Add a new KeyID to an existing UBX-CFG-VALGET ubxPacket
+bool DevUBLOXGNSS::addCfgValget16(ubxPacket *pkt, uint32_t key) // Add a new key to an existing UBX-CFG-VALGET ubxPacket
 {
   return (addCfgValgetN(pkt, key, 16));
 }
 
-bool DevUBLOXGNSS::addCfgValget32(ubxPacket *pkt, uint32_t key) // Add a new KeyID to an existing UBX-CFG-VALGET ubxPacket
+bool DevUBLOXGNSS::addCfgValget32(ubxPacket *pkt, uint32_t key) // Add a new key to an existing UBX-CFG-VALGET ubxPacket
 {
   return (addCfgValgetN(pkt, key, 32));
 }
 
-bool DevUBLOXGNSS::addCfgValget64(ubxPacket *pkt, uint32_t key) // Add a new KeyID to an existing UBX-CFG-VALGET ubxPacket
+bool DevUBLOXGNSS::addCfgValget64(ubxPacket *pkt, uint32_t key) // Add a new key to an existing UBX-CFG-VALGET ubxPacket
 {
   return (addCfgValgetN(pkt, key, 64));
 }
@@ -8024,14 +8074,14 @@ bool DevUBLOXGNSS::sendCfgValget(uint16_t maxWait) // Send the CfgValget (UBX-CF
 
 bool DevUBLOXGNSS::sendCfgValget(ubxPacket *pkt, uint16_t maxWait) // Send the CfgValget (UBX-CFG-VALGET) construct
 {
-  if (_numGetCfgKeyIDs == 0)
+  if (_numGetCfgKeys == 0)
     return true; // Nothing to send...
 
   // Send VALSET command with this key and value
   bool success = sendCommand(pkt, maxWait) == SFE_UBLOX_STATUS_DATA_SENT; // We are only expecting an ACK
 
   if (success)
-    _numGetCfgKeyIDs = 0;
+    _numGetCfgKeys = 0;
 
   return success;
 }