Function_Block_Digital_Output.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Digital_Output.h
//! @author    ANVILEX LLC
//! @version   V1.0
//! @date      26.09.2017
//! @brief     Digital output class header file.
//! @attention
//!
//! COPYRIGHT(C) 2017-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.
//------------------------------------------------------------------------------
//
// TFunction_Block_Digital_Output_1_T2
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declarations
//------------------------------------------------------------------------------
 
//! @brief Digital output, type 2 class description
class TFunction_Block_Digital_Output_T2 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Digital_Output_T2();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Digital_Output_T2();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //! @brief Digital input channel connector
    TBlock_Input_Connector object_u8_Channel;
 
    //! @brief Digital output inversion
    TBlock_Input_Connector object_bool_Data;
 
    //! @brief Digital output inversion
    TBlock_Input_Connector object_bool_Inversion;
    
    //! @brief Output signal on delay time
    TBlock_Input_Connector object_u16_On_Delay_Time;
    
    //! @brief Output signal off delay time   
    TBlock_Input_Connector object_u16_Off_Delay_Time;
 
    //! @brief Output signal pulse count
    TBlock_Input_Connector object_u32_Pulse_Count;
 
    //! @brief Output PWM signal period count
    TBlock_Input_Connector object_u32_Period;
 
    //! @brief Output PWM signal on time
    TBlock_Input_Connector object_u32_On_Time;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
        
    //! @brief Delay FSM state definition
    enum class TDelay_FSM_State
    {
      
      //! @brief Off state
      enum_Off = 0,
      
      //! @brief On state
      enum_On = 1,
      
      //! @brief Off delay state
      enum_Off_Delay = 2,
      
      //! @brief On delay state
      enum_On_Delay = 3
      
    }; 
 
    //! @brief Internal FSM state definition
    enum class TPWM_FSM_State
    {
 
      //! @brief Initialisation state
      enum_Init,   
      
      //! @brief Idle state
      enum_Idle,
 
      //! @brief On state
      enum_On,
 
      //! @brief PWM on state
      enum_PWM_On,
      
      //! @brief PWM off state
      enum_PWM_Off,    
 
      //! @brief Stop state
      enum_Stop
 
    };
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
        
    //! @brief Delay FSM state variable
    TDelay_FSM_State enum_Delay_State = TDelay_FSM_State::enum_Off;
 
    //! @brief PWM FSM state variable
    TPWM_FSM_State enum_PWM_FSM_State = TPWM_FSM_State::enum_Idle;
 
    //! @brief Delayed input signal
    BOOL bool_Delayed_Input_Signal = (BOOL)false;
    
    //! @brief PWM output signal
    BOOL bool_PWM_Output_Signal = (BOOL)false;
 
    //! @brief Delay counter
    U16 u16_Delay_Counter = (U16)0x0000;
    
    //! @brief PWM counter
    U32 u32_PWM_Counter = (U32)0x00000000;
    
    //! @brief PWM pulse counter
    U32 u32_Pulse_Counter = (U32)0x00000000;
    
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------