Expand getVal/setVal method

examples/GetSetVal/Example1_GetSetPortSettings/Example1_GetSetPortSettings.ino

@@ -0,0 +1,100 @@
+/*
+  Configuring port settings using the newer getVal/setVal methods
+  By: Nathan Seidle
+  SparkFun Electronics
+  Date: October 23rd, 2020
+  License: MIT. See license file for more information but you can
+  basically do whatever you want with this code.
+
+  This example shows how to query a Ublox module for its UART1 settings and
+  then change them if the settings aren't what we want.
+
+  Note: getVal/setVal/delVal are only support in u-blox protocol versions 27 and higher.
+
+  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
+
+  Hardware Connections:
+  Plug a Qwiic cable into the GPS and a RedBoard
+  If you don't have a platform with a Qwiic connection use the SparkFun Qwiic Breadboard Jumper (https://www.sparkfun.com/products/14425)
+  Open the serial monitor at 115200 baud to see the output
+*/
+
+#include <Wire.h> //Needed for I2C to GPS
+
+#include "SparkFun_Ublox_Arduino_Library.h" //http://librarymanager/All#SparkFun_Ublox_GPS
+SFE_UBLOX_GPS myGPS;
+
+void setup()
+{
+  Serial.begin(115200);
+  while (!Serial)
+    ; //Wait for user to open terminal
+  Serial.println("SparkFun Ublox Example");
+
+  Wire.begin();
+
+  if (myGPS.begin() == false) //Connect to the Ublox module using Wire port
+  {
+    Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
+    while (1)
+      ;
+  }
+
+  bool response = true;
+
+  //Read the settings from RAM (what the module is running right now, not BBR, Flash, or default)
+  uint8_t currentUART1Setting_ubx = myGPS.getVal8(UBLOX_CFG_UART1INPROT_UBX);
+  uint8_t currentUART1Setting_nmea = myGPS.getVal8(UBLOX_CFG_UART1INPROT_NMEA);
+  uint8_t currentUART1Setting_rtcm3 = myGPS.getVal8(UBLOX_CFG_UART1INPROT_RTCM3X);
+
+  Serial.print("currentUART1Setting_ubx: ");
+  Serial.println(currentUART1Setting_ubx);
+  Serial.print("currentUART1Setting_nmea: ");
+  Serial.println(currentUART1Setting_nmea);
+  Serial.print("currentUART1Setting_rtcm3: ");
+  Serial.println(currentUART1Setting_rtcm3);
+
+  //Check if NMEA and RTCM are enabled for UART1
+  if (currentUART1Setting_ubx == 0 || currentUART1Setting_nmea == 0)
+  {
+    Serial.println("Updating UART1 configuration");
+
+    //setVal sets the values for RAM, BBR, and Flash automatically so no .saveConfiguration() is needed
+    response &= myGPS.setVal8(UBLOX_CFG_UART1INPROT_UBX, 1);    //Enable UBX on UART1 Input
+    response &= myGPS.setVal8(UBLOX_CFG_UART1INPROT_NMEA, 1);   //Enable NMEA on UART1 Input
+    response &= myGPS.setVal8(UBLOX_CFG_UART1INPROT_RTCM3X, 0); //Disable RTCM on UART1 Input
+
+    if (response == false)
+      Serial.println("SetVal failed");
+    else
+      Serial.println("SetVal succeeded");
+  }
+  else
+    Serial.println("No port change needed");
+
+  //Change speed of UART2
+  uint32_t currentUART2Baud = myGPS.getVal32(UBLOX_CFG_UART2_BAUDRATE);
+  Serial.print("currentUART2Baud: ");
+  Serial.println(currentUART2Baud);
+
+  if (currentUART2Baud != 57600)
+  {
+    response &= myGPS.setVal32(UBLOX_CFG_UART2_BAUDRATE, 57600);
+    if (response == false)
+      Serial.println("SetVal failed");
+    else
+      Serial.println("SetVal succeeded");
+  }
+  else
+    Serial.println("No baud change needed");
+
+  Serial.println("Done");
+}
+
+void loop()
+{
+}

examples/ZED-F9P/Example6_GetVal/Example6_GetVal.ino

@@ -1,12 +1,12 @@
 /*
-  Send UBX binary commands to enable RTCM sentences on Ublox ZED-F9P module
+  Get a device's I2C address using advanced getVal method
   By: Nathan Seidle
   SparkFun Electronics
   Date: January 9th, 2019
   License: MIT. See license file for more information but you can
   basically do whatever you want with this code.
 
-  Ublox changed how to configure their modules in 2019. As of version 23 of the UBX protocol the
+  u-blox changed how to configure their modules in 2019. As of version 23 of the UBX protocol the
   UBX-CFG commands are deprecated; they still work, they just recommend using VALSET, VALGET, and VALDEL
   commands instead. This example shows how to use this new command structure.
 
@@ -32,27 +32,31 @@ long lastTime = 0; //Simple local timer. Limits amount if I2C traffic to Ublox m
 void setup()
 {
   Serial.begin(115200);
-  while (!Serial); //Wait for user to open terminal
-  Serial.println("Ublox getVal example");
+  while (!Serial)
+    ; //Wait for user to open terminal
+  Serial.println("u-blox getVal example");
 
   Wire.begin();
   Wire.setClock(400000); //Increase I2C clock speed to 400kHz
 
   if (myGPS.begin() == false) //Connect to the Ublox module using Wire port
   {
-    Serial.println(F("Ublox GPS not detected at default I2C address. Please check wiring. Freezing."));
-    while (1);
+    Serial.println(F("u-blox GPS not detected at default I2C address. Please check wiring. Freezing."));
+    while (1)
+      ;
   }
 
   myGPS.enableDebugging(); //Enable debug messages over Serial (default)
   //myGPS.enableDebugging(SerialUSB); //Enable debug messages over Serial USB
 
-  uint8_t currentI2Caddress = myGPS.getVal8(0x20510001);
+#define UBLOX_CFG_I2C_ADDRESS 0x20510001
+
+  uint8_t currentI2Caddress = myGPS.getVal8(UBLOX_CFG_I2C_ADDRESS);
   Serial.print("Current I2C address (should be 0x42): 0x");
   Serial.println(currentI2Caddress >> 1, HEX); //Ublox module returns a shifted 8-bit address. Make it 7-bit unshifted.
 
-  while(1);
-
+  while (1)
+    ;
 }
 
 void loop()
@@ -83,4 +87,4 @@ void loop()
 
     Serial.println();
   }
-}
+}

keywords.txt

@@ -64,7 +64,10 @@ setUART2Output	KEYWORD2
 setUSBOutput	KEYWORD2
 setSPIOutput	KEYWORD2
 
+getVal	KEYWORD2
 getVal8	KEYWORD2
+getVal16	KEYWORD2
+getVal32	KEYWORD2
 setVal	KEYWORD2
 setVal8	KEYWORD2
 setVal16	KEYWORD2

src/SparkFun_Ublox_Arduino_Library.cpp

@@ -2,6 +2,7 @@
 	This is a library written for the u-blox ZED-F9P and NEO-M8P-2
 	SparkFun sells these at its website: www.sparkfun.com
 	Do you like this library? Help support SparkFun. Buy a board!
+	https://www.sparkfun.com/products/16481
 	https://www.sparkfun.com/products/15136
 	https://www.sparkfun.com/products/15005
 	https://www.sparkfun.com/products/15733
@@ -1639,32 +1640,11 @@ boolean SFE_UBLOX_GPS::factoryDefault(uint16_t maxWait)
   return (sendCommand(&packetCfg, maxWait) == SFE_UBLOX_STATUS_DATA_SENT); // We are only expecting an ACK
 }
 
-//Given a group, ID and size, return the value of this config spot
-//The 32-bit key is put together from group/ID/size. See other getVal to send key directly.
-//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_GPS::getVal8(uint16_t group, uint16_t id, uint8_t size, uint8_t layer, uint16_t maxWait)
-{
-  //Create key
-  uint32_t key = 0;
-  key |= (uint32_t)id;
-  key |= (uint32_t)group << 16;
-  key |= (uint32_t)size << 28;
-
-  if (_printDebug == true)
-  {
-    _debugSerial->print(F("key: 0x"));
-    _debugSerial->print(key, HEX);
-    _debugSerial->println();
-  }
-
-  return getVal8(key, layer, maxWait);
-}
-
-//Given a key, return its value
+//Given a key, load the payload with data that can then be extracted to 8, 16, or 32 bits
 //This function takes a full 32-bit key
-//Default layer is BBR
+//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
-uint8_t SFE_UBLOX_GPS::getVal8(uint32_t key, uint8_t layer, uint16_t maxWait)
+sfe_ublox_status_e SFE_UBLOX_GPS::getVal(uint32_t key, uint8_t layer, uint16_t maxWait)
 {
   packetCfg.cls = UBX_CLASS_CFG;
   packetCfg.id = UBX_CFG_VALGET;
@@ -1707,34 +1687,86 @@ uint8_t SFE_UBLOX_GPS::getVal8(uint32_t key, uint8_t layer, uint16_t maxWait)
   sfe_ublox_status_e retVal = sendCommand(&packetCfg, maxWait);
   if (_printDebug == true)
   {
-    _debugSerial->print(F("getVal8: sendCommand returned: "));
+    _debugSerial->print(F("getVal: sendCommand returned: "));
     _debugSerial->println(statusString(retVal));
   }
-  if (retVal != SFE_UBLOX_STATUS_DATA_RECEIVED) // We are expecting data and an ACK
-    return (0);                                 //If command send fails then bail
 
   //Verify the response is the correct length as compared to what the user called (did the module respond with 8-bits but the user called getVal32?)
   //Response is 8 bytes plus cfg data
   //if(packet->len > 8+1)
 
-  //Pull the requested value from the response
-  //Response starts at 4+1*N with the 32-bit key so the actual data we're looking for is at 8+1*N
+  //The response is now sitting in payload, ready for extraction
+  return (retVal);
+}
+
+//Given a key, return its value
+//This function takes a full 32-bit key
+//Default layer is RAM
+//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+uint8_t SFE_UBLOX_GPS::getVal8(uint32_t key, uint8_t layer, uint16_t maxWait)
+{
+  if (getVal(key, layer, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
+    return (0);
+
   return (extractByte(8));
 }
+uint16_t SFE_UBLOX_GPS::getVal16(uint32_t key, uint8_t layer, uint16_t maxWait)
+{
+  if (getVal(key, layer, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
+    return (0);
+
+  return (extractInt(8));
+}
+uint32_t SFE_UBLOX_GPS::getVal32(uint32_t key, uint8_t layer, uint16_t maxWait)
+{
+  if (getVal(key, layer, maxWait) != SFE_UBLOX_STATUS_DATA_RECEIVED)
+    return (0);
+
+  return (extractLong(8));
+}
+
+//Form 32-bit key from group/id/size
+uint32_t SFE_UBLOX_GPS::createKey(uint16_t group, uint16_t id, uint8_t size)
+{
+  uint32_t key = 0;
+  key |= (uint32_t)id;
+  key |= (uint32_t)group << 16;
+  key |= (uint32_t)size << 28;
+  return (key);
+}
+
+//Given a group, ID and size, return the value of this config spot
+//The 32-bit key is put together from group/ID/size. See other getVal to send key directly.
+//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+uint8_t SFE_UBLOX_GPS::getVal8(uint16_t group, uint16_t id, uint8_t size, uint8_t layer, uint16_t maxWait)
+{
+  uint32_t key = createKey(group, id, size);
+  return getVal8(key, layer, maxWait);
+}
+uint16_t SFE_UBLOX_GPS::getVal16(uint16_t group, uint16_t id, uint8_t size, uint8_t layer, uint16_t maxWait)
+{
+  uint32_t key = createKey(group, id, size);
+  return getVal16(key, layer, maxWait);
+}
+uint32_t SFE_UBLOX_GPS::getVal32(uint16_t group, uint16_t id, uint8_t size, uint8_t layer, uint16_t maxWait)
+{
+  uint32_t key = createKey(group, id, size);
+  return getVal32(key, layer, maxWait);
+}
 
 //Given a key, set a 16-bit value
 //This function takes a full 32-bit key
-//Default layer is BBR
-//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+//Default layer is all: RAM+BBR+Flash
+//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GPS::setVal(uint32_t key, uint16_t value, uint8_t layer, uint16_t maxWait)
 {
   return setVal16(key, value, layer, maxWait);
 }
 
 //Given a key, set a 16-bit value
 //This function takes a full 32-bit key
-//Default layer is BBR
-//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+//Default layer is all: RAM+BBR+Flash
+//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GPS::setVal16(uint32_t key, uint16_t value, uint8_t layer, uint16_t maxWait)
 {
   packetCfg.cls = UBX_CLASS_CFG;
@@ -1765,8 +1797,8 @@ uint8_t SFE_UBLOX_GPS::setVal16(uint32_t key, uint16_t value, uint8_t layer, uin
 
 //Given a key, set an 8-bit value
 //This function takes a full 32-bit key
-//Default layer is BBR
-//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+//Default layer is all: RAM+BBR+Flash
+//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GPS::setVal8(uint32_t key, uint8_t value, uint8_t layer, uint16_t maxWait)
 {
   packetCfg.cls = UBX_CLASS_CFG;
@@ -1796,8 +1828,8 @@ uint8_t SFE_UBLOX_GPS::setVal8(uint32_t key, uint8_t value, uint8_t layer, uint1
 
 //Given a key, set a 32-bit value
 //This function takes a full 32-bit key
-//Default layer is BBR
-//Configuration of modern u-blox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
+//Default layer is all: RAM+BBR+Flash
+//Configuration of modern Ublox modules is now done via getVal/setVal/delVal, ie protocol v27 and above found on ZED-F9P
 uint8_t SFE_UBLOX_GPS::setVal32(uint32_t key, uint32_t value, uint8_t layer, uint16_t maxWait)
 {
   packetCfg.cls = UBX_CLASS_CFG;