System_LED_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       System_LED_Base.h
//! @brief      System LED base class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/System_LED_Base.h $
//!             $Revision: 2336 $
//!             $Date: 2021-01-07 17:24:37 +0500 (Do, 07 Jan 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
//Class definitions
//------------------------------------------------------------------------------
 
//! @brief Base LED manager class
class TSystem_LED_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
    
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
  
    //! @brief LED operating modes
    typedef enum
    {
      
      //! @brief LED off
      enum_Off,
      
      //! @brief LED on
      enum_On,
      
      //! @brief Blinking LED (1 Hz)
      enum_Flash_1_Hz,
      
      //! @brief Blinking LED (1 Hz)
      enum_Flash_4_Hz,
      
      //! @brief Blinking LED (8 Hz)
      enum_Flash_8_Hz
      
    } TLED_Mode;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     System LED base initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     System LED base finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     1 ms cyclic execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Execute_1ms();
    
    //!-------------------------------------------------------------------------
    //! @brief     Set mode for alarm LED
    //! @note      None
    //! @param     [in] enum_New_Mode - Required mode for LED
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Alarm_LED_Mode( TLED_Mode enum_New_Mode );
    
    //!-------------------------------------------------------------------------
    //! @brief     Set mode for run LED
    //! @note      None
    //! @param     [in] enum_New_Mode - Required mode for LED
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Set_Run_LED_Mode( TLED_Mode enum_New_Mode );
    
    //!-------------------------------------------------------------------------
    //! @brief     Set mode for ready LED
    //! @note      None
    //! @param     [in] enum_New_Mode - Required mode for LED
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Set_Ready_LED_Mode( TLED_Mode enum_New_Mode );
    
    //!-------------------------------------------------------------------------
    //! @brief     Set mode for error LED
    //! @note      None
    //! @param     [in] enum_New_Mode - Required mode for LED
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Set_Error_LED_Mode( TLED_Mode enum_New_Mode );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
    
    // Status ready for processing
    BOOL bool_Start_Procesing = (BOOL)false;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
  
    //--------------------------------------------------------------------------
    // Protected methods
    //--------------------------------------------------------------------------
  
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the alarm LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
  
    virtual VOID Alarm_On() = 0;
  
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the alarm LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
  
    virtual VOID Alarm_Off() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the alarm LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Alarm_Toggle() = 0;
    
    //--------------------------------------------------------------------------
    // Run LED control methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the run LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Run_On() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the run LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Run_Off() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the run LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Run_Toggle() = 0;
 
    //--------------------------------------------------------------------------
    // Ready LED control methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the ready LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Ready_On() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the ready LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Ready_Off() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the ready LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Ready_Toggle() = 0;
    
    //--------------------------------------------------------------------------
    // Error LED control methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the error LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Error_On() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the error LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Error_Off() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the error LED
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Error_Toggle() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method return alarm LED state
    //! @note      None
    //! @return    BOOL - Alarm LED state
    //! @retval    false - Alarm LED is off
    //! @retval    true - Alarm LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Get_Alarm_LED_State() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method return run LED state
    //! @note      None
    //! @return    BOOL - Run LED state
    //! @retval    false - Run LED is off
    //! @retval    true - Run LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Get_Run_LED_State() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method return ready LED state
    //! @note      None
    //! @return    BOOL - Ready LED state
    //! @retval    false - Ready LED is off
    //! @retval    true - Ready LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Get_Ready_LED_State() = 0;
    
    //!-------------------------------------------------------------------------
    //! @brief     Method return error LED state
    //! @note      None
    //! @return    BOOL - Error LED state
    //! @retval    false - Error LED is off
    //! @retval    true - Error LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Get_Error_LED_State() = 0;
    
    //--------------------------------------------------------------------------
    // Protected variables
    //--------------------------------------------------------------------------
  
    //! @brief Contains alarm LED operation mode
    TLED_Mode enum_Alarm_LED_Mode = enum_Off;
    
    //! @brief Contains run LED operation mode
    TLED_Mode enum_Run_LED_Mode = enum_Off;
    
    //! @brief Contains ready LED operation mode
    TLED_Mode enum_Ready_LED_Mode = enum_Off;
    
    //! @brief Contains error LED operation mode
    TLED_Mode enum_Error_LED_Mode = enum_Off;
  
    //! @brief Contains delay counter for alarm LED
    U32 u32_Alarm_LED_Delay_Counter = (U32)0;
    
    //! @brief Contains delay counter for run LED
    U32 u32_Run_LED_Delay_Counter = (U32)0;
    
    //! @brief Contains delay counter for ready LED
    U32 u32_Ready_LED_Delay_Counter = (U32)0;
    
    //! @brief Contains delay counter for error LED
    U32 u32_Error_LED_Delay_Counter = (U32)0;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    //--------------------------------------------------------------------------
    // Private methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Decode LED states methood
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Decode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Process LED operation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Process();
  
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief Decode LED counter
    U32 u32_Decode_Counter = (U32)0;
  
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------