Protocol_ANVILEX_Over_UART_V2.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Protocol_ANVILEX_Over_UART_V2.h
//! @brief      Communication protocol ANVILEX over UART 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/Protocol_ANVILEX_Over_UART_V2.h $
//!             $Revision: 2359 $
//!             $Date: 2021-02-08 19:48:43 +0500 (Пн, 08 фев 2021) $
//!             $Author: ggavrituhin $
//------------------------------------------------------------------------------
//
// 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 system files
//------------------------------------------------------------------------------
 
#include "Protocol_Base.h"
#include "ConOpSys_Variant.h"
 
//------------------------------------------------------------------------------
 
#define ANVILEX_PROTOCOL_RX_BUFFER_SIZE ( (U32)0x080 )
#define ANVILEX_PROTOCOL_TX_BUFFER_SIZE ( (U32)0x100 )
#define ANVILEX_SLAVE_FRAME_SIZE ( (U32)20 )
#define ANVILEX_SLAVE_FRAME_NUMBER ( (U32)5 )
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Communication protocol ANVILEX over UART class
class TProtocol_ANVILEX_Over_UART_V2 : public TProtocol_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    // Parameter property index definitions
    typedef enum
    {
 
      enum_ID = 1,
      enum_Properties = 2,
      enum_Element_Count = 3,
      enum_Minimum_Value = 4,
      enum_Maximum_Value = 5,
      enum_Default_Value = 6,
      enum_Name = 7,
      enum_Group = 8,
      enum_Description = 9,
      enum_Unit = 10
 
    }TParameter_Property_Index;
 
    // Event property index definitions
    typedef enum
    {
 
      enum_Event_Description = 1
 
    }TEvent_Property_Index;
 
    // ANVILEX protocol return values definition
    typedef enum
    {
 
      // Sucess related code
      enum_Ok                             = 0x00000000,
 
      //
      enum_Invalid_Frame_Format           = 0x00000001,
      enum_Invalid_Frame_CRC              = 0x00000002,
      enum_Not_Implemented                = 0x00000003,
      enum_Unknown_Error                  = 0x00000004,
 
      // Parameter related return codes
      enum_Parameter_Not_Found            = 0x00000005,
      enum_Parameter_Property_Not_Found   = 0x00000006,
      enum_Parameter_Non_Readable         = 0x00000007,
      enum_Parameter_Non_Writable         = 0x00000008,
      enum_Parameter_Access_Denied        = 0x00000009,
      enum_Parameter_Value_Out_Of_Bounds  = 0x0000000A,
      enum_Parameter_Write_Failure        = 0x0000000B,
 
      // Event related return codes
      enum_Event_Not_Found                = 0x0000000C,
      enum_Event_Property_Not_Found       = 0x0000000D
 
    }TProtocol_Return_Code;
 
    // Constructor and destructor methods
    TProtocol_ANVILEX_Over_UART_V2(); //!< Class constructor method
    ~TProtocol_ANVILEX_Over_UART_V2(); //!< Class destructor method
 
    // Initialisation and finalisation
    VOID Init(); //!< Initialisation method
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    // Protocol status methods
    virtual VOID Enter_Terminal_Mode(); //!< Enter in terminal operation mode
    virtual VOID Enter_Protocol_Mode(); //!< Enter in protocol operation mode
    virtual BOOL Is_Terminal_Mode(); //!< Return terminal operation mode status
    virtual BOOL Is_Protocol_Mode(); //!< Rwturn protocol operatuin mode status
 
    // Protocol messages control
    VOID Show_System_Welcome_Message_Enable(); //!< Enable show system welcome message
    VOID Show_System_Welcome_Message_Disable(); //!< Disable show system welcome message
    VOID Show_System_Ready_Message_Enable(); //!< Enable system ready message
    VOID Show_System_Ready_Message_Disable(); //!< Disable system ready message
 
    // Receive related methods
//    virtual VOID Receive_Char( C8 c8_Character );
    virtual VOID Communication_Data_Receive( U8 u8_Receive_Value );
    virtual VOID Communication_Data_Receive( VOID *void_Receive_Data );
 
    virtual VOID Receive_String( C8 *c8_String );
    virtual VOID Receive_String( C8 *c8_String, U32 u32_Length );
 
    // Transmit related methods
    VOID Transmit_Prompt(); //!< Transmit prompt in terminal mode
    VOID Transmit_Boot_Welcome_Message(); //!< Transmit boot welcome message method
    VOID Transmit_System_Ready_Message(); //!< Transmit system ready message method
 
    // Execute method
    virtual VOID Execute();
    
    U32 Get_Request_Data_Length();
 
    // Diverse methods
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Parameter related methods
    //--------------------------------------------------------------------------
 
    BOOL Terminal_Parameter_Information_Request(); //!< Parameter information terminal request
    BOOL Protocol_Parameter_Information_Request(); //!< Parameter information protocol request
 
    BOOL Terminal_Parameter_Read_Request(); //!< Parameter read terminal request
    BOOL Protocol_Parameter_Read_Request(); //!< Parameter read protocol request
 
    BOOL Terminal_Parameter_Write_Request(); //!< Parameter write terminal request
    BOOL Protocol_Parameter_Write_Request(); //!< Parameter write protocol request
 
    //--------------------------------------------------------------------------
    // Command related methods
    //--------------------------------------------------------------------------
 
    VOID Command_Execution_Request(); //!< Command execution request
 
    //--------------------------------------------------------------------------
    // Event related methods
    //--------------------------------------------------------------------------
 
    BOOL Terminal_Event_Information_Request(); //!< Event information request in terminal mode
    BOOL Protocol_Event_Information_Request(); //!< Event information request in protocol mode
    
    BOOL Parse_Frames_Into_Message();
    
    BOOL Get_Frame( C8 *c8_Return_Value, U8 u8_Frame_Number );
 
    //--------------------------------------------------------------------------
    // Common data transmision methods
    //--------------------------------------------------------------------------
 
    VOID Protocol_Transmit_Error_Code( TProtocol_Return_Code enum_Return_Code ); //!< Transmit error code
    VOID Protocol_Transmit_Variant_Value( TConOpSys_Variant *object_Value ); //!< Transmit variant value
    VOID Protocol_Transmit_Variant_Value( TConOpSys_Variant *object_Value, U8 u8_Package_ID ); //!< Transmit variant value with node address
    VOID Protocol_Transmit_U32_Value( U32 u32_Value ); //!< Transmit U32 value
    VOID Protocol_Transmit_String( C8 *c8_String ); //!< Transmit null terminated string
 
    //! @brief Communication module instance descriptor
    C8 char_Instance_Derscriptor = (C8)'>'; 
 
    //! @brief Terminal operation mode status
    BOOL bool_Terminal_Mode = (BOOL)true; 
    
    //! @brief Show system welcome message status
    BOOL bool_Show_System_Welcome_Message_Enabled = (BOOL)false; 
    
    //! @brief Show system ready message status
    BOOL bool_Show_System_Ready_Message_Enabled = (BOOL)false; 
 
    //! @brief Receive buffer index
    U32 u32_Receive_Buffer_Index = (U32)0; 
 
    //! @brief Data receive buffer
    C8 c8_Receive_Buffer[ ANVILEX_PROTOCOL_RX_BUFFER_SIZE ]; 
    
    //! @brief Data transmit buffer
    C8 c8_Transmit_Buffer[ ANVILEX_PROTOCOL_TX_BUFFER_SIZE ]; 
    
    //! @brief New data buffer
    C8 c8_New_Data_Buffer[ ANVILEX_PROTOCOL_RX_BUFFER_SIZE ]; 
 
    //! @brief ESC code flag
    BOOL bool_Esc = (BOOL)false; 
    
    //! @brief Actual SCAN code
    U8 u8_Scan_Code = (U8)'\0'; 
    
    //! @brief String recall request status
    BOOL bool_String_Recall_Request = (BOOL)false; 
    
    //! @brief String recalled status
    BOOL bool_String_Recalled = (BOOL)false; 
    
    //! @brief Package ID
    U8 u8_Package_ID = (U8)0;
    
    //! @brief Node address
    U32 u32_Node_Address = (U32)SYSTEM_NODE_ADDRESS;
    
    //! @brief Frame counter 
    U8 u8_Frame_Counter = (U8)0;
    
    //! @brief Frames list
    C8 c8_Frame_List[ ANVILEX_SLAVE_FRAME_NUMBER ][ ANVILEX_SLAVE_FRAME_SIZE ];
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------