ntc_thermistor.hpp

Go to the documentation of this file.

 
#pragma once
#include <cstdint>
#include <memory>
 
#include "ntc_adc_interface.hpp"
#include "ntc_thermistor_version.h"
#include "ntc_types.hpp"
 
//--------------------------------------
//  NtcThermistor Class
//--------------------------------------
 
template <typename AdcType> class NtcThermistor {
public:
  //==============================================================//
  // CONSTRUCTORS AND DESTRUCTOR
  //==============================================================//
 
  NtcThermistor(NtcType ntc_type, AdcType *adc_interface) noexcept;
 
  NtcThermistor(const ntc_config_t &config, AdcType *adc_interface) noexcept;
 
  NtcThermistor(const NtcThermistor &) = delete;
 
  NtcThermistor &operator=(const NtcThermistor &) = delete;
 
  NtcThermistor(NtcThermistor &&) noexcept = default;
 
  NtcThermistor &operator=(NtcThermistor &&) noexcept = default;
 
  virtual ~NtcThermistor() noexcept = default;
 
  //==============================================================//
  // INITIALIZATION AND CONFIGURATION
  //==============================================================//
 
  bool Initialize() noexcept;
 
  bool Deinitialize() noexcept;
 
  [[nodiscard]] bool IsInitialized() const noexcept;
 
  NtcError GetConfiguration(ntc_config_t *config) const noexcept;
 
  NtcError SetConfiguration(const ntc_config_t &config) noexcept;
 
  //==============================================================//
  // TEMPERATURE READING
  //==============================================================//
 
  NtcError ReadTemperatureCelsius(float *temperature_celsius) noexcept;
 
  NtcError ReadTemperatureFahrenheit(float *temperature_fahrenheit) noexcept;
 
  NtcError ReadTemperatureKelvin(float *temperature_kelvin) noexcept;
 
  NtcError ReadTemperature(ntc_reading_t *reading) noexcept;
 
  //==============================================================//
  // RESISTANCE AND VOLTAGE
  //==============================================================//
 
  NtcError GetResistance(float *resistance_ohms) noexcept;
 
  NtcError GetVoltage(float *voltage_volts) noexcept;
 
  NtcError GetRawAdcValue(uint32_t *adc_value) noexcept;
 
  //==============================================================//
  // CALIBRATION
  //==============================================================//
 
  NtcError Calibrate(float reference_temperature_celsius) noexcept;
 
  NtcError SetCalibrationOffset(float offset_celsius) noexcept;
 
  NtcError GetCalibrationOffset(float *offset_celsius) const noexcept;
 
  NtcError ResetCalibration() noexcept;
 
  //==============================================================//
  // CONFIGURATION METHODS
  //==============================================================//
 
  NtcError SetConversionMethod(NtcConversionMethod method) noexcept;
 
  NtcError SetVoltageDivider(float series_resistance) noexcept;
 
  NtcError SetReferenceVoltage(float reference_voltage) noexcept;
 
  NtcError SetBetaValue(float beta_value) noexcept;
 
  NtcError SetAdcChannel(uint8_t adc_channel) noexcept;
 
  NtcError SetSamplingParameters(uint32_t sample_count,
                                 uint32_t sample_delay_ms) noexcept;
 
  NtcError SetFiltering(bool enable, float alpha = 0.1F) noexcept;
 
  //==============================================================//
  // UTILITY FUNCTIONS
  //==============================================================//
 
  static float CelsiusToFahrenheit(float celsius) noexcept;
 
  static float FahrenheitToCelsius(float fahrenheit) noexcept;
 
  static float CelsiusToKelvin(float celsius) noexcept;
 
  static float KelvinToCelsius(float kelvin) noexcept;
 
  static const char *GetErrorString(NtcError error) noexcept;
 
  static const char *GetTypeString(NtcType type) noexcept;
 
  // ===========================================================================
  // Driver Version
  // ===========================================================================
 
  static constexpr const char* GetDriverVersion() noexcept {
    return HF_NTC_THERMISTOR_VERSION_STRING;
  }
 
  static constexpr uint8_t GetDriverVersionMajor() noexcept {
    return HF_NTC_THERMISTOR_VERSION_MAJOR;
  }
 
  static constexpr uint8_t GetDriverVersionMinor() noexcept {
    return HF_NTC_THERMISTOR_VERSION_MINOR;
  }
 
  static constexpr uint8_t GetDriverVersionPatch() noexcept {
    return HF_NTC_THERMISTOR_VERSION_PATCH;
  }
 
private:
  //==============================================================//
  // PRIVATE MEMBER VARIABLES
  //==============================================================//
 
  ntc_config_t config_;    
  AdcType *adc_interface_; 
  bool initialized_;       
 
  // Filtering
  float filtered_temperature_; 
  bool filter_initialized_;    
 
  //==============================================================//
  // PRIVATE HELPER METHODS
  //==============================================================//
 
  [[nodiscard]] NtcError
  validateConfiguration(const ntc_config_t &config) const noexcept;
 
  NtcError readAdcVoltage(float *voltage_volts) noexcept;
 
  NtcError calculateResistance(float voltage_volts,
                               float *resistance_ohms) noexcept;
 
  NtcError convertResistanceToTemperature(float resistance_ohms,
                                          float *temperature_celsius) noexcept;
 
  float applyFiltering(float new_temperature) noexcept;
 
  void delayBetweenSamples() noexcept;
 
  static void initializeConfigForType(NtcType ntc_type,
                                      ntc_config_t *config) noexcept;
};
 
// =============================================================================
// Free-function version accessor (no namespace — class is at global scope)
// =============================================================================
 
inline const char* GetNtcThermistorDriverVersion() noexcept {
  return HF_NTC_THERMISTOR_VERSION_STRING;
}
 
// Include template implementation
#define NTC_THERMISTOR_HEADER_INCLUDED
// NOLINTNEXTLINE(bugprone-suspicious-include) - Template implementation file
#include "../src/ntc_thermistor.ipp"
#undef NTC_THERMISTOR_HEADER_INCLUDED