Add deleteFile

Author: PaulZC

examples/SARA-R5_Example12_AssistNowOnline/SARA-R5_AssistNow_Online.ino

@@ -49,7 +49,7 @@ void processHTTPcommandResult(int profile, int command, int result)
 
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
-bool getAssistNowOnlineData(String theFile)
+bool getAssistNowOnlineData(String theFilename)
 {
   // Use HTTP GET to receive the AssistNow_Online data. Store it in the SARA-R5's internal file system.
 
@@ -75,7 +75,7 @@ bool getAssistNowOnlineData(String theFile)
   Serial.println(theRequestStr);
 
   Serial.print(F("getAssistNowOnlineData: the AssistNow data will be stored in: "));
-  Serial.println(theFile);
+  Serial.println(theFilename);
 
   // Reset HTTP profile 0
   mySARA.resetHTTPprofile(0);
@@ -92,7 +92,7 @@ bool getAssistNowOnlineData(String theFile)
   httpResultSeen = false; // Clear the flag
 
   // HTTP GET
-  mySARA.sendHTTPGET(0, theRequestStr, theFile);
+  mySARA.sendHTTPGET(0, theRequestStr, theFilename);
 
   // Wait for 20 seconds while calling mySARA.bufferedPoll() to see the HTTP result.
   Serial.print(F("getAssistNowOnlineData: Waiting up to 20 seconds for the HTTP Result"));
@@ -114,7 +114,7 @@ bool getAssistNowOnlineData(String theFile)
   }
 
   int fileSize;
-  if (mySARA.getFileSize(theFile, &fileSize) != SARA_R5_SUCCESS)
+  if (mySARA.getFileSize(theFilename, &fileSize) != SARA_R5_SUCCESS)
   {
     Serial.print(F("getAssistNowOnlineData: No file written?!"));
     return false;    

examples/SARA-R5_Example12_AssistNowOnline/SARA-R5_Example12_AssistNowOnline.ino

@@ -156,9 +156,9 @@ void setup()
 
   // Request the AssistNow data from the server. Data is stored in the SARA's file system.
 
-  String theFile = "assistnow_online.ubx"; // The file that will contain the AssistNow Online data
+  String theFilename = "assistnow_online.ubx"; // The file that will contain the AssistNow Online data
 
-  if (getAssistNowOnlineData(theFile) == false) // See SARA-R5_AssistNow_Online.ino
+  if (getAssistNowOnlineData(theFilename) == false) // See SARA-R5_AssistNow_Online.ino
   {
     Serial.println(F("getAssistNowOnlineData failed! Freezing..."));
     while (1)
@@ -171,7 +171,7 @@ void setup()
 
   // Read the data from file
   String theAssistData = "";
-  if (mySARA.getFileContents(theFile, &theAssistData) != SARA_R5_SUCCESS)
+  if (mySARA.getFileContents(theFilename, &theAssistData) != SARA_R5_SUCCESS)
   {
     Serial.println(F("getFileContents failed! Freezing..."));
     while (1)
@@ -198,6 +198,13 @@ void setup()
 
   // Set setI2CpollingWait to 125ms to avoid pounding the I2C bus
   myGNSS.setI2CpollingWait(125);
+
+  // Delete the file after use. This is optional as the SARA will automatically overwrite the file.
+  // And you might want to reuse it? AssistNow Online data is valid for 2-4 hours.
+  //if (mySARA.deleteFile(theFilename) != SARA_R5_SUCCESS)
+  //{
+  //  Serial.println(F("Warning: deleteFile failed!"));
+  //}  
 }
 
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

keywords.txt

@@ -164,6 +164,7 @@ gpsRequest	KEYWORD2
 gpsAidingServerConf	KEYWORD2
 getFileContents	KEYWORD2
 getFileSize	KEYWORD2
+deleteFile	KEYWORD2
 functionality	KEYWORD2
 sendCustomCommandWithResponse	KEYWORD2
 

src/SparkFun_u-blox_SARA-R5_Arduino_Library.cpp

@@ -4133,6 +4133,31 @@ SARA_R5_error_t SARA_R5::getFileSize(String filename, int *size)
   return err;
 }
 
+SARA_R5_error_t SARA_R5::deleteFile(String filename)
+{
+  SARA_R5_error_t err;
+  char *command;
+
+  command = sara_r5_calloc_char(strlen(SARA_R5_FILE_SYSTEM_DELETE_FILE) + filename.length() + 8);
+  if (command == NULL)
+    return SARA_R5_ERROR_OUT_OF_MEMORY;
+  sprintf(command, "%s=\"%s\"", SARA_R5_FILE_SYSTEM_DELETE_FILE, filename.c_str());
+
+  err = sendCommandWithResponse(command, SARA_R5_RESPONSE_OK, NULL, SARA_R5_STANDARD_RESPONSE_TIMEOUT);
+
+  if (err != SARA_R5_ERROR_SUCCESS)
+  {
+    if (_printDebug == true)
+    {
+      _debugPort->print(F("deleteFile: Fail: Error: "));
+      _debugPort->println(err);
+    }
+  }
+
+  free(command);
+  return err;
+}
+
 SARA_R5_error_t SARA_R5::modulePowerOff(void)
 {
   SARA_R5_error_t err;

src/SparkFun_u-blox_SARA-R5_Arduino_Library.h

@@ -167,8 +167,10 @@ const char SARA_R5_GNSS_CONFIGURE_SENSOR[] = "+ULOCGNSS";    // Configure GNSS s
 const char SARA_R5_GNSS_CONFIGURE_LOCATION[] = "+ULOCCELL";  // Configure cellular location sensor (CellLocate®)
 const char SARA_R5_AIDING_SERVER_CONFIGURATION[] = "+UGSRV"; // Configure aiding server (CellLocate®)
 // ### File System
-const char SARA_R5_FILE_SYSTEM_READ_FILE[] = "+URDFILE";    // Read a file
-const char SARA_R5_FILE_SYSTEM_LIST_FILES[] = "+ULSTFILE";  // List of files, size of file, etc.
+// TO DO: Add support for file tags. Default tag to USER
+const char SARA_R5_FILE_SYSTEM_READ_FILE[] = "+URDFILE";      // Read a file
+const char SARA_R5_FILE_SYSTEM_LIST_FILES[] = "+ULSTFILE";    // List of files, size of file, etc.
+const char SARA_R5_FILE_SYSTEM_DELETE_FILE[] = "+UDELFILE";   // Delete a file
 // ### Response
 const char SARA_R5_RESPONSE_OK[] = "OK\r\n";
 const char SARA_R5_RESPONSE_ERROR[] = "ERROR\r\n";
@@ -786,8 +788,10 @@ class SARA_R5 : public Print
                                       unsigned int gnssTypes = 65, unsigned int mode = 0, unsigned int dataType = 15);
 
   // File system
+  // TO DO: add full support for file tags. Default tag to USER
   SARA_R5_error_t getFileContents(String filename, String *contents);
   SARA_R5_error_t getFileSize(String filename, int *size);
+  SARA_R5_error_t deleteFile(String filename);
 
   // Functionality
   SARA_R5_error_t functionality(SARA_R5_functionality_t function = FULL_FUNCTIONALITY);