mcp9700_thermistor.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <cmath>
#include <cstdint>
 
#include "mcp9700_version.h"
 
namespace hf {
namespace mcp9700 {
 
inline constexpr float kDefaultVoltsAtZeroC = 0.5F;
 
inline constexpr float kDefaultVoltsPerCelsius = 0.01F;
 
inline constexpr float kDefaultSpecifiedMinCelsius = -40.0F;
 
inline constexpr float kDefaultSpecifiedMaxCelsius = 125.0F;
 
inline constexpr float kDefaultRangeMarginCelsius = 8.0F;
 
enum class Error : uint8_t {
    kNone = 0,            
    kNotInitialized,      
    kInvalidArgument,     
    kInvalidCoefficients, 
    kAdcError,            
    kOutOfRange,          
};
 
template <typename AdcType>
class Mcp9700Thermistor {
public:
    Mcp9700Thermistor(AdcType* adc_interface, uint8_t adc_channel,
                      float v_zero_c = kDefaultVoltsAtZeroC,
                      float v_per_c = kDefaultVoltsPerCelsius) noexcept;
 
    Mcp9700Thermistor(const Mcp9700Thermistor&) = delete;
    Mcp9700Thermistor& operator=(const Mcp9700Thermistor&) = delete;
 
    ~Mcp9700Thermistor() noexcept = default;
 
    bool Initialize() noexcept;
 
    bool Deinitialize() noexcept;
 
    bool ReadTemperatureCelsius(float* temperature_celsius) noexcept;
 
    bool ReadVoltage(float* voltage_v) noexcept;
 
    bool SetSpecifiedRange(float min_celsius, float max_celsius,
                           float margin_celsius = kDefaultRangeMarginCelsius) noexcept;
 
    [[nodiscard]] float SpecifiedMinCelsius() const noexcept { return min_c_; }
 
    [[nodiscard]] float SpecifiedMaxCelsius() const noexcept { return max_c_; }
 
    [[nodiscard]] float RangeMarginCelsius() const noexcept { return margin_c_; }
 
    [[nodiscard]] Error LastError() const noexcept { return last_error_; }
 
    [[nodiscard]] bool HasValidCoefficients() const noexcept {
        return std::isfinite(v_zero_c_) && std::isfinite(v_per_c_) && v_per_c_ > 0.0F;
    }
 
    [[nodiscard]] float VoltsAtZeroC() const noexcept { return v_zero_c_; }
 
    [[nodiscard]] float VoltsPerCelsius() const noexcept { return v_per_c_; }
 
private:
    AdcType* adc_interface_;
    uint8_t adc_channel_;
    float v_zero_c_;
    float v_per_c_;
    float min_c_;
    float max_c_;
    float margin_c_;
    Error last_error_;
    bool initialized_;
};
 
} // namespace mcp9700
} // namespace hf
 
inline const char* GetMcp9700DriverVersion() noexcept {
    return HF_MCP9700_VERSION_STRING;
}
 
// NOLINTNEXTLINE(bugprone-suspicious-include) — template implementation
#include "../src/mcp9700_thermistor.ipp"