NTCT_Sensor.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       NTCT_Sensor.h
//! @brief      NTC termoresistor class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2016-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Common/NTCT_Sensor.h $
//!             $Revision: 2797 $
//!             $Date: 2021-07-12 16:13:33 +0500 (Mo, 12 Jul 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Negative temperature coefficient thermistor (NTC) class
class TNTC
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
    
    //! @brief NTC temperature scale enumeration
    typedef enum
    {
      
      //! @brief B25/100 B=3988 scala
      enum_B25_100_3988 = 1,
      
      //! @brief B25/100 B=3900 scala
      enum_B25_100_3900 = 2
      
    } TNTC_Scala;
    
    //! @brief NTC base resistance ebuneration
    typedef enum
    {
      
      //! @brief Base resistance 10kOhm
      enum_10000_Ohm = 1
    
    } TNTC_Value;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
        
    //!-------------------------------------------------------------------------
    //! @brief  The function calculates the electrical resistance of NTC at given temperature and defined resistance R0 at 0°C for a NTC element.
    //! @note   None
    //! @param  [out] *f32_Resistance Resistance at given temperature.
    //! @param  [in] f32_Temperature Temperature in degree celsius.
    //! @param  [in] enum_NTC_Scala Temperature scala
    //! @param  [in] enum_NTC_Value Value of the NTC element.
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Converstion error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TNTC__Temperature_To_Resistance.dt
    //--------------------------------------------------------------------------
 
    BOOL Temperature_To_Resistance( F32 *f32_Resistance, F32 f32_Temperature, TNTC_Scala enum_NTC_Scala, TNTC_Value enum_NTC_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief  The function calculates temperature by given electrical resistance of a NTC sensor.
    //! @note   None
    //! @param  [out] *f32_Temperature Temperature in degree celsius.
    //! @param  [in] f32_Resistance Resistance at given temperature.
    //! @param  [in] enum_NTC_Scala Temperature scala
    //! @param  [in] enum_NTC_Value Value of the NTC element.
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Conversuin error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TNTC__Resistance_To_Temperature.dt
    //--------------------------------------------------------------------------
 
    BOOL Resistance_To_Temperature( F32 *f32_Temperature, F32 f32_Resistance, TNTC_Scala enum_NTC_Scala, TNTC_Value enum_NTC_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief  The function calculates temperature by given charging time.
    //! @note   None
    //! @param  [out] *f32_Temperature Temperature in degree celsius.
    //! @param  [in] f32_Charging_Time Charging time of the slope capacitor in seconds.
    //! @param  [in] enum_NTC_Scala Temperature scala.
    //! @param  [in] enum_NTC_Value Value of the NTC element.
    //! @param  [in] f32_Relative_Reference_Voltage Comparator relative reference voltage in range 0.1 to 0.9.
    //! @param  [in] f32_Capacitance Capacitance of the integration capacitor in farad.
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Conversuin error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TNTC__Time_To_Temperature.dt
    //--------------------------------------------------------------------------
 
    BOOL Time_To_Temperature( F32 *f32_Temperature, F32 f32_Charging_Time, TNTC_Scala enum_NTC_Scala, TNTC_Value enum_NTC_Value, F32 f32_Relative_Reference_Voltage, F32 f32_Capacitance );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
    
  protected:
    
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    //!-------------------------------------------------------------------------
    //! @brief  The function returns base electrical resistance in ohms.
    //! @note   None
    //! @param  [out] *f32_Base_Resistance Base resistance at given temperature.
    //! @param  [in] enum_NTC_Value Value of the NTC termomenter.
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Conversuin error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TNTC__Get_Base_Resistance.dt
    //--------------------------------------------------------------------------
 
    BOOL Get_Base_Resistance( F32 *f32_Base_Resistance, TNTC_Value enum_NTC_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief  The function returns base electrical resistance in ohms.
    //! @note   None
    //! @param  [out] *f32_Betta Betta coefficient.
    //! @param  [out] *f32_Base_Temperature Base temperature in degree celsius.
    //! @param  [in] enum_NTC_Scala Temperature scala
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Conversuin error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TNTC__Get_Scala_Coefficients.dt
    //--------------------------------------------------------------------------
 
    BOOL Get_Scala_Coefficients( F32 *f32_Betta, F32 *f32_Base_Temperature, TNTC_Scala enum_NTC_Scala );
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------