ntc_types.hpp

Go to the documentation of this file.

 
#pragma once
#include <cstdint>
 
//--------------------------------------
//  NTC Error Codes
//--------------------------------------
 
enum class NtcError : uint8_t {
  Success = 0,               
  Failure = 1,               
  NotInitialized = 2,        
  AlreadyInitialized = 3,    
  InvalidParameter = 4,      
  NullPointer = 5,           
  OutOfMemory = 6,           
  AdcReadFailed = 7,         
  InvalidResistance = 8,     
  TemperatureOutOfRange = 9, 
  LookupTableError = 10,     
  ConversionFailed = 11,     
  CalibrationFailed = 12,    
  UnsupportedOperation = 13, 
  Timeout = 14,              
  HardwareFault = 15,        
  Max = 16                   
};
 
//--------------------------------------
//  NTC Types
//--------------------------------------
 
enum class NtcType : uint8_t {
  Unknown = 0,           
  NtcG163Jft103Ft1S = 1, 
  NtcG164Jf103Ft1S = 2,  
  NtcG163Jf103Ft1S = 3,  
  Custom = 4,            
  Max = 5                
};
 
enum class NtcConversionMethod : uint8_t {
  LookupTable = 0,  
  Mathematical = 1, 
  Auto = 2          
};
 
//--------------------------------------
//  NTC Configuration
//--------------------------------------
 
struct ntc_config_t {
  NtcType type;             
  float resistance_at_25c;  
  float beta_value;         
  float reference_voltage;  
  float series_resistance;  
  float calibration_offset; 
  NtcConversionMethod conversion_method; 
  uint8_t adc_channel;                   
  uint32_t adc_resolution_bits;          
  uint32_t sample_count;                 
  uint32_t sample_delay_ms;              
  float min_temperature;                 
  float max_temperature;                 
  bool enable_filtering;                 
  float filter_alpha;                    
};
 
struct ntc_reading_t {
  float temperature_celsius;    
  float temperature_fahrenheit; 
  float temperature_kelvin;     
  float resistance_ohms;        
  float voltage_volts;          
  uint32_t adc_raw_value;       
  uint64_t timestamp_us;        
  NtcError error;               
  bool is_valid;                
  float accuracy_celsius;       
};
 
//--------------------------------------
//  Default Configurations
//--------------------------------------
 
namespace NTC::DefaultConfig {
constexpr float DEFAULT_RESISTANCE_AT_25C_ =
    10000.0F; 
constexpr float DEFAULT_BETA_VALUE_ = 3435.0F; 
constexpr float DEFAULT_REFERENCE_VOLTAGE_ =
    3.3F; 
constexpr float DEFAULT_SERIES_RESISTANCE_ =
    10000.0F; 
constexpr float DEFAULT_CALIBRATION_OFFSET_ =
    0.0F;                                   
constexpr uint8_t DEFAULT_ADC_CHANNEL_ = 0; 
constexpr uint32_t DEFAULT_ADC_RESOLUTION_BITS_ =
    12U; 
constexpr uint32_t DEFAULT_SAMPLE_COUNT_ = 1U;    
constexpr uint32_t DEFAULT_SAMPLE_DELAY_MS_ = 0U; 
constexpr float DEFAULT_MIN_TEMPERATURE_ =
    -40.0F; 
constexpr float DEFAULT_MAX_TEMPERATURE_ =
    125.0F; 
constexpr bool DEFAULT_ENABLE_FILTERING_ = false; 
constexpr float DEFAULT_FILTER_ALPHA_ = 0.1F; 
} // namespace NTC::DefaultConfig
 
[[nodiscard]] constexpr ntc_config_t
GetDefaultNtcG163Jft103Ft1SConfig() noexcept {
  return {.type = NtcType::NtcG163Jft103Ft1S,
          .resistance_at_25c = NTC::DefaultConfig::DEFAULT_RESISTANCE_AT_25C_,
          .beta_value = NTC::DefaultConfig::DEFAULT_BETA_VALUE_,
          .reference_voltage = NTC::DefaultConfig::DEFAULT_REFERENCE_VOLTAGE_,
          .series_resistance = NTC::DefaultConfig::DEFAULT_SERIES_RESISTANCE_,
          .calibration_offset = NTC::DefaultConfig::DEFAULT_CALIBRATION_OFFSET_,
          .conversion_method = NtcConversionMethod::Auto,
          .adc_channel = NTC::DefaultConfig::DEFAULT_ADC_CHANNEL_,
          .adc_resolution_bits =
              NTC::DefaultConfig::DEFAULT_ADC_RESOLUTION_BITS_,
          .sample_count = NTC::DefaultConfig::DEFAULT_SAMPLE_COUNT_,
          .sample_delay_ms = NTC::DefaultConfig::DEFAULT_SAMPLE_DELAY_MS_,
          .min_temperature = NTC::DefaultConfig::DEFAULT_MIN_TEMPERATURE_,
          .max_temperature = NTC::DefaultConfig::DEFAULT_MAX_TEMPERATURE_,
          .enable_filtering = NTC::DefaultConfig::DEFAULT_ENABLE_FILTERING_,
          .filter_alpha = NTC::DefaultConfig::DEFAULT_FILTER_ALPHA_};
}
 
[[nodiscard]] constexpr ntc_config_t GetDefaultNtcConfig() noexcept {
  return GetDefaultNtcG163Jft103Ft1SConfig();
}