EspTemperature.h

Go to the documentation of this file.

 
#pragma once
 
#include "base/BaseTemperature.h"
#include "utils/PlatformMutex.h"
 
// #ifdef HF_MCU_FAMILY_ESP32
 
// ESP-IDF includes for temperature sensor functionality
#ifdef __cplusplus
extern "C" {
#endif
 
#include "driver/temperature_sensor.h"
#include "esp_err.h"
#include "esp_log.h"
#include "esp_timer.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
 
#ifdef __cplusplus
}
#endif
 
#include <atomic>
#include <functional>
 
//--------------------------------------
//  ESP32-C6 Temperature Constants
//--------------------------------------
 
typedef enum {
  ESP_TEMP_RANGE_NEG10_80 = 0, 
  ESP_TEMP_RANGE_20_100 = 1,   
  ESP_TEMP_RANGE_NEG30_50 = 2, 
  ESP_TEMP_RANGE_50_125 = 3,   
  ESP_TEMP_RANGE_NEG40_20 = 4, 
  ESP_TEMP_RANGE_COUNT         
} esp_temp_range_t;
 
#define ESP_TEMP_DEFAULT_RESOLUTION_CELSIUS 0.25f 
#define ESP_TEMP_DEFAULT_RESPONSE_TIME_MS 50      
#define ESP_TEMP_DEFAULT_SAMPLE_RATE_HZ 10        
#define ESP_TEMP_MAX_SAMPLE_RATE_HZ 1000          
#define ESP_TEMP_MIN_SAMPLE_RATE_HZ 1             
#define ESP_TEMP_DEFAULT_TIMEOUT_MS 1000          
 
#define ESP_TEMP_ABSOLUTE_MIN_CELSIUS -40.0f    
#define ESP_TEMP_ABSOLUTE_MAX_CELSIUS 125.0f    
#define ESP_TEMP_RECOMMENDED_MIN_CELSIUS -10.0f 
#define ESP_TEMP_RECOMMENDED_MAX_CELSIUS 80.0f  
 
//--------------------------------------
//  ESP32-C6 Temperature Configuration
//--------------------------------------
 
typedef struct {
  temperature_sensor_handle_t handle;  
  esp_temp_range_t current_range;      
  float calibration_offset;            
  bool threshold_monitoring_enabled;   
  bool continuous_monitoring_active;   
  esp_timer_handle_t monitoring_timer; 
  hf_u32_t sample_rate_hz;             
  hf_u64_t last_reading_timestamp_us;  
  float last_temperature_celsius;      
  bool allow_power_down;               
} esp_temp_state_t;
 
typedef struct {
  esp_temp_range_t range;            
  float calibration_offset;          
  bool enable_threshold_monitoring;  
  float high_threshold_celsius;      
  float low_threshold_celsius;       
  bool enable_continuous_monitoring; 
  hf_u32_t sample_rate_hz;           
  bool allow_power_down;             
  hf_u32_t clk_src;                  
} esp_temp_config_t;
 
//--------------------------------------
//  ESP32-C6 Temperature Range Information
//--------------------------------------
 
typedef struct {
  esp_temp_range_t range;  
  float min_celsius;       
  float max_celsius;       
  float accuracy_celsius;  
  const char* description; 
} esp_temp_range_info_t;
 
//--------------------------------------
//  Forward Declarations
//--------------------------------------
 
class EspTemperature;
 
//--------------------------------------
//  ESP32-C6 Temperature Callback Types
//--------------------------------------
 
using esp_temp_threshold_callback_t =
    std::function<void(EspTemperature* sensor, float temperature, bool is_high_threshold)>;
 
using esp_temp_monitoring_callback_t =
    std::function<void(EspTemperature* sensor, float temperature, hf_u64_t timestamp_us)>;
 
//--------------------------------------
//  EspTemperature Class Declaration
//--------------------------------------
 
class EspTemperature : public BaseTemperature {
public:
  //==============================================================//
  // CONSTRUCTORS AND DESTRUCTOR
  //==============================================================//
 
  EspTemperature() noexcept;
 
  explicit EspTemperature(const esp_temp_config_t& esp_config) noexcept;
 
  EspTemperature(const EspTemperature&) = delete;
 
  EspTemperature& operator=(const EspTemperature&) = delete;
 
  virtual ~EspTemperature() noexcept;
 
protected:
  //==============================================================//
  // [PROTECTED] PURE VIRTUAL IMPLEMENTATIONS - PLATFORM SPECIFIC
  //==============================================================//
 
  bool Initialize() noexcept override;
 
  bool Deinitialize() noexcept override;
 
  hf_temp_err_t ReadTemperatureCelsiusImpl(float* temperature_celsius) noexcept override;
 
public:
  //==============================================================//
  // INFORMATION INTERFACE (MANDATORY OVERRIDES)
  //==============================================================//
 
  hf_temp_err_t GetSensorInfo(hf_temp_sensor_info_t* info) const noexcept override;
 
  [[nodiscard]] hf_u32_t GetCapabilities() const noexcept override;
 
  //==============================================================//
  // ADVANCED FEATURES (SUPPORTED BY ESP32-C6)
  //==============================================================//
 
  hf_temp_err_t SetRange(float min_celsius, float max_celsius) noexcept override;
 
  hf_temp_err_t GetRange(float* min_celsius, float* max_celsius) const noexcept override;
 
  hf_temp_err_t GetResolution(float* resolution_celsius) const noexcept override;
 
  hf_temp_err_t SetThresholds(float low_threshold_celsius,
                              float high_threshold_celsius) noexcept override;
 
  hf_temp_err_t GetThresholds(float* low_threshold_celsius,
                              float* high_threshold_celsius) const noexcept override;
 
  hf_temp_err_t EnableThresholdMonitoring(hf_temp_threshold_callback_t callback,
                                          void* user_data) noexcept override;
 
  hf_temp_err_t DisableThresholdMonitoring() noexcept override;
 
  hf_temp_err_t StartContinuousMonitoring(hf_u32_t sample_rate_hz,
                                          hf_temp_reading_callback_t callback,
                                          void* user_data) noexcept override;
 
  hf_temp_err_t StopContinuousMonitoring() noexcept override;
 
  [[nodiscard]] bool IsMonitoringActive() const noexcept override;
 
  hf_temp_err_t SetCalibrationOffset(float offset_celsius) noexcept override;
 
  hf_temp_err_t GetCalibrationOffset(float* offset_celsius) const noexcept override;
 
  hf_temp_err_t ResetCalibration() noexcept override;
 
  hf_temp_err_t EnterSleepMode() noexcept override;
 
  hf_temp_err_t ExitSleepMode() noexcept override;
 
  [[nodiscard]] bool IsSleeping() const noexcept override;
 
  hf_temp_err_t SelfTest() noexcept override;
 
  hf_temp_err_t CheckHealth() noexcept override;
 
  hf_temp_err_t GetStatistics(hf_temp_statistics_t& statistics) noexcept override;
 
  hf_temp_err_t GetDiagnostics(hf_temp_diagnostics_t& diagnostics) noexcept override;
 
  hf_temp_err_t ResetStatistics() noexcept override;
 
  hf_temp_err_t ResetDiagnostics() noexcept override;
 
  //==============================================================//
  // ESP32-C6 SPECIFIC METHODS
  //==============================================================//
 
  hf_temp_err_t InitializeEsp32(const esp_temp_config_t& esp_config) noexcept;
 
  hf_temp_err_t SetMeasurementRange(esp_temp_range_t range) noexcept;
 
  [[nodiscard]] esp_temp_range_t GetMeasurementRange() const noexcept;
 
  hf_temp_err_t GetRangeInfo(esp_temp_range_t range, float* min_celsius, float* max_celsius,
                             float* accuracy_celsius) const noexcept;
 
  [[nodiscard]] esp_temp_range_t FindOptimalRange(float min_celsius,
                                                  float max_celsius) const noexcept;
 
  hf_temp_err_t ReadRawTemperature(float* raw_value) noexcept;
 
  [[nodiscard]] temperature_sensor_handle_t GetEspHandle() const noexcept;
 
  hf_temp_err_t SetEspThresholdCallback(esp_temp_threshold_callback_t callback) noexcept;
 
  hf_temp_err_t SetEspMonitoringCallback(esp_temp_monitoring_callback_t callback) noexcept;
 
private:
  //==============================================================//
  // [PRIVATE] MEMBER VARIABLES
  //==============================================================//
 
  mutable PlatformMutex mutex_;           
  esp_temp_state_t esp_state_;        
  esp_temp_config_t esp_config_;      
  hf_temp_config_t base_config_;      
  hf_temp_statistics_t statistics_;   
  hf_temp_diagnostics_t diagnostics_; 
  hf_temp_err_t last_error_;          
 
  // Callback storage
  hf_temp_threshold_callback_t threshold_callback_;        
  hf_temp_reading_callback_t monitoring_callback_;         
  esp_temp_threshold_callback_t esp_threshold_callback_;   
  esp_temp_monitoring_callback_t esp_monitoring_callback_; 
  void* threshold_user_data_;                              
  void* monitoring_user_data_;                             
 
  //==============================================================//
  // [PRIVATE] HELPER METHODS
  //==============================================================//
 
  hf_temp_err_t ConvertEspError(esp_err_t esp_err) const noexcept;
 
  hf_temp_err_t ConfigureEspSensor() noexcept;
 
  hf_temp_err_t SetupRange(esp_temp_range_t range) noexcept;
 
  void GetRangeConfig(esp_temp_range_t range, float* min_celsius, float* max_celsius,
                      float* accuracy_celsius) const noexcept;
 
  void SetLastError(hf_temp_err_t error) noexcept;
 
  void UpdateStatistics(bool operation_successful, hf_u32_t operation_time_us) noexcept;
 
  void UpdateDiagnostics(hf_temp_err_t error) noexcept;
 
  static void MonitoringTimerCallback(void* arg) noexcept;
 
  void CheckThresholds(float temperature) noexcept;
 
  hf_temp_err_t ValidateConfig(const hf_temp_config_t* config) const noexcept;
 
  hf_temp_err_t ValidateEspConfig(const esp_temp_config_t* esp_config) const noexcept;
 
  static hf_u64_t GetCurrentTimeUs() noexcept;
 
  // Static constants
  static const char* TAG;                          
  static const esp_temp_range_info_t RANGE_INFO[]; 
 
  // Global shared driver state (ESP-IDF temperature sensor is singleton)
  static PlatformMutex s_shared_mutex_;                    
  static std::atomic<int> s_refcount_;                 
  static temperature_sensor_handle_t s_shared_handle_; 
};
 
//--------------------------------------
//  Default ESP32 Configuration
//--------------------------------------
 
#define ESP_TEMP_CONFIG_DEFAULT()                                                                  \
  {.range = ESP_TEMP_RANGE_NEG10_80,                                                               \
   .calibration_offset = 0.0f,                                                                     \
   .enable_threshold_monitoring = false,                                                           \
   .high_threshold_celsius = 80.0f,                                                                \
   .low_threshold_celsius = -10.0f,                                                                \
   .enable_continuous_monitoring = false,                                                          \
   .sample_rate_hz = ESP_TEMP_DEFAULT_SAMPLE_RATE_HZ,                                              \
   .allow_power_down = true,                                                                       \
   .clk_src = 0}
 
// #endif // HF_MCU_FAMILY_ESP32