[SD] Fix Wokwi Testing, test_digital_input is having issues still

Author: brentru

src/Wippersnapper_V2.cpp

@@ -106,14 +106,12 @@ void Wippersnapper_V2::provisionV2() {
   _fileSystemV2->GetSDCSPin();
   #elif defined(USE_LITTLEFS)
   _littleFSV2->GetSDCSPin();
+  #elif defined(OFFLINE_MODE_WOKWI)
+  WsV2.pin_sd_cs = 15;
   #endif
   WsV2._sdCardV2 = new ws_sdcard();
   if (WsV2._sdCardV2->isSDCardInitialized()) {
-    //haltErrorV2("GOOD: passed sd cspin check", WS_LED_STATUS_KAT);
     return;
-  } else {
-    // We are hitting against this at 4:16pm 12/16/2021
-    haltErrorV2("ERROR: failed sd cspin check", WS_LED_STATUS_MQTT_CONNECTING);
   }
 
 #ifdef USE_DISPLAY
@@ -1200,11 +1198,10 @@ void Wippersnapper_V2::connectV2() {
   // NOTE: After this, bail out of this function and run the app loop!!!
   if (WsV2._sdCardV2->isModeOffline() == true) {
     WS_DEBUG_PRINTLN("[Offline] Running device configuration...");
-// Wait for incoming JSON string from Serial
-#ifdef OFFLINE_MODE_DEBUG
-    if (!WsV2._sdCardV2->waitForSerialConfig())
-      haltErrorV2("Unable to validate incoming JSON file");
-#endif
+    // If debug mode, wait for serial config
+    #ifdef OFFLINE_MODE_DEBUG
+    WsV2._sdCardV2->waitForSerialConfig();
+    #endif
     // Parse the JSON file
     if (!WsV2._sdCardV2->parseConfigFile())
       haltErrorV2("Failed to parse incoming JSON file");

src/provisioning/littlefs/WipperSnapper_LittleFS_V2.cpp

@@ -162,13 +162,12 @@ void WipperSnapper_LittleFS_V2::fsHalt(String msg,
 */
 /**************************************************************************/
 void WipperSnapper_LittleFS_V2::GetSDCSPin() {
-  DeserializationError error;
   // Attempt to open and deserialize the config.json file
   File file_cfg = LittleFS.open("/config.json");
   if (!file_cfg)
     WsV2.pin_sd_cs = 255;
 
-  error = deserializeJson(WsV2._config_doc, file_cfg);
+  DeserializationError error = deserializeJson(WsV2._config_doc, file_cfg);
   if (error) {
     file_cfg.close();
     WsV2.pin_sd_cs = 255;

src/provisioning/sdcard/ws_sdcard.cpp

@@ -529,9 +529,8 @@ bool ws_sdcard::parseConfigFile() {
   // It is not possible to continue running in offline mode without a valid
   // config file
   if (error) {
-    WS_DEBUG_PRINTLN(
-        "[SD] Runtime Error: Unable to deserialize config.json. Error Code: " +
-        String(error.c_str()));
+    WS_DEBUG_PRINT("[SD] Runtime Error: Unable to deserialize config.json");
+    WS_DEBUG_PRINTLN("\nError Code: " + String(error.c_str()));
     return false;
   }
   WS_DEBUG_PRINTLN("[SD] Successfully deserialized JSON config file!");
@@ -923,4 +922,116 @@ bool ws_sdcard::LogDS18xSensorEventToSD(
     LogJSONDoc(doc);
   }
   return true;
-}
+}
+
+#ifdef OFFLINE_MODE_DEBUG
+/**************************************************************************/
+/*!
+    @brief  Waits for a valid JSON string to be received via the hardware's
+            serial input or from a hardcoded test JSON string.
+    @returns True if a valid JSON string was received, False otherwise.
+*/
+/**************************************************************************/
+void ws_sdcard::waitForSerialConfig() {
+  json_test_data = "{"
+                   "\"exportVersion\": \"1.0.0\","
+                   "\"exportedBy\": \"tester\","
+                   "\"exportedAt\": \"2024-10-28T18:58:23.976Z\","
+                   "\"exportedFromDevice\": {"
+                   "\"board\": \"metroesp32s3\","
+                   "\"firmwareVersion\": \"1.0.0-beta.93\","
+                   "\"referenceVoltage\": 2.6,"
+                   "\"totalGPIOPins\": 11,"
+                   "\"totalAnalogPins\": 6"
+                   "},"
+                   "\"components\": ["
+                   "{"
+                   "\"componentAPI\": \"analogio\","
+                   "\"name\": \"Analog Pin\","
+                   "\"pinName\": \"D14\","
+                   "\"type\": \"analog_pin\","
+                   "\"mode\": \"ANALOG\","
+                   "\"direction\": \"INPUT\","
+                   "\"sampleMode\": \"TIMER\","
+                   "\"analogReadMode\": \"PIN_VALUE\","
+                   "\"period\": 5,"
+                   "\"isPin\": true"
+                   "},"
+                   "{"
+                   "\"componentAPI\": \"analogio\","
+                   "\"name\": \"Analog Pin\","
+                   "\"pinName\": \"D27\","
+                   "\"type\": \"analog_pin\","
+                   "\"mode\": \"ANALOG\","
+                   "\"direction\": \"INPUT\","
+                   "\"sampleMode\": \"TIMER\","
+                   "\"analogReadMode\": \"PIN_VALUE\","
+                   "\"period\": 5,"
+                   "\"isPin\": true"
+                   "},"
+                   "{"
+                   "\"componentAPI\": \"digitalio\","
+                   "\"name\": \"Button (D4)\","
+                   "\"pinName\": \"D4\","
+                   "\"type\": \"push_button\","
+                   "\"mode\": \"DIGITAL\","
+                   "\"sampleMode\": \"EVENT\","
+                   "\"direction\": \"INPUT\","
+                   "\"period\": 5,"
+                   "\"pull\": \"UP\","
+                   "\"isPin\": true"
+                   "},"
+                   "{"
+                   "\"componentAPI\": \"ds18x20\","
+                   "\"name\": \"DS18B20: Temperature Sensor (°F)\","
+                   "\"sensorTypeCount\": 2,"
+                   "\"sensorType1\": \"object-temp-fahrenheit\","
+                   "\"sensorType2\": \"object-temp\","
+                   "\"pinName\": \"D12\","
+                   "\"sensorResolution\": 12,"
+                   "\"period\": 5"
+                   "},"
+                   "{"
+                   "\"componentAPI\": \"ds18x20\","
+                   "\"name\": \"DS18B20: Temperature Sensor (°F)\","
+                   "\"sensorTypeCount\": 2,"
+                   "\"sensorType1\": \"object-temp-fahrenheit\","
+                   "\"sensorType2\": \"object-temp\","
+                   "\"pinName\": \"D25\","
+                   "\"sensorResolution\": 12,"
+                   "\"period\": 5"
+                   "}"
+                   "]"
+                   "}\\n\r\n";
+
+  _serialInput = ""; // Clear the serial input buffer
+  if (!_use_test_data) {
+    WS_DEBUG_PRINTLN("[SD] Waiting for incoming JSON string...");
+    while (true) {
+      // Check if there is data available to read
+      if (Serial.available() > 0) {
+        char c = Serial.read();
+        _serialInput += c;
+        if (_serialInput.endsWith("\\n")) {
+          WS_DEBUG_PRINTLN("[SD] End of JSON string detected!");
+          break;
+        }
+      }
+    }
+  }
+  // Trim the newline
+  _serialInput.trim();
+
+  // Print out the received JSON string
+  // TODO: REMOVE this for the PR 
+  WS_DEBUG_PRINT("[SD][Debug] JSON string received!");
+  if (_use_test_data) {
+    WS_DEBUG_PRINTLN("[from json test data]");
+    WS_DEBUG_PRINTLN(json_test_data);
+  } else {
+    WS_DEBUG_PRINTLN(_serialInput);
+  }
+
+  WS_DEBUG_PRINTLN("[SD] JSON string received!");
+}
+#endif

src/provisioning/sdcard/ws_sdcard.h

@@ -53,14 +53,14 @@ class ws_sdcard {
   bool parseConfigFile();
   bool CreateNewLogFile();
   bool isModeOffline() { return is_mode_offline; }
+  void waitForSerialConfig();
   bool LogGPIOSensorEventToSD(uint8_t pin, float value,
                               wippersnapper_sensor_SensorType read_type);
   bool LogGPIOSensorEventToSD(uint8_t pin, bool value,
                               wippersnapper_sensor_SensorType read_type);
   bool LogGPIOSensorEventToSD(uint8_t pin, uint16_t value,
                               wippersnapper_sensor_SensorType read_type);
   bool LogDS18xSensorEventToSD(wippersnapper_ds18x20_Ds18x20Event *event_msg);
-
 private:
   void calculateFileLimits();
   bool ValidateChecksum(JsonDocument &doc);

tests/bin/offline/firmware.elf

@@ -6,4 +6,4 @@ steps:
   - wait-serial: '[SD] Waiting for incoming JSON string...'
   - write-serial: '{"exportVersion":"1.0.0",'
   - write-serial: '\n'
-  - wait-serial: '[SD] Invalid JSON string received!'
+  - wait-serial: '[SD] Runtime Error: Unable to deserialize config.json'