ConOpSys V2970  P004.07
ANVILEX control operating system
Public Member Functions | List of all members
TProtocol_PLUG_Over_UART Class Reference

Dummy communication protocol over UART class implementation. More...

#include <Protocol_PLUG_Over_UART.h>

Inheritance diagram for TProtocol_PLUG_Over_UART:
Inheritance graph
Collaboration diagram for TProtocol_PLUG_Over_UART:
Collaboration graph

Public Member Functions

 TProtocol_PLUG_Over_UART ()
 Class constructor method. More...
 
 ~TProtocol_PLUG_Over_UART ()
 Class destructor method. More...
 
VOID Init ()
 Object initialisation method. More...
 
virtual VOID Execute_1ms ()
 PLUG protocol 1ms cyclic processing method. More...
 
virtual VOID Execute ()
 Protocol execution method. More...
 
virtual VOID Send_Information (TProtocol_Base *object_Protocol)
 Method sends actual driver information over specified communication link protocol. More...
 
virtual VOID Enter_Terminal_Mode ()
 Enter in terminal operation mode method. More...
 
virtual VOID Enter_Protocol_Mode ()
 Enter in protocol operation mode method. More...
 
VOID Show_System_Welcome_Message_Enable ()
 Enable show system welcome message method. More...
 
VOID Show_System_Welcome_Message_Disable ()
 Disable show system welcome message method. More...
 
VOID Show_System_Ready_Message_Enable ()
 Enable system ready message method. More...
 
VOID Show_System_Ready_Message_Disable ()
 Disable system ready message method. More...
 
virtual BOOL Is_Terminal_Mode ()
 Return terminal operation mode status method. More...
 
virtual BOOL Is_Protocol_Mode ()
 Return protocol operatuin mode status method. More...
 
virtual VOID Communication_Data_Receive (U8 u8_Receive_Value)
 Communication data receive method. More...
 
virtual VOID Communication_Data_Receive (VOID *void_Receive_Data)
 Communication data receive method. More...
 
virtual VOID Receive_String (C8 *c8_String)
 Receiveed string processing method. More...
 
virtual VOID Receive_String (C8 *c8_String, U32 u32_Length)
 Receiveed string processing method. More...
 
VOID Transmit_Boot_Welcome_Message ()
 Transmit boot welcome message method. More...
 
VOID Transmit_System_Ready_Message ()
 Transmit boot ready message method. More...
 
- Public Member Functions inherited from TProtocol_Base
 TProtocol_Base ()
 Class constructor method. More...
 
 ~TProtocol_Base ()
 Class destructor method. More...
 
VOID Init ()
 Initialisation method. More...
 
VOID Done ()
 Finalisation method. More...
 
VOID Clear_Communication_Statistic ()
 Clear communication statistic. More...
 
VOID Enable_Parameter_Mapping ()
 Enable parameter mapping method. More...
 
VOID Disable_Parameter_Mapping ()
 Disable parameter mapping method. More...
 
VOID Transmit_Char (C8 c8_Character)
 Receive character. More...
 
VOID Transmit_String_Of_Char (C8 c8_Character, U32 u32_Count)
 
VOID Transmit_String_Of_Char (C8 c8_Character, U32 u32_Count, U32 u32_End_New_Line_Count)
 
VOID Transmit_String (C8 *c8_String)
 
VOID Transmit_String (U32 u32_Begin_New_Lines_Count, C8 *c8_String)
 
VOID Transmit_String (C8 *c8_String, U32 u32_End_New_Line_Count)
 
VOID Transmit_String (U32 u32_Begin_New_Lines_Count, C8 *c8_String, U32 u32_End_New_Line_Count)
 
VOID Transmit_New_Line ()
 Transmit new line. More...
 
VOID Transmit_New_Line (U32 u32_Count)
 Transmit new lines. More...
 
VOID Transmit_Connector_Value_As_Boolean (TBlock_Input_Connector *object_Connector)
 
VOID Transmit_Connector_Value_As_Boolean (TBlock_Input_Connector *object_Connector, U32 u32_End_New_Line_Count)
 
VOID Transmit_Connector_Value_As_Decimal (TBlock_Input_Connector *object_Connector)
 
VOID Transmit_Connector_Value_As_Decimal (TBlock_Input_Connector *object_Connector, U32 u32_End_New_Line_Count)
 
VOID Transmit_Connector_Value_As_Hex (TBlock_Input_Connector *object_Connector)
 
VOID Transmit_Connector_Value_As_Hex (TBlock_Input_Connector *object_Connector, U32 u32_End_New_Line_Count)
 
VOID Transmit_Connector_Value_As_Boolean (TBlock_Output_Connector *object_Connector)
 
VOID Transmit_Connector_Value_As_Boolean (TBlock_Output_Connector *object_Connector, U32 u32_End_New_Line_Count)
 
VOID Transmit_Connector_Value_As_Decimal (TBlock_Output_Connector *object_Connector)
 
VOID Transmit_Connector_Value_As_Decimal (TBlock_Output_Connector *object_Connector, U32 u32_End_New_Line_Count)
 
VOID Transmit_Connector_Value_As_Hex (TBlock_Output_Connector *object_Connector)
 
VOID Transmit_Connector_Value_As_Hex (TBlock_Output_Connector *object_Connector, U32 u32_End_New_Line_Count)
 
VOID Transmit_Variant_As_Hex (TConOpSys_Variant *object_Value)
 
VOID Transmit_Variant_As_Hex (TConOpSys_Variant *object_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_BOOL_Value_As_Decimal (BOOL bool_Value)
 
VOID Transmit_BOOL_Value_As_Decimal (BOOL bool_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_BOOL_Value_As_Hex (BOOL bool_Value)
 
VOID Transmit_BOOL_Value_As_Hex (BOOL bool_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_TRIL_Value_As_Decimal (TRIL tril_Value)
 
VOID Transmit_TRIL_Value_As_Decimal (TRIL tril_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U8_Value_As_Decimal (U8 u8_Value)
 
VOID Transmit_U8_Value_As_Decimal (U8 u8_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U8_Value_As_Hex (U8 u8_Value)
 
VOID Transmit_U8_Value_As_Hex (U8 u8_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U8_Buffer (U8 *u8_Data_Buffer, U32 u32_Length)
 
VOID Transmit_I8_Value_As_Decimal (I8 i8_Value)
 
VOID Transmit_I8_Value_As_Decimal (I8 i8_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_I8_Value_As_Hex (I8 i8_Value)
 
VOID Transmit_I8_Value_As_Hex (I8 i8_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U16_Value_As_Decimal (U16 u16_Value)
 
VOID Transmit_U16_Value_As_Decimal (U16 u16_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U16_Value_As_Hex (U16 u16_Value)
 
VOID Transmit_U16_Value_As_Hex (U16 u16_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_I16_Value_As_Decimal (I16 i16_Value)
 
VOID Transmit_I16_Value_As_Decimal (I16 i16_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_I16_Value_As_Hex (I16 i16_Value)
 
VOID Transmit_I16_Value_As_Hex (I16 i16_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U32_Value_As_Decimal (U32 u32_Value)
 
VOID Transmit_U32_Value_As_Decimal (U32 u32_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U32_Value_As_Hex (U32 u32_Value)
 
VOID Transmit_U32_Value_As_Hex (U32 u32_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_I32_Value_As_Decimal (I32 i32_Value)
 
VOID Transmit_I32_Value_As_Decimal (I32 i32_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_I32_Value_As_Hex (I32 i32_Value)
 
VOID Transmit_I32_Value_As_Hex (I32 i32_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U64_Value_As_Decimal (U64 u64_Value)
 
VOID Transmit_U64_Value_As_Decimal (U64 u64_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_U64_Value_As_Hex (U64 u64_Value)
 
VOID Transmit_U64_Value_As_Hex (U64 u64_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_I64_Value_As_Decimal (I64 i64_Value)
 
VOID Transmit_I64_Value_As_Decimal (I64 i64_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_I64_Value_As_Hex (I64 i64_Value)
 
VOID Transmit_I64_Value_As_Hex (I64 i64_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_F32_Value_As_Decimal (F32 f32_Value)
 
VOID Transmit_F32_Value_As_Decimal (F32 f32_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_F32_Value_As_Hex (F32 f32_Value)
 
VOID Transmit_F32_Value_As_Hex (F32 f32_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_F64_Value_As_Decimal (F64 f64_Value)
 
VOID Transmit_F64_Value_As_Decimal (F64 f64_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_F64_Value_As_Hex (F64 f64_Value)
 
VOID Transmit_F64_Value_As_Hex (F64 f64_Value, U32 u32_End_New_Line_Count)
 
VOID Transmit_DateTime_Structure_Value_As_String (TDate_Time::TDate_Time_Structure struct_DateTime_Structure)
 
VOID Transmit_DateTime_Structure_Value_As_String (TDate_Time::TDate_Time_Structure struct_DateTime_Structure, U32 u32_End_New_Line_Count)
 
VOID Transmit_Buffer_As_U8_Dump (U32 u32_Address, U32 u32_Size, U8 *u8_Buffer, BOOL bool_Align)
 
virtual BOOL Set_Address (U8 u8_Address)
 Set node address. More...
 
VOID Log_Bus_Message ()
 Log message event for statistics purpouses. More...
 
VOID Log_Bus_Communication_Error ()
 Log communication error event for statistics purpouses. More...
 
VOID Log_Bus_Character_Overrun ()
 Log character overrun error event for statistics purpouses. More...
 
VOID Log_Bus_Frame_Size_Error ()
 Log frame size error event for statistics purpouses. More...
 
VOID Log_Bus_CRC_Error ()
 Log CRC error event for statistics purpouses. More...
 
VOID Log_Slave_Exception_Error ()
 Log slave exception error event for statistics purpouses. More...
 
VOID Log_Slave_Message ()
 Log slave messege event for statistics purpouses. More...
 
VOID Log_Slave_Broadcast_Message ()
 Log slave broadcast messege event for statistics purpouses. More...
 
VOID Log_Slave_Unknown_Request_Error ()
 Log slave unknown request event for statistics purpouses. More...
 
VOID Log_Slave_No_Response ()
 Log slave no responce event for statistics purpouses. More...
 
VOID Log_Slave_No_Acknowledge ()
 Log slave no acknowledge event for statistics purpouses. More...
 
VOID Log_Slave_Busy ()
 Log slave busy event for statistics purpouses. More...
 
VOID Log_Parameter_Information_Request ()
 Log parameter information request event for statistics purpouses. More...
 
VOID Log_Parameter_Information_Request_Error ()
 Log parameter information request error event for statistics purpouses. More...
 
VOID Log_Parameter_Read_Request ()
 Log parameter read event for statistics purpouses. More...
 
VOID Log_Parameter_Read_Request_Error ()
 Log parameter read error event for statistics purpouses. More...
 
VOID Log_Parameter_Write_Request ()
 Log parameter write event for statistics purpouses. More...
 
VOID Log_Parameter_Write_Request_Error ()
 Log parameter write error event for statistics purpouses. More...
 
VOID Log_Event_Information_Request ()
 Log system event information request event for statistics purpouses. More...
 
VOID Log_Event_Information_Request_Error ()
 Log system event information request error event for statistics purpouses. More...
 

Additional Inherited Members

- Protected Member Functions inherited from TProtocol_Base
VOID New_Data_Arrived ()
 Indicate new data for processing arrived. More...
 
VOID New_Data_Processed ()
 Indicate new data processed. More...
 
BOOL Is_New_Data_Present ()
 Return new data presentse status. More...
 
BOOL Is_New_Data_Processed ()
 Return new data processed status. More...
 
- Protected Attributes inherited from TProtocol_Base
BOOL bool_Parameter_Mapping_Enable = (BOOL)false
 Parameter mapping enable flag. More...
 
U32 u32_Bus_Message_Counter = (U32)0
 Total communication bus message counter. More...
 
U32 u32_Bus_Communication_Error_Counter = (U32)0
 Communication bus error counter. More...
 
U32 u32_Bus_Character_Overrun_Counter = (U32)0
 Communication bus character overrun error counter. More...
 
U32 u32_Bus_CRC_Error_Counter = (U32)0
 Communication bus CRC error counter. More...
 
U32 u32_Bus_Frame_Size_Error_Counter = (U32)0
 Communication bus frame size error counter. More...
 
U32 u32_Slave_Exception_Error_Counter = (U32)0
 Slave exception error counter. More...
 
U32 u32_Slave_Message_Counter = (U32)0
 Total slave message counter. More...
 
U32 u32_Slave_Broadcast_Message_Counter = (U32)0
 Slave broadcast message counter. More...
 
U32 u32_Slave_Unknown_Request_Counter = (U32)0
 Slave unknown request counter. More...
 
U32 u32_Slave_No_Response_Counter = (U32)0
 Slave no responce counter. More...
 
U32 u32_Slave_No_Acknowledge_Counter = (U32)0
 Slave no acknowledge counter. More...
 
U32 u32_Slave_Busy_Counter = (U32)0
 Slave busy counter. More...
 
U32 u32_Parameter_Information_Request_Counter = (U32)0
 Parameter information request counter. More...
 
U32 u32_Parameter_Information_Request_Error_Counter = (U32)0
 Parameter information request error counter. More...
 
U32 u32_Parameter_Read_Request_Counter = (U32)0
 Parameter read request counter. More...
 
U32 u32_Parameter_Read_Request_Error_Counter = (U32)0
 Parameter read request error counter. More...
 
U32 u32_Parameter_Write_Request_Counter = (U32)0
 Parameter write request counter. More...
 
U32 u32_Parameter_Write_Request_Error_Counter = (U32)0
 Parameter write request error counter. More...
 
U32 u32_Event_Information_Request_Counter = (U32)0
 Event information request counter. More...
 
U32 u32_Event_Information_Request_Error_Counter = (U32)0
 Event information request error counter. More...
 
TExecution_Profile object_Execution_Profile
 Execution profile object. More...
 

Detailed Description

Dummy communication protocol over UART class implementation.

Constructor & Destructor Documentation

◆ TProtocol_PLUG_Over_UART()

TProtocol_PLUG_Over_UART::TProtocol_PLUG_Over_UART ( )

Class constructor method.


Note
None
Override
Not allowed
Attention
Don't call this method directly.

◆ ~TProtocol_PLUG_Over_UART()

TProtocol_PLUG_Over_UART::~TProtocol_PLUG_Over_UART ( )

Class destructor method.


Note
None
Override
Not allowed
Attention
Don't call this method directly.

Member Function Documentation

◆ Communication_Data_Receive() [1/2]

VOID TProtocol_PLUG_Over_UART::Communication_Data_Receive ( U8  u8_Receive_Value)
virtual

Communication data receive method.


Note
None
Parameters
[in]u8_Receive_Value- Received value
Returns
None
Override
Requered
Attention
None

Reimplemented from TCommunication_Data_Link.

◆ Communication_Data_Receive() [2/2]

VOID TProtocol_PLUG_Over_UART::Communication_Data_Receive ( VOID void_Receive_Data)
virtual

Communication data receive method.


Note
None
Parameters
[in]void_Receive_Data- Pointer on received data
Returns
None
Override
Requered
Attention
None

◆ Enter_Protocol_Mode()

VOID TProtocol_PLUG_Over_UART::Enter_Protocol_Mode ( )
virtual

Enter in protocol operation mode method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Enter_Terminal_Mode()

VOID TProtocol_PLUG_Over_UART::Enter_Terminal_Mode ( )
virtual

Enter in terminal operation mode method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Execute()

VOID TProtocol_PLUG_Over_UART::Execute ( )
virtual

Protocol execution method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Reimplemented from TProtocol_Base.

◆ Execute_1ms()

VOID TProtocol_PLUG_Over_UART::Execute_1ms ( )
virtual

PLUG protocol 1ms cyclic processing method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Reimplemented from TProtocol_Base.

◆ Init()

VOID TProtocol_PLUG_Over_UART::Init ( )

Object initialisation method.


Note
None
Returns
None
Override
Not allowed
Attention
None

References TProtocol_Base::Init().

Referenced by TApplication_Base::Init(), and TBootloader_Base::Init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Is_Protocol_Mode()

BOOL TProtocol_PLUG_Over_UART::Is_Protocol_Mode ( )
virtual

Return protocol operatuin mode status method.


Note
None
Returns
BOOL - Protocol operatuin mode status
Return values
false- Non-protocol mode selected
true- Protocol mode selected
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Is_Terminal_Mode()

BOOL TProtocol_PLUG_Over_UART::Is_Terminal_Mode ( )
virtual

Return terminal operation mode status method.


Note
None
Returns
BOOL - Protocol operatuin mode status
Return values
false- Non-terminal mode selected
true- Terminal mode selected
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Receive_String() [1/2]

VOID TProtocol_PLUG_Over_UART::Receive_String ( C8 c8_String)
virtual

Receiveed string processing method.


Note
None
Parameters
[in]*c8_String- Pointer to the null terminated string
Returns
None
Override
Not allowed
Attention
This method called from interrupt

Implements TProtocol_Base.

◆ Receive_String() [2/2]

VOID TProtocol_PLUG_Over_UART::Receive_String ( C8 c8_String,
U32  u32_Length 
)
virtual

Receiveed string processing method.


Note
This method is not used in this object.
Parameters
[in]*c8_String- Pointer to the null terminated string
[in]u32_Length- Length of the string
Returns
None
Override
Not allowed
Attention
This method called from interrupt

Implements TProtocol_Base.

◆ Send_Information()

VOID TProtocol_PLUG_Over_UART::Send_Information ( TProtocol_Base object_Protocol)
virtual

Method sends actual driver information over specified communication link protocol.


Note
None
Parameters
[in]*object_Protocol- Pointer to the connunication link protocol
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.

References TProtocol_Base::Transmit_String().

Referenced by TCommand_COM0::Execute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Show_System_Ready_Message_Disable()

VOID TProtocol_PLUG_Over_UART::Show_System_Ready_Message_Disable ( )
virtual

Disable system ready message method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Show_System_Ready_Message_Enable()

VOID TProtocol_PLUG_Over_UART::Show_System_Ready_Message_Enable ( )
virtual

Enable system ready message method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Show_System_Welcome_Message_Disable()

VOID TProtocol_PLUG_Over_UART::Show_System_Welcome_Message_Disable ( )
virtual

Disable show system welcome message method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Show_System_Welcome_Message_Enable()

VOID TProtocol_PLUG_Over_UART::Show_System_Welcome_Message_Enable ( )
virtual

Enable show system welcome message method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.

◆ Transmit_Boot_Welcome_Message()

VOID TProtocol_PLUG_Over_UART::Transmit_Boot_Welcome_Message ( )
virtual

Transmit boot welcome message method.


Note
None
Returns
None
Override
Not allowed
Attention
This method called from interrupt

Implements TProtocol_Base.

◆ Transmit_System_Ready_Message()

VOID TProtocol_PLUG_Over_UART::Transmit_System_Ready_Message ( )
virtual

Transmit boot ready message method.


Note
None
Returns
None
Override
Not allowed
Attention
None

Implements TProtocol_Base.


The documentation for this class was generated from the following files: