Function_Block_Digital_Input.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Digital_Input.h
//! @author    ANVILEX LLC
//! @version   V1.0
//! @date      26.09.2017
//! @brief     Discrete delay class header file.
//! @attention
//!
//! COPYRIGHT(C) 2017 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_Input_1_T1
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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 input, type 2 class description
class TFunction_Block_Digital_Input_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_Input_T2();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Digital_Input_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 input inversion
    TBlock_Input_Connector object_bool_Inversion;
 
    //! @brief Input signal debounce filter time
    TBlock_Input_Connector object_u16_Debounce_Filter_Time;
    
    //! @brief Input signal on delay time
    TBlock_Input_Connector object_u16_On_Delay_Time;
    
    //! @brief Input signal off delay time    
    TBlock_Input_Connector object_u16_Off_Delay_Time;
 
    //! @brief Enable counter signal    
    TBlock_Input_Connector object_u8_Counter_Mode;
 
    //! @brief Enable counter signal    
    TBlock_Input_Connector object_bool_Enable_Counter;
    
    //! @brief Reset counter signal   
    TBlock_Input_Connector object_bool_Reset_Counter;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Digital input ststus signal
    TBlock_Output_Connector object_bool_Status;
 
    //! @brief Digital input counter signal
    TBlock_Output_Connector object_u32_Counter;
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
    
    //! @brief Internal FSM state definition
  enum class TDebounce_FSM_State : U8
    {
 
      //! @brief Initialisation state
      enum_Init = (U8)0,   
      
      //! @brief Off state
      enum_Off = (U8)1,    
      
      //! @brief Off to on transaction state
      enum_Off_On = (U8)2, 
      
      //! @brief On state
      enum_On = (U8)3,     
      
      //! @brief On to off transaction state
      enum_On_Off = (U8)4  
 
    };
 
    //! @brief Delay FSM state definition
    enum class TDelay_FSM_State : U8
    {
      
      //! @brief Off state
      enum_Off = (U8)0,
      
      //! @brief On delay state
      enum_On_Delay = (U8)1,
 
      //! @brief On state
      enum_On = (U8)2,
 
      //! @brief Off delay state
      enum_Off_Delay = (U8)3
                  
    }; 
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief Debounce FSM state variable
    TDebounce_FSM_State enum_Debounce_FSM_State = TDebounce_FSM_State::enum_Init;
    
    //! @brief Delay FSM state variable
    TDelay_FSM_State enum_Delay_State = TDelay_FSM_State::enum_Off;
 
    //! @brief Delay counter
    U16 u16_Delay_Counter = (U16)0x0000; 
    
    //! @brief Timeout counter
    U16 u16_Debounce_Timeout_Counter = (U16)0x0000; 
 
    //! @brief Edge counter
    U32 u32_Edge_Counter = (U32)0x00000000;
    
    //! @brief Previous input signal
    BOOL bool_Debounced_Input_Signal_Z1 = (BOOL)false;
    
    //! @brief Delayed input signal
    BOOL bool_Delayed_Input_Signal = (BOOL)false;
    
    //! @brief First loop signal
    BOOL bool_First_Loop = (BOOL)true;
    
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------