P017_42_KG3_AI.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P017_42_KG3_AI.h
//! @brief      KG3 analog input board P017.42 hardware driver header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P017_42_KG3_AI/P017_42_KG3_AI.h $
//!             $Revision: 2457 $
//!             $Date: 2021-03-11 11:54:01 +0500 (Do, 11 Mrz 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 "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Analog input board P017.42 class
//------------------------------------------------------------------------------
 
class TP017_42_KG3_AI_T0 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public methods and variables
  //----------------------------------------------------------------------------
  
  public:
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP017_42_KG3_AI_T0(); //!< Class constructor method
    virtual ~TP017_42_KG3_AI_T0(); //!< Class destructor method
 
    virtual VOID Init();
    virtual VOID Execute();
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_1; //!< Analog input channel 1 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_2; //!< Analog input channel 2 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_3; //!< Analog input channel 3 fill scale value. Also used for channel total gain adjustment.
 
    TBlock_Input_Connector object_f32_Analog_Input_Offset_1; //!< Analog input channel 1 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_2; //!< Analog input channel 2 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_3; //!< Analog input channel 3 offset
 
    TBlock_Input_Connector object_bool_Negate; //!< Negate input analog signal value
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
        
    TBlock_Input_Connector object_f32_Software_Overcurrent_Level; //!< Software defined overcurrent level
    
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
    
    U16 u16_Analog_Input_Status; //!< Analog input status
    I16 i16_Analog_Input_Data_1; //!< Analog input channel 1 block output as I16
    I16 i16_Analog_Input_Data_2; //!< Analog input channel 2 block output as I16
    I16 i16_Analog_Input_Data_3; //!< Analog input channel 3 block output as I16
    
    TBlock_Output_Connector object_f32_Analog_Input_Data_1; //!< Analog input channel 1 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_2; //!< Analog input channel 2 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_3; //!< Analog input channel 3 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_DC; //!< Analog input channels DC offset
    
    TBlock_Output_Connector object_bool_Hardware_Error; //!< Critical hardware error flag
    TBlock_Output_Connector object_bool_Symmenty_Error; //!< Signal symmery error flag
    TBlock_Output_Connector object_bool_Magnitude_Hardware_Level_Error; //!< Hardware overcurrent limit
    TBlock_Output_Connector object_bool_Software_Overcurrent; // !< Software overcurrent limit
    
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
  
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    typedef union
    {
      U16 u16_Status;
      struct
      {
        U16 u16_ADC_Hardware_Fault_1:1; // Bit 0
        U16 u16_ADC_Hardware_Fault_2:1; // Bit 1
        U16 u16_ADC_Hardware_Fault_3:1; // Bit 2
        U16 :1; // Bit 3
        U16 :1; // Bit 4
        U16 :1; // Bit 5
        U16 :1; // Bit 6
        U16 u16_CMP_P_1_Status:1; // Bit 7
        U16 u16_CMP_N_1_Status:1; // Bit 8
        U16 u16_CMP_P_2_Status:1; // Bit 9
        U16 u16_CMP_N_2_Status:1; // Bit 10
        U16 u16_CMP_P_3_Status:1; // Bit 11
        U16 u16_CMP_N_3_Status:1; // Bit 12
        U16 :1; // Bit 13
        U16 :1; // Bit 14
        U16 :1; // Bit 15
      };
    } TStatus;
 
    F32 f32_Gain_1; //!< Effective gain of the channel 1
    F32 f32_Gain_2; //!< Effective gain of the channel 2
    F32 f32_Gain_3; //!< Effective gain of the channel 3
 
    F32 f32_Offset_1; //!< Effective offset of the channel 1
    F32 f32_Offset_2; //!< Effective offset of the channel 2
    F32 f32_Offset_3; //!< Effective offset of the channel 3
 
};
 
//------------------------------------------------------------------------------
 
class TP017_42_KG3_AI_T1 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    // Register structure for generic access
    typedef struct
    {
 
      U16 u16_Unit_ID_L;                    //!< 0x00 : Unit identification L read register
      U16 u16_Unit_ID_H;                    //!< 0x01 : Unit identification H read register
      union
      {
        U16 u16_Status;                     //!< 0x02 : Status register
        U16 u16_Control;                    //!< 0x02 : Control register
      };
      I16 i16_Analog_Input_Data_1;          //!< 0x03 : Analog input channel 1 data register as I16 value
      I16 i16_Analog_Input_Data_2;          //!< 0x04 : Analog input channel 2 data register as I16 value
      I16 i16_Analog_Input_Data_3;          //!< 0x05 : Analog input channel 3 data register as I16 value
      I16 i16_Analog_Input_Filtered_Data_1; //!< 0x06 : Analog input channel 1 filtered data register as I16 value
      I16 i16_Analog_Input_Filtered_Data_2; //!< 0x07 : Analog input channel 2 filtered data register as I16 value
      I16 i16_Analog_Input_Filtered_Data_3; //!< 0x08 : Analog input channel 3 filtered data register as I16 value
 
    } TP017_42_KG3_AI_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP017_42_KG3_AI_T1(); //!< Class constructor method
    virtual ~TP017_42_KG3_AI_T1(); //!< Class destructor method
 
    VOID Map( TP017_42_KG3_AI_Registers *struct_Registers_Base_Address );
    virtual VOID Init();
    virtual VOID Execute();
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_1; //!< Analog input channel 1 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_2; //!< Analog input channel 2 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_3; //!< Analog input channel 3 fill scale value. Also used for channel total gain adjustment.
 
    TBlock_Input_Connector object_f32_Analog_Input_Offset_1; //!< Analog input channel 1 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_2; //!< Analog input channel 2 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_3; //!< Analog input channel 3 offset
 
    TBlock_Input_Connector object_bool_Negate; //!< Negate input analog signal value
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
        
    TBlock_Input_Connector object_f32_Software_Overcurrent_Level; //!< Software defined overcurrent level
    
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
    
    U16 u16_Analog_Input_Status; //!< Analog input status
    I16 i16_Analog_Input_Data_1; //!< Analog input channel 1 block output as I16
    I16 i16_Analog_Input_Data_2; //!< Analog input channel 2 block output as I16
    I16 i16_Analog_Input_Data_3; //!< Analog input channel 3 block output as I16
    
    TBlock_Output_Connector object_f32_Analog_Input_Data_1; //!< Analog input channel 1 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_2; //!< Analog input channel 2 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_3; //!< Analog input channel 3 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_DC; //!< Analog input channels DC offset
    
    TBlock_Output_Connector object_bool_Hardware_Error; //!< Critical hardware error flag
    TBlock_Output_Connector object_bool_Symmenty_Error; //!< Signal symmery error flag
    TBlock_Output_Connector object_bool_Magnitude_Hardware_Level_Error; //!< Hardware overcurrent limit
    TBlock_Output_Connector object_bool_Software_Overcurrent; // !< Software overcurrent limit
    
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
  
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    typedef union
    {
      U16 u16_Status;
      struct
      {
        U16 u16_ADC_Hardware_Fault_1:1; // Bit 0
        U16 u16_ADC_Hardware_Fault_2:1; // Bit 1
        U16 u16_ADC_Hardware_Fault_3:1; // Bit 2
        U16 :1; // Bit 3
        U16 :1; // Bit 4
        U16 :1; // Bit 5
        U16 :1; // Bit 6
        U16 u16_CMP_P_1_Status:1; // Bit 7
        U16 u16_CMP_N_1_Status:1; // Bit 8
        U16 u16_CMP_P_2_Status:1; // Bit 9
        U16 u16_CMP_N_2_Status:1; // Bit 10
        U16 u16_CMP_P_3_Status:1; // Bit 11
        U16 u16_CMP_N_3_Status:1; // Bit 12
        U16 :1; // Bit 13
        U16 :1; // Bit 14
        U16 :1; // Bit 15
      };
    } TStatus;
 
    volatile TP017_42_KG3_AI_Registers *struct_Registers; //!< Hardware mapped registers
 
    F32 f32_Gain_1; //!< Effective gain of the channel 1
    F32 f32_Gain_2; //!< Effective gain of the channel 2
    F32 f32_Gain_3; //!< Effective gain of the channel 3
 
    F32 f32_Offset_1; //!< Effective offset of the channel 1
    F32 f32_Offset_2; //!< Effective offset of the channel 2
    F32 f32_Offset_3; //!< Effective offset of the channel 3
 
};
 
//------------------------------------------------------------------------------
 
class TP017_42_KG3_AI_T2 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    // Register structure for generic access
    typedef struct
    {
 
      U16 u16_Unit_ID_L;                    //!< 0x00 : Unit identification L read register
      U16 u16_Unit_ID_H;                    //!< 0x01 : Unit identification H read register
      union
      {
        U16 u16_Status;                     //!< 0x02 : Status register
        U16 u16_Control;                    //!< 0x02 : Control register
      };
      I16 i16_Analog_Input_Data_1;          //!< 0x03 : Analog input channel 1 data register as I16 value
      I16 i16_Analog_Input_Data_2;          //!< 0x04 : Analog input channel 2 data register as I16 value
      I16 i16_Analog_Input_Data_3;          //!< 0x05 : Analog input channel 3 data register as I16 value
      I16 i16_Analog_Input_Filtered_Data_1; //!< 0x06 : Analog input channel 1 filtered data register as I16 value
      I16 i16_Analog_Input_Filtered_Data_2; //!< 0x07 : Analog input channel 2 filtered data register as I16 value
      I16 i16_Analog_Input_Filtered_Data_3; //!< 0x08 : Analog input channel 3 filtered data register as I16 value
 
    } TP017_42_KG3_AI_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP017_42_KG3_AI_T2(); //!< Class constructor method
    virtual ~TP017_42_KG3_AI_T2(); //!< Class destructor method
 
    VOID Map( TP017_42_KG3_AI_Registers *struct_Registers_Base_Address );
    virtual VOID Init();
    virtual VOID Execute();
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_1; //!< Analog input channel 1 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_2; //!< Analog input channel 2 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_3; //!< Analog input channel 3 fill scale value. Also used for channel total gain adjustment.
 
    TBlock_Input_Connector object_f32_Analog_Input_Offset_1; //!< Analog input channel 1 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_2; //!< Analog input channel 2 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_3; //!< Analog input channel 3 offset
 
    TBlock_Input_Connector object_bool_Negate; //!< Negate input analog signal value
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
        
    TBlock_Input_Connector object_f32_Software_Overcurrent_Level; //!< Software defined overcurrent level
    
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
    
    U16 u16_Analog_Input_Status; //!< Analog input status
    I16 i16_Analog_Input_Data_1; //!< Analog input channel 1 block output as I16
    I16 i16_Analog_Input_Data_2; //!< Analog input channel 2 block output as I16
    I16 i16_Analog_Input_Data_3; //!< Analog input channel 3 block output as I16
    
    TBlock_Output_Connector object_f32_Analog_Input_Data_1; //!< Analog input channel 1 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_2; //!< Analog input channel 2 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_3; //!< Analog input channel 3 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_DC; //!< Analog input channels DC offset
    
    TBlock_Output_Connector object_bool_Hardware_Error; //!< Critical hardware error flag
    TBlock_Output_Connector object_bool_Symmenty_Error; //!< Signal symmery error flag
    TBlock_Output_Connector object_bool_Magnitude_Hardware_Level_Error; //!< Hardware overcurrent limit
    TBlock_Output_Connector object_bool_Software_Overcurrent; // !< Software overcurrent limit
    
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
  
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    typedef union
    {
      U16 u16_Status;
      struct
      {
        U16 u16_ADC_Hardware_Fault_1:1; // Bit 0
        U16 u16_ADC_Hardware_Fault_2:1; // Bit 1
        U16 u16_ADC_Hardware_Fault_3:1; // Bit 2
        U16 :1; // Bit 3
        U16 :1; // Bit 4
        U16 :1; // Bit 5
        U16 :1; // Bit 6
        U16 u16_CMP_P_1_Status:1; // Bit 7
        U16 u16_CMP_N_1_Status:1; // Bit 8
        U16 u16_CMP_P_2_Status:1; // Bit 9
        U16 u16_CMP_N_2_Status:1; // Bit 10
        U16 u16_CMP_P_3_Status:1; // Bit 11
        U16 u16_CMP_N_3_Status:1; // Bit 12
        U16 :1; // Bit 13
        U16 :1; // Bit 14
        U16 :1; // Bit 15
      };
    } TStatus;
 
    volatile TP017_42_KG3_AI_Registers *struct_Registers; //!< Hardware mapped registers
 
    F32 f32_Gain_1; //!< Effective gain of the channel 1
    F32 f32_Gain_2; //!< Effective gain of the channel 2
    F32 f32_Gain_3; //!< Effective gain of the channel 3
 
    F32 f32_Offset_1; //!< Effective offset of the channel 1
    F32 f32_Offset_2; //!< Effective offset of the channel 2
    F32 f32_Offset_3; //!< Effective offset of the channel 3
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------