temperature-measurement-app: review changes

Author: pimpalemahesh

examples/temperature-measurement-app/esp32/main/diagnostic-logs-provider-delegate-impl.cpp

@@ -29,7 +29,7 @@ using namespace chip::app::Clusters::DiagnosticLogs;
 LogProvider LogProvider::sInstance;
 LogProvider::CrashLogContext LogProvider::sCrashLogContext;
 
-#if CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
 static uint32_t sReadEntries = 0;
 static uint8_t retrievalBuffer[CONFIG_RETRIEVAL_BUFFER_SIZE];
 #endif // CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
@@ -80,7 +80,7 @@ size_t LogProvider::GetSizeForIntent(IntentEnum intent)
     switch (intent)
     {
     case IntentEnum::kEndUserSupport: {
-#if CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
         VerifyOrReturnError(mStorageInstance != nullptr, 0,
                             ChipLogError(DeviceLayer, "Diagnostic Storage instance cannot be null."));
         return mStorageInstance->GetDataSize();
@@ -120,7 +120,7 @@ CHIP_ERROR LogProvider::PrepareLogContextForIntent(LogContext * context, IntentE
     switch (intent)
     {
     case IntentEnum::kEndUserSupport: {
-#if CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
         VerifyOrReturnError(mStorageInstance != nullptr, CHIP_ERROR_INTERNAL,
                             ChipLogError(DeviceLayer, "Diagnostic Storage instance cannot be null."));
         MutableByteSpan endUserSupportSpan(retrievalBuffer, CONFIG_RETRIEVAL_BUFFER_SIZE);
@@ -130,7 +130,7 @@ CHIP_ERROR LogProvider::PrepareLogContextForIntent(LogContext * context, IntentE
         CHIP_ERROR err = mStorageInstance->Retrieve(endUserSupportSpan, sReadEntries);
         if (err != CHIP_NO_ERROR)
         {
-            ChipLogError(DeviceLayer, "Failed to retrieve data: %s", chip::ErrorStr(err));
+            ChipLogError(DeviceLayer, "Failed to retrieve data: %" CHIP_ERROR_FORMAT, err.Format());
             return err;
         }
         context->EndUserSupport.span = endUserSupportSpan;
@@ -318,7 +318,7 @@ CHIP_ERROR LogProvider::EndLogCollection(LogSessionHandle sessionHandle, CHIP_ER
         }
         else
         {
-            ChipLogProgress(DeviceLayer, "Cleared all read diagnostics successfully");
+            ChipLogDetail(DeviceLayer, "Cleared all read diagnostics successfully");
         }
     }
 #endif // CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE

examples/temperature-measurement-app/esp32/main/include/diagnostic-logs-provider-delegate-impl.h

@@ -26,7 +26,7 @@
 #include <esp_core_dump.h>
 #endif // defined(CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH) && defined(CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF)
 
-#if CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
 #include <tracing/esp32_diagnostic_trace/DiagnosticStorageManager.h>
 using namespace chip::Tracing::Diagnostics;
 #endif // CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
@@ -45,16 +45,7 @@ namespace DiagnosticLogs {
 class LogProvider : public DiagnosticLogsProviderDelegate
 {
 public:
-#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
-    static inline LogProvider & GetInstance(CircularDiagnosticBuffer * bufferInstance)
-    {
-        VerifyOrReturnValue(bufferInstance != nullptr, sInstance);
-        sInstance.mStorageInstance = bufferInstance;
-        return sInstance;
-    }
-#else
     static inline LogProvider & GetInstance() { return sInstance; }
-#endif
 
     /////////// DiagnosticLogsProviderDelegate Interface /////////
     CHIP_ERROR StartLogCollection(IntentEnum intent, LogSessionHandle & outHandle, Optional<uint64_t> & outTimeStamp,
@@ -64,6 +55,11 @@ class LogProvider : public DiagnosticLogsProviderDelegate
     size_t GetSizeForIntent(IntentEnum intent) override;
     CHIP_ERROR GetLogForIntent(IntentEnum intent, MutableByteSpan & outBuffer, Optional<uint64_t> & outTimeStamp,
                                Optional<uint64_t> & outTimeSinceBoot) override;
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+    void SetDiagnosticStorageInstance(CircularDiagnosticBuffer * bufferInstance) {
+        mStorageInstance = bufferInstance;
+    }
+#endif
 
 private:
     static LogProvider sInstance;
@@ -74,6 +70,7 @@ class LogProvider : public DiagnosticLogsProviderDelegate
     LogProvider & operator=(const LogProvider &) = delete;
 
 #ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+    // If mStorageInstance is nullptr then operations related to diagnostic storage will be skipped.
     CircularDiagnosticBuffer * mStorageInstance = nullptr;
 #endif // CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
 

examples/temperature-measurement-app/esp32/main/main.cpp

@@ -52,7 +52,7 @@
 #include <DeviceInfoProviderImpl.h>
 #endif // CONFIG_ENABLE_ESP32_DEVICE_INFO_PROVIDER
 
-#if CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
 #include <tracing/esp32_diagnostic_trace/DiagnosticTracing.h>
 static uint8_t endUserBuffer[CONFIG_END_USER_BUFFER_SIZE]; // Global static buffer used to store diagnostics
 using namespace chip::Tracing::Diagnostics;
@@ -82,8 +82,7 @@ static AppDeviceCallbacks EchoCallbacks;
 static void InitServer(intptr_t context)
 {
     Esp32AppServer::Init(); // Init ZCL Data Model and CHIP App Server AND Initialize device attestation config
-#if CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
-    diagnosticStorage.Init(endUserBuffer, CONFIG_END_USER_BUFFER_SIZE);
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
     static ESP32Diagnostics diagnosticBackend(&diagnosticStorage);
     Tracing::Register(diagnosticBackend);
 #endif // CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
@@ -144,10 +143,9 @@ extern "C" void app_main()
 using namespace chip::app::Clusters::DiagnosticLogs;
 void emberAfDiagnosticLogsClusterInitCallback(chip::EndpointId endpoint)
 {
-#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
-    auto & logProvider = LogProvider::GetInstance(&diagnosticStorage);
-#else
     auto & logProvider = LogProvider::GetInstance();
+#ifdef CONFIG_ENABLE_ESP_DIAGNOSTICS_TRACE
+    logProvider.SetDiagnosticStorageInstance(&diagnosticStorage);
 #endif
     DiagnosticLogsServer::Instance().SetDiagnosticLogsProviderDelegate(endpoint, &logProvider);
 }