EspLogger.h

Go to the documentation of this file.

 
#pragma once
 
#include "BaseLogger.h"
#include "utils/PlatformMutex.h"
 
#include <atomic>
#include <cstring>
#include <map>
#include <memory>
#include <vector>
 
#ifdef HF_MCU_FAMILY_ESP32
// ESP-IDF C headers must be wrapped in extern "C" for C++ compatibility
#ifdef __cplusplus
extern "C" {
#endif
 
#include "esp_log.h"
#include "esp_timer.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
 
// ESP-IDF Log V2 support
#ifdef CONFIG_LOG_VERSION_2
#include "esp_log_v2.h"
#endif
 
#ifdef __cplusplus
}
#endif
 
class EspLogger : public BaseLogger {
public:
  EspLogger() noexcept;
 
  ~EspLogger() noexcept override;
 
  //==============================================================================
  // BASELOGGER INTERFACE IMPLEMENTATION
  //==============================================================================
 
  hf_logger_err_t Initialize(const hf_logger_config_t& config) noexcept override;
 
  hf_logger_err_t Deinitialize() noexcept override;
 
  bool IsInitialized() const noexcept override;
 
  bool EnsureInitialized() noexcept override;
 
  hf_logger_err_t SetLogLevel(const char* tag, hf_log_level_t level) noexcept override;
 
  hf_logger_err_t GetLogLevel(const char* tag, hf_log_level_t& level) const noexcept override;
 
  //==============================================================================
  // LOGGING METHODS
  //==============================================================================
 
  hf_logger_err_t Error(const char* tag, const char* format, ...) noexcept override;
 
  hf_logger_err_t Warn(const char* tag, const char* format, ...) noexcept override;
 
  hf_logger_err_t Info(const char* tag, const char* format, ...) noexcept override;
 
  hf_logger_err_t Debug(const char* tag, const char* format, ...) noexcept override;
 
  hf_logger_err_t Verbose(const char* tag, const char* format, ...) noexcept override;
 
  hf_logger_err_t Log(hf_log_level_t level, const char* tag, const char* format,
                      ...) noexcept override;
 
  hf_logger_err_t LogV(hf_log_level_t level, const char* tag, const char* format,
                       va_list args) noexcept override;
 
  hf_logger_err_t LogWithLocation(hf_log_level_t level, const char* tag, const char* file,
                                  hf_u32_t line, const char* function, const char* format,
                                  ...) noexcept override;
 
  //==============================================================================
  // ESP-IDF LOG V2 ENHANCED METHODS
  //==============================================================================
 
  hf_logger_err_t LogBufferHex(const char* tag, const void* buffer, hf_u32_t length,
                               hf_log_level_t level = hf_log_level_t::LOG_LEVEL_INFO) noexcept;
 
  hf_logger_err_t LogBufferChar(const char* tag, const void* buffer, hf_u32_t length,
                                hf_log_level_t level = hf_log_level_t::LOG_LEVEL_INFO) noexcept;
 
  hf_logger_err_t LogBufferHexDump(const char* tag, const void* buffer, hf_u32_t length,
                                   hf_log_level_t level = hf_log_level_t::LOG_LEVEL_INFO) noexcept;
 
  hf_logger_err_t LogBuffer(const char* tag, const void* buffer, hf_u32_t length,
                            hf_log_level_t level = hf_log_level_t::LOG_LEVEL_INFO) noexcept;
 
  //==============================================================================
  // UTILITY METHODS
  //==============================================================================
 
  hf_logger_err_t Flush() noexcept override;
 
  bool IsLevelEnabled(hf_log_level_t level, const char* tag = nullptr) const noexcept override;
 
  hf_logger_err_t GetStatistics(hf_logger_statistics_t& statistics) const noexcept override;
 
  hf_logger_err_t GetDiagnostics(hf_logger_diagnostics_t& diagnostics) const noexcept override;
 
  hf_logger_err_t ResetStatistics() noexcept override;
 
  hf_logger_err_t ResetDiagnostics() noexcept override;
 
  bool IsHealthy() const noexcept override;
 
  hf_logger_err_t GetLastError() const noexcept override;
 
  hf_logger_err_t GetLastErrorMessage(char* message, hf_u32_t max_length) const noexcept override;
 
  bool IsLogV2Available() const noexcept;
 
  hf_u8_t GetLogVersion() const noexcept;
 
  //==============================================================================
  // DIAGNOSTIC PRINTING METHODS
  //==============================================================================
 
  hf_logger_err_t PrintStatistics(const char* tag = nullptr,
                                  bool detailed = true) const noexcept override;
 
  hf_logger_err_t PrintDiagnostics(const char* tag = nullptr,
                                   bool detailed = true) const noexcept override;
 
  hf_logger_err_t PrintStatus(const char* tag = nullptr,
                              bool detailed = true) const noexcept override;
 
private:
  //==============================================================================
  // PRIVATE MEMBERS
  //==============================================================================
 
  mutable PlatformMutex mutex_;       
  std::atomic<bool> initialized_; 
  std::atomic<bool> healthy_;     
 
  hf_logger_config_t config_;           
  hf_logger_statistics_t statistics_;   
  hf_logger_diagnostics_t diagnostics_; 
 
  std::map<std::string, hf_log_level_t, std::less<>> tag_levels_; 
  std::vector<char> message_buffer_;                 
 
  hf_logger_err_t last_error_;   
  char last_error_message_[256]; 
 
  hf_u64_t initialization_time_; 
  hf_u64_t last_health_check_;   
 
  // Log V2 specific members
  bool log_v2_available_; 
  hf_u8_t log_version_;   
 
  //==============================================================================
  // PRIVATE METHODS
  //==============================================================================
 
  esp_log_level_t ConvertLogLevel(hf_log_level_t level) const noexcept;
 
  hf_log_level_t ConvertLogLevel(esp_log_level_t level) const noexcept;
 
  hf_logger_err_t FormatMessage(hf_log_level_t level, const char* tag, const char* file,
                                hf_u32_t line, const char* function, const char* format,
                                va_list args, char* formatted_message,
                                hf_u32_t max_length) noexcept;
 
  hf_logger_err_t WriteMessage(hf_log_level_t level, const char* tag, const char* message,
                               hf_u32_t length) noexcept;
 
  hf_logger_err_t WriteMessageV(hf_log_level_t level, const char* tag, const char* format,
                                va_list args) noexcept;
 
  void UpdateStatistics(hf_log_level_t level, hf_u32_t message_length, bool success) noexcept;
 
  void UpdateDiagnostics(hf_logger_err_t error) noexcept;
 
  bool PerformHealthCheck() noexcept;
 
  hf_logger_err_t ValidateConfiguration(const hf_logger_config_t& config) const noexcept;
 
  const char* ConvertErrorToString(hf_logger_err_t error) const noexcept;
 
  hf_u64_t GetCurrentTimestamp() const noexcept;
 
  hf_u32_t GetCurrentThreadId() const noexcept;
 
  bool EnsureMessageBuffer(hf_u32_t required_length) noexcept;
 
  bool InitializeLogV2() noexcept;
 
  bool CheckLogV2Availability() const noexcept;
};
 
#endif // HF_MCU_FAMILY_ESP32