Remote log name (#496)

* Use 'remote.log' for file name on device since name length is limited.

* Put filename in instance variable.

* Use shared remote log file name.

Author: jgfoster

extras/device_client/lib/model/version.dart

@@ -1 +1 @@
-const String gitVersion = 'v24.10.2-15-gbc+';
+const String gitVersion = 'v24.10.2-19-g1d+';

extras/scripts/build.sh

@@ -1,5 +1,5 @@
 #! /bin/bash
 bundle config set --local path 'vendor/bundle'
 bundle install
-bundle exec arduino_ci.rb --min-free-space=5654 --skip-unittests 1> >(tee stdout.txt ) 2> >(tee stderr.txt >&2 ); result=$?
+bundle exec arduino_ci.rb --min-free-space=5640 --skip-unittests 1> >(tee stdout.txt ) 2> >(tee stderr.txt >&2 ); result=$?
 exit "$result"

extras/scripts/testAndBuild.sh

@@ -3,6 +3,6 @@
 cp extras/scripts/p*-commit .git/hooks/
 bundle config set --local path 'vendor/bundle'
 bundle install
-bundle exec arduino_ci.rb --min-free-space=5654 1> >(tee stdout.txt ) 2> >(tee stderr.txt >&2 )
+bundle exec arduino_ci.rb --min-free-space=5640 1> >(tee stdout.txt ) 2> >(tee stderr.txt >&2 )
 result="${PIPESTATUS[0]}"
 exit "$result"

src/TankController.cpp

@@ -40,7 +40,8 @@ TankController *TankController::instance(const char *remoteLogName, const char *
   if (!_instance) {
     serial(F("\r\n##############\r\nTankController %s"), TANK_CONTROLLER_VERSION);
     _instance = new TankController();
-    SD_TC::instance()->setRemoteLogName(remoteLogName);
+    SD_TC::instance();
+    RemoteLogPusher::instance()->setRemoteLogName(remoteLogName);
     EEPROM_TC::instance();
     Keypad_TC::instance();
     LiquidCrystal_TC::instance(TANK_CONTROLLER_VERSION);

src/Version.h

@@ -1 +1 @@
-#define VERSION "v24.10.2-15-gbc+"
+#define VERSION "v24.10.2-19-g1d+"

src/model/RemoteLogPusher.cpp

@@ -25,6 +25,13 @@ RemoteLogPusher* RemoteLogPusher::instance() {
   return _instance;
 }
 
+void RemoteLogPusher::deleteInstance() {
+  if (_instance) {
+    delete _instance;
+    _instance = nullptr;
+  }
+}
+
 //  instance methods
 RemoteLogPusher::RemoteLogPusher() {
   this->buffer[0] = '\0';
@@ -154,18 +161,14 @@ void RemoteLogPusher::pushSoon() {
  *
  */
 void RemoteLogPusher::sendHeadRequest() {
-  const char* logName = SD_TC::instance()->getRemoteLogName();
-  if (logName[0] == '\0') {
-    return;
-  }
   static const char format[] PROGMEM =
       "HEAD /logs/%s HTTP/1.1\r\n"
       "Host: %s\r\n"
       "User-Agent: TankController/%s\r\n"
       "Accept: text/plain\r\n"
       "Connection: Close\r\n"
       "\r\n";
-  snprintf_P(buffer, sizeof(buffer), (PGM_P)format, logName, serverDomain, VERSION);
+  snprintf_P(buffer, sizeof(buffer), (PGM_P)format, remoteLogName, serverDomain, VERSION);
   if (client.connected() || client.connect(serverDomain, PORT) == 1) {  // this is a blocking step
     client.write(buffer, strnlen(buffer, sizeof(buffer)));
   } else {
@@ -177,10 +180,6 @@ void RemoteLogPusher::sendHeadRequest() {
 }
 
 void RemoteLogPusher::sendPostRequest() {
-  const char* logName = SD_TC::instance()->getRemoteLogName();
-  if (logName[0] == '\0') {
-    return;
-  }
   char data[300];
   SD_TC::instance()->getRemoteLogContents(data, sizeof(data), serverFileSize);
   static const char format[] PROGMEM =
@@ -191,7 +190,7 @@ void RemoteLogPusher::sendPostRequest() {
       "Content-Length: %i\r\n"
       "Connection: Close\r\n"
       "\r\n";
-  snprintf_P(buffer, sizeof(buffer), (PGM_P)format, logName, serverDomain, VERSION, strnlen(data, sizeof(data)));
+  snprintf_P(buffer, sizeof(buffer), (PGM_P)format, remoteLogName, serverDomain, VERSION, strnlen(data, sizeof(data)));
   if (client.connected() || client.connect(serverDomain, PORT) == 1) {  // this is a blocking step
     client.write(buffer, strnlen(buffer, sizeof(buffer)));
     client.write(data, strnlen(data, sizeof(data)));
@@ -202,6 +201,18 @@ void RemoteLogPusher::sendPostRequest() {
   state = PROCESS_POST_RESPONSE;
 }
 
+void RemoteLogPusher::setRemoteLogName(const char* newFileName) {
+  if (newFileName == nullptr || newFileName[0] == '\0') {
+    remoteLogName[0] = '\0';
+    return;
+  }
+  // See TankController.ino for the definition of remoteLogName
+  if (strnlen(newFileName, MAX_FILE_NAME_LENGTH + 1) <= MAX_FILE_NAME_LENGTH) {
+    // valid file name has been provided (See TankController.ino)
+    snprintf_P(remoteLogName, MAX_FILE_NAME_LENGTH + 5, PSTR("%s.log"), newFileName);
+  }
+}
+
 bool RemoteLogPusher::shouldSendHeadRequest() {
   return _shouldSendHeadRequest && millis() > delayRequestsUntilTime && !(PHControl::instance()->isOn());
 }

src/model/RemoteLogPusher.h

@@ -3,6 +3,8 @@
 
 #include "wrappers/Ethernet_TC.h"
 
+#define MAX_FILE_NAME_LENGTH 28
+
 /*
  * @brief RemoteLogPusher is a singleton that sends data records and remote logs to the server.
  *
@@ -45,12 +47,17 @@ class RemoteLogPusher {
 public:
   // class methods
   static RemoteLogPusher *instance();
+  static void deleteInstance();
 
   // instance methods
   RemoteLogPusher();
+  const char *getRemoteLogName() {
+    return remoteLogName;
+  }
   bool isReadyToPost();
   void loop();
   void pushSoon();
+  void setRemoteLogName(const char *newFileName = nullptr);
   bool shouldSendHeadRequest();
 
 #if defined(ARDUINO_CI_COMPILATION_MOCKS)
@@ -84,6 +91,7 @@ class RemoteLogPusher {
   clientState_t state = CLIENT_NOT_CONNECTED;
   uint32_t delayRequestsUntilTime = 40000;  // wait a bit before first request
   const char *serverDomain = "oap.cs.wallawalla.edu";
+  char remoteLogName[MAX_FILE_NAME_LENGTH + 5] = "";  // add ".log" with null-terminator
   char buffer[300];
   unsigned int index = 0;
   bool _isReadyToPost = false;

src/wrappers/SD_TC.cpp

@@ -42,7 +42,6 @@ SD_TC::SD_TC() {
   if (!sd.begin(SD_SELECT_PIN)) {
     Serial.println(F("SD_TC failed to initialize!"));
   }
-  remoteLogName[0] = '\0';
 }
 
 /**
@@ -123,11 +122,7 @@ bool SD_TC::format() {
 
 void SD_TC::getRemoteLogContents(char* buffer, int size, uint32_t index) {
   buffer[0] = '\0';
-  const char* logName = getRemoteLogName();
-  if (logName[0] == '\0') {
-    return;
-  }
-  File file = open(logName, O_RDONLY);
+  File file = open(remoteFileName, O_RDONLY);
   if (file) {
     file.seek(index);
     int remaining = file.available();
@@ -254,29 +249,13 @@ bool SD_TC::remove(const char* path) {
   return sd.remove(path);
 }
 
-void SD_TC::setRemoteLogName(const char* newFileName) {
-  if (newFileName == nullptr || newFileName[0] == '\0') {
-    remoteLogName[0] = '\0';
-    return;
-  }
-  // See TankController.ino for the definition of remoteLogName
-  if (strnlen(newFileName, MAX_FILE_NAME_LENGTH + 1) <= MAX_FILE_NAME_LENGTH) {
-    // valid file name has been provided (See TankController.ino)
-    snprintf_P(remoteLogName, MAX_FILE_NAME_LENGTH + 5, PSTR("%s.log"), newFileName);
-  }
-}
-
 void SD_TC::todaysDataFileName(char* path, int size) {
   DateTime_TC now = DateTime_TC::now();
   snprintf_P(path, size, (PGM_P)F("%4i%02i%02i.csv"), now.year(), now.month(), now.day());
 }
 
 void SD_TC::updateRemoteFileSize() {
-  if (remoteLogName[0] == '\0') {
-    remoteFileSize = 0;
-    return;
-  }
-  File file = open(remoteLogName, O_RDONLY);
+  File file = open(remoteFileName, O_RDONLY);
   if (file) {
     remoteFileSize = file.size();
     file.close();
@@ -295,23 +274,19 @@ void SD_TC::writeToRemoteLog(const char* line) {
   strncpy(mostRecentRemoteLogEntry, line, sizeof(mostRecentRemoteLogEntry));  // Flawfinder: ignore
   mostRecentRemoteLogEntry[sizeof(mostRecentRemoteLogEntry) - 1] = '\0';      // Ensure null-terminated string
 #endif
-  const char* logName = getRemoteLogName();
-  if (logName[0] == '\0') {
-    return;
-  }
-  if (!sd.exists(logName)) {
+  if (!sd.exists(remoteFileName)) {
     // rather than write an entire header line in one buffer, we break it into chunks to save memory
     char buffer[200];
     DataLogger::instance()->writeRemoteFileHeader(buffer, sizeof(buffer), 0);
-    appendStringToPath(buffer, remoteLogName, false);
+    appendStringToPath(buffer, remoteFileName, false);
     DataLogger::instance()->writeRemoteFileHeader(buffer, sizeof(buffer), 1);
-    appendStringToPath(buffer, remoteLogName, false);
+    appendStringToPath(buffer, remoteFileName, false);
     DataLogger::instance()->writeRemoteFileHeader(buffer, sizeof(buffer), 2);
-    appendStringToPath(buffer, remoteLogName, false);
+    appendStringToPath(buffer, remoteFileName, false);
     DataLogger::instance()->writeRemoteFileHeader(buffer, sizeof(buffer), 3);
-    appendStringToPath(buffer, remoteLogName);
+    appendStringToPath(buffer, remoteFileName);
   }
-  appendStringToPath(line, remoteLogName);
+  appendStringToPath(line, remoteFileName);
   updateRemoteFileSize();
   RemoteLogPusher::instance()->pushSoon();
 }

src/wrappers/SD_TC.h

@@ -31,15 +31,11 @@ class SD_TC {
   uint32_t getRemoteFileSize() {
     return remoteFileSize;
   }
-  const char* getRemoteLogName() {
-    return remoteLogName;
-  }
   bool listRootToBuffer(void (*callWhenFull)(const char*, bool));
   bool mkdir(const char* path);
   File open(const char* path, oflag_t oflag = 0x00);
   void printRootDirectory();
   bool remove(const char* path);
-  void setRemoteLogName(const char* newFileName = nullptr);
   void todaysDataFileName(char* path, int size);
   void writeToRemoteLog(const char* line);
 
@@ -60,8 +56,8 @@ class SD_TC {
   const uint8_t SD_SELECT_PIN = SS;
   bool hasHadError = false;
   SdFat sd;
-  char remoteLogName[MAX_FILE_NAME_LENGTH + 5] = "";  // add ".log" with null-terminator
   uint32_t remoteFileSize = 0;
+  const char remoteFileName[12] PROGMEM = "remote.log";
 
   // Max depth of file system search for rootdir()
   // Two is minimum: First for root, second for files

test/PushingBoxTest.cpp

@@ -6,6 +6,7 @@
 #include "EthernetServer_TC.h"
 #include "PHControl.h"
 #include "PushingBox.h"
+#include "RemoteLogPusher.h"
 #include "Serial_TC.h"
 #include "TankController.h"
 #include "ThermalControl.h"
@@ -46,7 +47,7 @@ unittest_teardown() {
 }
 
 unittest(NoTankID) {
-  SD_TC::instance()->setRemoteLogName("90A2DA807B76");
+  RemoteLogPusher::instance()->setRemoteLogName("90A2DA807B76");
   // set tank id to 0, set time interval to 1 minute
   EEPROM_TC::instance()->setTankID(0);