GuruMeditation error while : Committing the document

[Eashubh128]

Hey , I am on the library version 1.4.11 ,
String success = Docs.commit(aClient, Firestore::Parent(FIREBASE_PROJECT_ID), writes);
This line give me , the following error
23:00:30.188 -> Event task: task_1362, msg: authenticating, code: 7
23:00:30.188 -> Debug task: task_1362, msg: Connecting to server...
23:00:30.188 -> Guru Meditation Error: Core 1 panic'ed (Unhandled debug exception).
23:00:30.188 -> Debug exception reason: Stack canary watchpoint triggered (loopTask)
23:00:30.188 -> Core 1 register dump:

[mobizt]

That is stack overflow.

You have to debug your code to minimize the memory usage inside some callback functions or increase the stack size for the FreeRTOS task.

[mobizt]

The stack of loopTask (the main loop() function) is overflown which indicates that the memory uses for the local variable that is defined in the main loop is too large.

[Eashubh128]

I have tried , this one , but the error comes Docs.commit(aClient, Firestore::Parent(FIREBASE_PROJECT_ID), writes). In this line it self.
I am doing the following operations inside a function

1. Creating Values
2. patching some values
3. Creating two separate write operations for appending map value to arrays (2 arrays)
4. Committing the writes

the function is

void generateDocument() {
  debugPrint("Generating document ......");
  if (!connectToWiFi()) {
    debugPrint("Failed to connect to WiFi. Cannot send data to Firebase.");
    return;
  }
  updateWiFiLED();
  taskcomplete = false;
  String documentName = deviceDetails.DEVICE_ID.c_str();
  String documentNameOrig = documentName;
  String dateTime = getLocalTime();
  documentName.replace(" ", "%20");

  String documentPath = COLLECTION_PATH + documentName;
  String documentPath2 = COLLECTION_PATH + documentNameOrig;

  Values::IntegerValue timesRef(deviceDetails.timesRef);
  Values::IntegerValue cupsRem(deviceDetails.cupsRem);
  Values::StringValue devId(deviceDetails.DEVICE_ID.c_str());
  Values::StringValue sNo(deviceDetails.serialNumber);
  Values::StringValue wifiIdentifier(wifiDetails.ssid.c_str());
  Values::StringValue wifiPassword(wifiDetails.password.c_str());
  Values::StringValue installedOn(deviceDetails.installedOn.c_str());
  Values::StringValue installedBy(deviceDetails.installedBy.c_str());
  Values::StringValue macAdr(deviceDetails.macAdr);
  Values::StringValue refOn(deviceDetails.refOn.c_str());
  Values::StringValue refBy(deviceDetails.refBy.c_str());
  Values::StringValue lastUpd(dateTime.c_str());
  double latitude = std::stod(latlng.latitude);
  double longitude = std::stod(latlng.longitude);
  Values::GeoPointValue geoV(number_t(latitude, 14), number_t(longitude, 14));
  Values::DoubleValue washRem1(mouthWashDetail1.mouthWashPercentage);
  Values::DoubleValue washRem2(mouthWashDetail2.mouthWashPercentage);
  Values::DoubleValue battPer(deviceDetails.batteryPercentage);
  Values::StringValue deviceType(deviceDetails.devicetype.c_str());
  Values::StringValue deviceAddress(deviceDetails.deviceAddress.c_str());
  Values::StringValue floorDetails(deviceDetails.floorDetails.c_str());
  Values::StringValue postCode(deviceDetails.postCode.c_str());
  Values::StringValue clientName(deviceDetails.clientName.c_str());
  Values::StringValue devType(deviceDetails.devicetype.c_str());
  Values::StringValue cscDetails(deviceDetails.cscDetails.c_str());
  Values::StringValue contactName(deviceDetails.contactPrName.c_str());
  Values::StringValue contactNumber(deviceDetails.contactPrNo.c_str());
  Values::IntegerValue numberOfCupsRefilledInLastRefill(deviceDetails.numberOfCupsRefilledInLastRefill);
  Values::IntegerValue wasLiquidAddedInLastRefill(deviceDetails.wasLiquidRefilledInLastRefill);

  Document<Values::Value> doc("devId", Values::Value(devId));
  doc.add("sNo",Values::Value(sNo));
  doc.add("instOn", Values::Value(installedOn));
  doc.add("instBy", Values::Value(installedBy));
  doc.add("macAdr", Values::Value(macAdr));
  // doc.add("refOn", Values::Value(refOn));
  // doc.add("refBy", Values::Value(refBy));
  doc.add("latlng", Values::Value(geoV));
  doc.add("lstUpd", Values::Value(lastUpd));
  doc.add("wifiId", Values::Value(wifiIdentifier));
  doc.add("wifiPass", Values::Value(wifiPassword));
  doc.add("deviceType", Values::Value(deviceType));
  doc.add("deviceAddress", Values::Value(deviceAddress));
  doc.add("floorDetails", Values::Value(floorDetails));
  doc.add("postCode", Values::Value(postCode));
  doc.add("clientName", Values::Value(clientName));
  doc.add("cscDetails", Values::Value(cscDetails));
  doc.add("contactPr", Values::Value(contactName));
  doc.add("contactPrNo", Values::Value(contactNumber));

  String historyFieldPath = "history";
  String refillHistoryPath = "refHistory";


  if (!taskcomplete) {
    taskcomplete = true;
    debugPrint("Document patching ......");
    PatchDocumentOptions patchOptions(DocumentMask("sNo,devId,instOn,instBy,macAdr,latlng,lstUpd,wifiPass,wifiId,deviceType,deviceAddress,floorDetails,postCode,clientName,cscDetails,contactPr,contactPrNo"), DocumentMask(), Precondition());
    debugPrint("Patch Options created ......");
    String patchPayload = Docs.patch(aClient, Firestore::Parent(FIREBASE_PROJECT_ID), documentPath, patchOptions, doc);



    debugPrint("Patch done ...... response : " + String(patchPayload));
    Values::MapValue historyMap("battRem", Values::Value(battPer));
    historyMap.add("washRem1", Values::Value(washRem1));
    historyMap.add("cupsRem", Values::Value(cupsRem));
    historyMap.add("time", Values::Value(lastUpd));
    debugPrint("Created historyMap ......");
    Values::ArrayValue historyArray(historyMap);
    debugPrint("Push history added to array ......");
    Values::MapValue refillHistoryMap("refOn", Values::Value(refOn));
    refillHistoryMap.add("refBy", Values::Value(refBy));
    refillHistoryMap.add("cupsRef", Values::Value(numberOfCupsRefilledInLastRefill));
    refillHistoryMap.add("liquidRef", Values::Value(wasLiquidAddedInLastRefill));
    debugPrint("Created refill historyMap ......");
    Values::ArrayValue refillHistoryArray(refillHistoryMap);
    debugPrint("Refill history added to array ......");

    FieldTransform::AppendMissingElements<Values::ArrayValue> appendValue(historyArray);
    FieldTransform::AppendMissingElements<Values::ArrayValue> appendRefillValue(refillHistoryArray);

    debugPrint("appendValue created ......");
    FieldTransform::FieldTransform fieldTransforms(historyFieldPath, appendValue);
    FieldTransform::FieldTransform refillFieldTransforms(refillHistoryPath, appendRefillValue);
    debugPrint("field transforms created ......");
    DocumentTransform transform(documentPath2, fieldTransforms);
    DocumentTransform refillDocumentTransforms(documentPath2, refillFieldTransforms);
    debugPrint("Document transforms created ......");
    Writes writes(Write(transform, Precondition() /* currentDocument precondition */));
    writes.add(Write(refillDocumentTransforms, Precondition() /* currentDocument precondition */));
  
    debugPrint("Writes created ......");
    String commitPayload = Docs.commit(aClient, Firestore::Parent(FIREBASE_PROJECT_ID), writes); // This line gives me the error
    debugPrint("Docs committed ......");
    if (millis() - wifiStartTime > WIFI_UPLOAD_TIMEOUT) {
      debugPrint("Firebase upload timed out after 10 seconds. Going to sleep.");
      startDeepSleep();
    } else {
      if (aClient.lastError().code() == 0) {
        // debugPrint(commitPayload);
        firebaseUpdateDone = true;
        preferences.begin("deviceDetails", false);
        preferences.putBool("pushRefillHistory", false);
        debugPrint("Firebase update completed successfully.");
        startDeepSleep();
      } else {
        firebaseUpdateDone = true;
        debugPrint("Firebase update failed ");
        printError(aClient.lastError().code(), aClient.lastError().message());
        startDeepSleep();
      }
    }
  }
}

[mobizt]

I told you already that the stack is overflown. You defined too many local objects inside the function which consumes more stack.

It is the stack memory limit in such low memory device. For ESP32 main loop task is 8k stack memory reserved by default.

The memory allocation for the class object used in this library is dynamic using Arduino String object as internal buffer.

You should reduce the internal object definition by try something like this.

// The doc object was passed by reference.
void myFunc (Document<Values::Value> &doc)
{

  Values::IntegerValue timesRef(deviceDetails.timesRef);
  Values::IntegerValue cupsRem(deviceDetails.cupsRem);
  Values::StringValue devId(deviceDetails.DEVICE_ID.c_str());
  Values::StringValue sNo(deviceDetails.serialNumber);
  Values::StringValue wifiIdentifier(wifiDetails.ssid.c_str());
  Values::StringValue wifiPassword(wifiDetails.password.c_str());
  Values::StringValue installedOn(deviceDetails.installedOn.c_str());
  Values::StringValue installedBy(deviceDetails.installedBy.c_str());
  Values::StringValue macAdr(deviceDetails.macAdr);
  Values::StringValue refOn(deviceDetails.refOn.c_str());
  Values::StringValue refBy(deviceDetails.refBy.c_str());
  Values::StringValue lastUpd(dateTime.c_str());
  double latitude = std::stod(latlng.latitude);
  double longitude = std::stod(latlng.longitude);
  Values::GeoPointValue geoV(number_t(latitude, 14), number_t(longitude, 14));
  Values::DoubleValue washRem1(mouthWashDetail1.mouthWashPercentage);
  Values::DoubleValue washRem2(mouthWashDetail2.mouthWashPercentage);
  Values::DoubleValue battPer(deviceDetails.batteryPercentage);
  Values::StringValue deviceType(deviceDetails.devicetype.c_str());
  Values::StringValue deviceAddress(deviceDetails.deviceAddress.c_str());
  Values::StringValue floorDetails(deviceDetails.floorDetails.c_str());
  Values::StringValue postCode(deviceDetails.postCode.c_str());
  Values::StringValue clientName(deviceDetails.clientName.c_str());
  Values::StringValue devType(deviceDetails.devicetype.c_str());
  Values::StringValue cscDetails(deviceDetails.cscDetails.c_str());
  Values::StringValue contactName(deviceDetails.contactPrName.c_str());
  Values::StringValue contactNumber(deviceDetails.contactPrNo.c_str());
  Values::IntegerValue numberOfCupsRefilledInLastRefill(deviceDetails.numberOfCupsRefilledInLastRefill);
  Values::IntegerValue wasLiquidAddedInLastRefill(deviceDetails.wasLiquidRefilledInLastRefill);

  doc.add("devId", Values::Value(devId));
  doc.add("sNo",Values::Value(sNo));
  doc.add("instOn", Values::Value(installedOn));
  doc.add("instBy", Values::Value(installedBy));
  doc.add("macAdr", Values::Value(macAdr));
  // doc.add("refOn", Values::Value(refOn));
  // doc.add("refBy", Values::Value(refBy));
  doc.add("latlng", Values::Value(geoV));
  doc.add("lstUpd", Values::Value(lastUpd));
  doc.add("wifiId", Values::Value(wifiIdentifier));
  doc.add("wifiPass", Values::Value(wifiPassword));
  doc.add("deviceType", Values::Value(deviceType));
  doc.add("deviceAddress", Values::Value(deviceAddress));
  doc.add("floorDetails", Values::Value(floorDetails));
  doc.add("postCode", Values::Value(postCode));
  doc.add("clientName", Values::Value(clientName));
  doc.add("cscDetails", Values::Value(cscDetails));
  doc.add("contactPr", Values::Value(contactName));
  doc.add("contactPrNo", Values::Value(contactNumber));

  // Those Values objects will be destroyed when exits the function.

}

You should avoid calling Serial print many places in your code inside a function because it consumes stack memory too.

The local patchPayload also takes more stack memory and should be avoid for storing large data for just debugging.

You can optimize the rest of your code based on my above recommendation.