P021_12_KG3_Electrical_Model_Emulator.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file        P021_12_KG3_Electrical_Model_Emulator.h
//! @author      ANVILEX GmbH
//! @version     V1.0
//! @date        19.05.2021
//! @brief       Electrical model emulator class header file.
//! @attention
//!
//! COPYRIGHT(C) 2021 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.
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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 Function block class declaration
//------------------------------------------------------------------------------
 
class TP021_12_KG3_Electrical_Model_Emulator : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public variables and methods
  //----------------------------------------------------------------------------
 
  public:
    
    //! @brief Register structure for generic access
    typedef struct
      {
        
      //! @brief 0x00 : Module identification register
      U16 u16_Unit_ID_L;
      
      //! @brief 0x01 : Module identification register
      U16 u16_Unit_ID_H;
        
      //! @brief 0x02 : Control register
      U16 u16_Control_Register;
    
      //! @brief 0x03 : Status register
      U16 u16_Status_Register;
        
      //! @brief 0x04 : Grid A phase voltage raw data register address
      I16 i16_Phase_A_Grid_Voltage_Raw_Data_Register;
        
      //! @brief 0x05 : Grid B phase voltage raw data register address
      I16 i16_Phase_B_Grid_Voltage_Raw_Data_Register;
 
      //! @brief 0x06 : Grid C phase voltage raw data register address
      I16 i16_Phase_C_Grid_Voltage_Raw_Data_Register;
      
      //! @brief 0x07 : Grid side inverter A phase voltage raw data register address
      I16 i16_Phase_A_Grid_Side_Inverter_Voltage_Raw_Data_Register;
      
      //! @brief 0x08 : Grid side inverter B phase voltage raw data register address
      I16 i16_Phase_B_Grid_Side_Inverter_Voltage_Raw_Data_Register;
      
      //! @brief 0x09 : Grid side inverter C phase voltage raw data register address
      I16 i16_Phase_C_Grid_Side_Inverter_Voltage_Raw_Data_Register;
      
      //! @brief 0x0A : Stator A phase voltage raw data register address
      I16 i16_Phase_A_Stator_Voltage_Raw_Data_Register;
      
      //! @brief 0x0B : Stator B phase voltage raw data register address
      I16 i16_Phase_B_Stator_Voltage_Raw_Data_Register;
      
      //! @brief 0x0C : Stator C phase voltage raw data register address
      I16 i16_Phase_C_Stator_Voltage_Raw_Data_Register;
      
      //! @brief 0x0D : Grid A phase current raw data register address
      I16 i16_Phase_A_Grid_Current_Raw_Data_Register;
      
      //! @brief 0x0E : Grid B phase current raw data register address
      I16 i16_Phase_B_Grid_Current_Raw_Data_Register;
      
      //! @brief 0x0F : Grid C phase current raw data register address
      I16 i16_Phase_C_Grid_Current_Raw_Data_Register;
      
      //! @brief 0x10 : Grid side inverter A phase current raw data register address
      I16 i16_Phase_A_Grid_Side_Inverter_Current_Raw_Data_Register;
      
      //! @brief 0x11 : Grid side inverter B phase current raw data register address
      I16 i16_Phase_B_Grid_Side_Inverter_Current_Raw_Data_Register;
      
      //! @brief 0x12 : Grid side inverter C phase current raw data register address
      I16 i16_Phase_C_Grid_Side_Inverter_Current_Raw_Data_Register;
      
      //! @brief 0x13 : Rotor side inverter A phase current raw data register address
      I16 i16_Phase_A_Rotor_Side_Inverter_Current_Raw_Data_Register;
      
      //! @brief 0x14 : Rotor side inverter B phase current raw data register address
      I16 i16_Phase_B_Rotor_Side_Inverter_Current_Raw_Data_Register;
      
      //! @brief 0x15 : Rotor side inverter C phase current raw data register address
      I16 i16_Phase_C_Rotor_Side_Inverter_Current_Raw_Data_Register;
      
      //! @brief 0x16 : Smoothing capacitor voltage raw data register address
      I16 i16_Smoothing_Capacitor_Voltage_Raw_Data_Register;
      
      //! @brief 0x17
      U16 u16_Encoder_Raw_Data_Register;
      
    }TP021_12_KG3_Electrical_Model_Emulator_registers;
  
    //--------------------------------------------------------------------------
    // Constructor and destructor methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP021_12_KG3_Electrical_Model_Emulator();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP021_12_KG3_Electrical_Model_Emulator();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Base adress to register structure mapping
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP021_12_KG3_Electrical_Model_Emulator_registers *struct_Registers_Base_Address ); 
    
    //--------------------------------------------------------------------------
    // Function block data processing methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
    
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // PWM grid side transistors statuses
    //--------------------------------------------------------------------------
    
    //! @brief First transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_GSI_1_Status;
    
    //! @brief Second transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_GSI_2_Status;
    
    //! @brief Third transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_GSI_3_Status;
    
    //! @brief Fourth transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_GSI_4_Status;
    
    //! @brief Fifth transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_GSI_5_Status;
    
    //! @brief Sixth transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_GSI_6_Status;
    
    //--------------------------------------------------------------------------
    // PWM rotor side transistors statuses
    //--------------------------------------------------------------------------
    
    //! @brief First transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_RSI_1_Status;
    
    //! @brief Second transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_RSI_2_Status;
    
    //! @brief Third transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_RSI_3_Status;
    
    //! @brief Fourth transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_RSI_4_Status;
    
    //! @brief Fifth transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_RSI_5_Status;
    
    //! @brief Sixth transistor PWM status
    //TBlock_Output_Connector object_bool_PWM_RSI_6_Status;
    
    //--------------------------------------------------------------------------
    // Grid circuit breaker status
    //--------------------------------------------------------------------------
    
    //! @brief Grid circuit breaker status
    //TBlock_Output_Connector object_bool_Grid_CB_Status;
    
    //--------------------------------------------------------------------------
    // Grid side inventer circuit breaker status
    //--------------------------------------------------------------------------
    
    //! @brief Grid side inventer circuit breaker status
    //TBlock_Output_Connector object_bool_GSI_CB_Status;
 
  //----------------------------------------------------------------------------
  // Protected variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private variables and methods
  //----------------------------------------------------------------------------
 
  private:
    
  //! @brief Structure control register for bit parsing
    typedef union
    {
 
      //! @brief Raw data
      U16 u16_Raw_Data;
 
      //! @brief Structure of the bits
      struct
      {
 
        //! @brief Bit 0, First GSI transistor PWM control
        U16 bool_PWM_GSI_1_Control:1;
 
        //! @brief Bit 1, Second GSI transistor PWM control
        U16 bool_PWM_GSI_2_Control:1;
        
        //! @brief Bit 2, Third GSI transistor PWM control
        U16 bool_PWM_GSI_3_Control:1;
        
        //! @brief Bit 3, Fourth GSI transistor PWM control
        U16 bool_PWM_GSI_4_Control:1;
        
        //! @brief Bit 4, Fifth GSI transistor PWM control
        U16 bool_PWM_GSI_5_Control:1;
        
        //! @brief Bit 5, Sixth GSI transistor PWM control
        U16 bool_PWM_GSI_6_Control:1;
        
        //! @brief Bit 6, First RSI transistor PWM control
        U16 bool_PWM_RSI_1_Control:1;
        
        //! @brief Bit 7, Second RSI transistor PWM control
        U16 bool_PWM_RSI_2_Control:1;
        
        //! @brief Bit 8, Third RSI transistor PWM control
        U16 bool_PWM_RSI_3_Control:1;
        
        //! @brief Bit 9, Fourth RSI transistor PWM control
        U16 bool_PWM_RSI_4_Control:1;
        
        //! @brief Bit 10, Fifth RSI transistor PWM control
        U16 bool_PWM_RSI_5_Control:1;
        
        //! @brief Bit 11, Sixth RSI transistor PWM control
        U16 bool_PWM_RSI_6_Control:1;
        
        //! @brief Bit 12, Grid circuit breaker control
        U16 bool_Grid_CB_Control:1;
        
        //! @brief Bit 13, Grid side inverter circuit breaker control
        U16 bool_GSI_CB_Control:1;
        
        // @brief Bit 14, First ballast resistor control
        U16 bool_First_Ballast_Control:1;
        
        // @brief Bit 15, Second ballast resistor control
        U16 bool_Second_Ballast_Control:1;
 
      };
 
    }TControl_Register;
    
    
    //! @brief Structure status register for bit parsing
    typedef union
    {
 
      //! @brief Raw data
      U16 u16_Raw_Data;
 
      //! @brief Structure of the bits
      struct
      {
 
        //! @brief Bit 0, First GSI transistor PWM status
        U16 bool_PWM_GSI_1_Status:1;
 
        //! @brief Bit 1, Second GSI transistor PWM status
        U16 bool_PWM_GSI_2_Status:1;
        
        //! @brief Bit 2, Third GSI transistor PWM status
        U16 bool_PWM_GSI_3_Status:1;
        
        //! @brief Bit 3, Fourth GSI transistor PWM status
        U16 bool_PWM_GSI_4_Status:1;
        
        //! @brief Bit 4, Fifth GSI transistor PWM status
        U16 bool_PWM_GSI_5_Status:1;
        
        //! @brief Bit 5, Sixth GSI transistor PWM status
        U16 bool_PWM_GSI_6_Status:1;
        
        //! @brief Bit 6, First RSI transistor PWM status
        U16 bool_PWM_RSI_1_Status:1;
        
        //! @brief Bit 7, Second RSI transistor PWM status
        U16 bool_PWM_RSI_2_Status:1;
        
        //! @brief Bit 8, Third RSI transistor PWM status
        U16 bool_PWM_RSI_3_Status:1;
        
        //! @brief Bit 9, Fourth RSI transistor PWM status
        U16 bool_PWM_RSI_4_Status:1;
        
        //! @brief Bit 10, Fifth RSI transistor PWM status
        U16 bool_PWM_RSI_5_Status:1;
        
        //! @brief Bit 11, Sixth RSI transistor PWM status
        U16 bool_PWM_RSI_6_Status:1;
        
        //! @brief Bit 12, Grid circuit breaker status
        U16 bool_Grid_CB_Status:1;
        
        //! @brief Bit 13, Grid side inverter circuit breaker status
        U16 bool_GSI_CB_Status:1;
        
        // @brief Bit 14, First ballast resistor status
        U16 bool_First_Ballast_Status:1;
        
        // @brief Bit 14, Second ballast resistor status
        U16 bool_Second_Ballast_Status:1;
 
      };
 
    }TStatus_Register;
    
    //! @brief Pointer to the memory area in FPGA address space
    volatile TP021_12_KG3_Electrical_Model_Emulator_registers *struct_Registers;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------