Function_Block_SRF_PLL.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_SRF_PLL.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      16.05.2015
//! @brief     SRF PLL class header file.
//! @attention
//!
//! COPYRIGHT(C) 2015 ANVILEX GmbH
//!
//! 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.
//------------------------------------------------------------------------------
//
// TFunction_Block_SRF_PLL
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Class declaration description
//------------------------------------------------------------------------------
 
class TFunction_Block_SRF_PLL : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_SRF_PLL();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_SRF_PLL();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about Function block over communication link protocol
    //! @note      This method sends information about Function block over specified communication link protocol.
    //! @param     [in] TProtocol_Base *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
    
    //--------------------------------------------------------------------------
    // Function block parameter connectors
    //--------------------------------------------------------------------------
  
    TBlock_Input_Connector object_f32_Base_Magnitude; //!< Base magnitude of the input signal
    TBlock_Input_Connector object_f32_Base_Frequency; //!< Base frequency of the input signal in herz
    TBlock_Input_Connector object_f32_Maximal_Frequency_Limit; //!< Minimal tracked frequency in herz
    TBlock_Input_Connector object_f32_Minimal_Frequency_Limit; //!< Maximal tracked frequency in herz
    TBlock_Input_Connector object_f32_Zetta; //!< Damping factor : 0.7
    TBlock_Input_Connector object_f32_Delta; //!< Tolerance band in part per hundret : 0.05 (5%) oder 0.02 (2%)
    TBlock_Input_Connector object_f32_Ts; //!< Settling time in seconds : 0.03s
    TBlock_Input_Connector object_f32_Theta_Offset; //!< Output angle phase offset in radian
    TBlock_Input_Connector object_f32_Sample_Time; //!< Sample time given in seconds
  
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
    
    TBlock_Input_Connector object_bool_Enable; //!< Enable PLL operation input signal
    TBlock_Input_Connector object_f32_A; //!< Input signal phase A
    TBlock_Input_Connector object_f32_B; //!< Input signal phase B
    TBlock_Input_Connector object_f32_C; //!< Input signal phase C
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
    
    TBlock_Output_Connector object_f32_Frequency; //!< Frequency of the input signal in herz
    TBlock_Output_Connector object_f32_Omega; //!< Angular frequency of the input signal in radian per seconds
    TBlock_Output_Connector object_f32_Theta; //!< Actual phase of the input signal in radian
 
    TBlock_Output_Connector object_bool_Locked; //!< PLL locked flag
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
    
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Base frequency in rad/s
    F32 f32_Omega_Base;
  
    //! @brief Minimal tracked frequency
    F32 f32_Omega_Maximum_Limit;
 
    //! @brief Maximal tracked frequency
    F32 f32_Omega_Minimum_Limit;
 
//    //! @brief Alpha component of input signal
//    F32 f32_Alpha;
 
//    //! @brief Beta component of input signal
//    F32 f32_Beta;
 
    //! @brief D component of input signal
    F32 f32_D;
 
    //! @brief Q component of input signal
    F32 f32_Q;
 
    //--------------------------------------------------------------------------
    // LPF related variables
    //--------------------------------------------------------------------------
 
    //! @brief LPF natural frequency in radian per second
    F32 f32_LPF_Wn;
    
    //! @brief LPF time constant
    F32 f32_LPF_Ti;
    
    //! @brief LPF proportional gain
    F32 f32_LPF_Kp;
    
    //! @brief LPF integral gain
    F32 f32_LPF_Ki;
 
//    //! @brief LPF temporary output
//    F32 f32_LPF_Temporary_Output;
 
    //! @brief Internal variable
    F32 f32_LPF_Output_Minimum_Limit;
 
    //! @brief Internal variable
    F32 f32_LPF_Output_Maximum_Limit;
  
    //! @brief LPF output
    F32 f32_LPF_Output;
 
    //--------------------------------------------------------------------------
    // PI regulator related variables
    //--------------------------------------------------------------------------
 
    //! @brief Proportianal gain of PI regulator
    F32 f32_KP;
 
    //! @brief Integral gain of PI regulator
    F32 f32_KI;
 
    //! @brief PI regulator intergral storage
    F32 f32_PI_Integral;
 
    //--------------------------------------------------------------------------
    // Angle integrator related variables
    //--------------------------------------------------------------------------
    
    //! @brief Phase angle
    F32 f32_Theta; 
 
    //! @brief Sinus value
    F32 f32_Sinus;
 
    //! @brief Cosuinus value
    F32 f32_Cosinus; 
 
    //--------------------------------------------------------------------------
    // Status related variables
    //--------------------------------------------------------------------------
    
    //! @brief PLL locked delay time
    U32 u32_Locked_Delay; 
    
    //! @brief Delay time counter
    U32 u32_Delay_Counter; 
 
    //--------------------------------------------------------------------------
    // DEBUG
    //--------------------------------------------------------------------------
/*    
    F32 f32_A_Sample;
    F32 f32_B_Sample;
    F32 f32_C_Sample;
*/  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------