Work without a RTC attached

Author: brentru

src/Wippersnapper_V2.h

@@ -127,7 +127,7 @@
 #endif
 
 #define WS_VERSION                                                             \
-  "1.0.0-alpha.1-offline" ///< WipperSnapper app. version (semver-formatted)
+  "1.0.0-offline-beta.1" ///< WipperSnapper app. version (semver-formatted)
 
 #define WS_WDT_TIMEOUT 60000       ///< WDT timeout
 #define WS_MAX_ALT_WIFI_NETWORKS 3 ///< Maximum number of alternative networks

src/Wippersnapper_demo.ino

@@ -11,7 +11,7 @@
 #include "ws_adapters.h"
 ws_adapter_wifi wipper;
 // Uncomment the following line to use the offline adapter for Pico
-// ws_adapter_offline wipper;
+//ws_adapter_offline wipper;
 
 #define WS_DEBUG // Enable debug output!
 

src/provisioning/sdcard/ws_sdcard.cpp

@@ -23,6 +23,7 @@ ws_sdcard::ws_sdcard()
     : _sd_spi_cfg(WsV2.pin_sd_cs, DEDICATED_SPI, SPI_SD_CLOCK) {
   is_mode_offline = false;
   _use_test_data = false;
+  _is_soft_rtc = false;
   _sz_cur_log_file = 0;
   _sd_cur_log_files = 0;
 
@@ -145,17 +146,33 @@ bool ws_sdcard::InitPCF8523() {
 
 /**************************************************************************/
 /*!
-    @brief    Initializes a software RTC.
-    @returns  True if the RTC was successfully initialized, False
+    @brief    Initializes a "soft" RTC for devices without a physical
+              RTC module attached.
+    @returns  True if the soft RTC was successfully initialized, False
               otherwise.
 */
 /**************************************************************************/
 bool ws_sdcard::InitSoftRTC() {
-  // NOTE: RTC_Soft always returns void
-  _rtc_soft->begin(DateTime(F(__DATE__), F(__TIME__)));
-  return true;
+  _is_soft_rtc = true;
+  _soft_rtc_counter = 0;
+  return _is_soft_rtc;
 }
 
+/**************************************************************************/
+/*!
+    @brief    Increments the "soft" RTC.
+*/
+/**************************************************************************/
+void ws_sdcard::TickSoftRTC() { _soft_rtc_counter++; }
+
+/**************************************************************************/
+/*!
+    @brief    Returns the current timestamp from the RTC.
+    @returns  The current timestamp from the RTC.
+*/
+/**************************************************************************/
+uint32_t ws_sdcard::GetSoftRTCTime() { return _soft_rtc_counter; }
+
 /**************************************************************************/
 /*!
     @brief  Initializes and configures a RTC for logging.
@@ -171,11 +188,11 @@ bool ws_sdcard::ConfigureRTC(const char *rtc_type) {
     return InitDS3231();
   } else if (strcmp(rtc_type, "PCF8523") == 0) {
     return InitPCF8523();
-  } else if (strcmp(rtc_type, "SOFT_RTC") == 0) {
+  } else if (strcmp(rtc_type, "SOFT") == 0) {
     return InitSoftRTC();
-  }
-  WS_DEBUG_PRINTLN(
-      "[SD] Runtime Error: Unknown RTC type found in JSON string!");
+  } else
+    WS_DEBUG_PRINTLN(
+        "[SD] Runtime Error: Unknown RTC type found in JSON string!");
   return false;
 }
 
@@ -577,17 +594,21 @@ bool ws_sdcard::CreateNewLogFile() {
     return false;
   }
 
-  File32 file;
+  String logFilename;
   // Generate a name for the new log file using the RTC's timestamp
-  String logFilename = "log_" + String(GetTimestamp()) + ".log";
+  if (!_is_soft_rtc)
+    logFilename = "log_" + String(GetTimestamp()) + ".log";
+  else
+    logFilename = "log_" + String(millis()) + ".log";
   static char log_filename_buffer[256];
   strncpy(log_filename_buffer, logFilename.c_str(),
           sizeof(log_filename_buffer) - 1);
   log_filename_buffer[sizeof(log_filename_buffer) - 1] = '\0';
   _log_filename = log_filename_buffer;
   _sz_cur_log_file = 0; // Reset the current log file size
 
-  // Attempt to create the new log file
+  // Attempt to create a new log file
+  File32 file;
   if (!file.open(_log_filename, O_RDWR | O_CREAT | O_AT_END))
     return false;
   WS_DEBUG_PRINT("[SD] Created new log file on SD card: ");
@@ -689,7 +710,7 @@ bool ws_sdcard::parseConfigFile() {
 
   WS_DEBUG_PRINTLN("Configuring RTC...");
 #ifndef OFFLINE_MODE_WOKWI
-  const char *json_rtc = exportedFromDevice["rtc"] | "SOFT_RTC";
+  const char *json_rtc = exportedFromDevice["rtc"] | "SOFT";
   WS_DEBUG_PRINT("RTC Type: ");
   WS_DEBUG_PRINTLN(json_rtc);
   if (!ConfigureRTC(json_rtc)) {
@@ -808,8 +829,11 @@ uint32_t ws_sdcard::GetTimestamp() {
     now = _rtc_ds1307->now();
   else if (_rtc_pcf8523 != nullptr)
     now = _rtc_pcf8523->now();
-  else if (_rtc_soft != nullptr) {
-    now = _rtc_soft->now();
+  else if (_is_soft_rtc) {
+    uint32_t cur_time = GetSoftRTCTime();
+    TickSoftRTC();
+    return cur_time; // early-return as we are not converting this "soft rtc" to
+                     // unixtime
   } else { // we're either using a simulator or have undefined behavior
     return 0;
   }

src/provisioning/sdcard/ws_sdcard.h

@@ -75,6 +75,8 @@ class ws_sdcard {
   bool InitDS3231();
   bool InitPCF8523();
   bool InitSoftRTC();
+  void TickSoftRTC();
+  uint32_t GetSoftRTCTime();
   wippersnapper_sensor_SensorType ParseSensorType(const char *sensor_type);
   bool ParseDigitalIOAdd(wippersnapper_digitalio_DigitalIOAdd &msg_DigitalIOAdd,
                          const char *pin, float period, bool value,
@@ -117,8 +119,9 @@ class ws_sdcard {
   RTC_DS3231 *_rtc_ds3231 = nullptr;   ///< DS3231 RTC object
   RTC_DS1307 *_rtc_ds1307 = nullptr;   ///< DS1307 RTC object
   RTC_PCF8523 *_rtc_pcf8523 = nullptr; ///< PCF8523 RTC object
-  RTC_Millis *_rtc_soft = nullptr;     ///< Software RTC object
-  bool _use_test_data; ///< True if sample data is being used for testing
+  bool _is_soft_rtc; ///< True if a "soft rtc" is being used, False otherwise
+  uint32_t _soft_rtc_counter; ///< Holds the counter for a "soft rtc"
+  bool _use_test_data;        ///< True if sample data is being used for testing
 };
 extern Wippersnapper_V2 WsV2;
 #endif // WS_SDCARD_H