Communication protocol ANVILEX master over UART class. More...

#include <Protocol_ANVILEX_Master_Over_UART.h>

Inheritance diagram for TProtocol_ANVILEX_Master_Over_UART:

Collaboration diagram for TProtocol_ANVILEX_Master_Over_UART:

Public Types
enum	TProtocol_Return_Code { enum_Ok = 0x00000000 , enum_Invalid_Frame_Format = 0x00000001 , enum_Invalid_Frame_CRC = 0x00000002 , enum_Not_Implemented = 0x00000003 , enum_Unknown_Error = 0x00000004 , 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 , enum_Event_Not_Found = 0x0000000C , enum_Event_Property_Not_Found = 0x0000000D }

Public Member Functions
	TProtocol_ANVILEX_Master_Over_UART ()
	Class constructor method. More...

virtual	~TProtocol_ANVILEX_Master_Over_UART ()
	Class destructor method. More...

VOID	Init ()
	Protocol initialisation 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)

virtual VOID	Receive_String (C8 *c8_String)
	Receive string. More...

virtual VOID	Receive_String (C8 *c8_String, U32 u32_Length)
	Receive string. More...

virtual VOID	Execute ()
	Cyclic execution method. More...

virtual VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send information about protocol method. More...

virtual VOID	Enter_Terminal_Mode ()
	Enter terminal mode method. More...

virtual VOID	Enter_Protocol_Mode ()
	Enter protocol mode method. More...

virtual BOOL	Is_Terminal_Mode ()
	Terminal mode operation status method. More...

virtual BOOL	Is_Protocol_Mode ()
	Protocol mode operation status method. More...

VOID	Transmit_Prompt ()
	Transmit prompt in terminal 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...

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...

virtual VOID	Execute_1ms ()
	System task 1ms cyclic execution method. 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...

Public Member Functions inherited from TCommunication_Data_Link
	TCommunication_Data_Link ()
	Class constructor method. More...

VOID	Connect_Data_Link (TCommunication_Data_Link *object_New_Data_Link)
	Connect data link method. More...

VOID	Disconnect_Data_Link ()
	Disconnect data link method. More...

Public Attributes
BOOL	bool_Terminal_Mode = (BOOL)true
	Terminal operation mode status. More...

BOOL	bool_Show_System_Welcome_Message_Enabled = (BOOL)false
	Show system welcome message status. More...

BOOL	bool_Show_System_Ready_Message_Enabled = (BOOL)false
	Show system ready message status. More...

Private Types
enum	TMaster_State { enum_Init , enum_Idle , enum_Send_Request , enum_Wait_Write_Response , enum_Wait_Read_Response }
	Master finite state mashine states definition. More...

Private Member Functions
U32	Get_Responce_Data_Length ()

BOOL	Protocol_Remote_Parameter_Read_Response ()
	Protocol remote parameter response processing. More...

VOID	Remote_Parameter_Index_Processing ()

BOOL	Is_Remote_Parameter_List_Empty ()

BOOL	Parse_Frames_Into_Message ()

BOOL	Get_Frame (C8 *c8_Return_Value, U8 u8_Frame_Number)

Private Attributes
const C8	Bin2HexTable [16] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' }
	Bin to hex table. More...

C8	c8_Receive_Buffer [ANVILEX_MASTER_PROTOCOL_RX_BUFFER_SIZE] = { 0x00 }
	Data receive buffer. More...

U32	u32_Receive_Buffer_Index = (U32)0
	Receive buffer index. More...

C8	c8_Transmit_Buffer [ANVILEX_MASTER_PROTOCOL_TX_BUFFER_SIZE] = { 0x00 }
	Data transmit buffer. More...

C8	c8_New_Data_Buffer [ANVILEX_MASTER_PROTOCOL_RX_BUFFER_SIZE] = { 0x00 }
	New data buffer. More...

C8	c8_Remote_Parameter_Value [64] = { 0x00 }
	Remote parameter value as string. More...

TMaster_State	enum_Master_FSM = TMaster_State::enum_Init
	Master finite state mashine. More...

U32	u32_Remote_Node_Address = (U32)0
	Remote node address. More...

U32	u32_Remote_Parameter_Index = (U32)0
	Remote parameter index. More...

U32	u32_Remote_Write_Start_Timestamp = (U32)0
	Timestamp for remote writing. More...

U32	u32_Remote_Write_Timeout = (U32)0
	Timeout for remote writing. More...

U32	u32_Remote_Read_Start_Timestamp = (U32)0
	Timestamp for remote reading. More...

U32	u32_Remote_Read_Timeout = (U32)0
	Timeout for remote reading. More...

U8	u8_Package_ID = (U8)0
	Package ID. More...

U8	u8_Ref_Package_ID = (U8)0
	Package ID. More...

U32	u32_Node_Address = (U32)0
	Node address. More...

U8	u8_Frame_Counter = (U8)0
	Frame counter. More...

C8	c8_Frame_List [ANVILEX_MASTER_FRAME_NUMBER][ANVILEX_MASTER_FRAME_SIZE]
	Frames list. 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 Member Functions inherited from TCommunication_Data_Link
virtual VOID	Communication_Data_Transmit (U8 u8_Transmit_Value)
	Communication data transmit method. More...

virtual VOID	Communication_Block_Data_Receive (VOID *void_Receive_Data)
	Communication data receive method. More...

virtual VOID	Communication_Block_Data_Transmit (VOID *void_Receive_Data)
	Communication data transmit method. 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...

Protected Attributes inherited from TCommunication_Data_Link
TCommunication_Data_Link *	object_Data_Link = (TCommunication_Data_Link*)NULL
	Pointer to the data link object. More...

Detailed Description

Communication protocol ANVILEX master over UART class.

Member Enumeration Documentation

◆ TMaster_State

enum TProtocol_ANVILEX_Master_Over_UART::TMaster_State

private

Master finite state mashine states definition.

Enumerator
enum_Init	Initialisation state.
enum_Idle	Idle state.
enum_Send_Request	Send request state.
enum_Wait_Write_Response	Wait for write access response.
enum_Wait_Read_Response	Wait for read access response.

◆ TProtocol_Return_Code

enum TProtocol_ANVILEX_Master_Over_UART::TProtocol_Return_Code

Enumerator
enum_Ok
enum_Invalid_Frame_Format
enum_Invalid_Frame_CRC
enum_Not_Implemented
enum_Unknown_Error
enum_Parameter_Not_Found
enum_Parameter_Property_Not_Found
enum_Parameter_Non_Readable
enum_Parameter_Non_Writable
enum_Parameter_Access_Denied
enum_Parameter_Value_Out_Of_Bounds
enum_Parameter_Write_Failure
enum_Event_Not_Found
enum_Event_Property_Not_Found

Constructor & Destructor Documentation

◆ TProtocol_ANVILEX_Master_Over_UART()

TProtocol_ANVILEX_Master_Over_UART::TProtocol_ANVILEX_Master_Over_UART ( )

Class constructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

◆ ~TProtocol_ANVILEX_Master_Over_UART()

TProtocol_ANVILEX_Master_Over_UART::~TProtocol_ANVILEX_Master_Over_UART ( )

virtual

Class destructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly. Class destructor method

Member Function Documentation

◆ Communication_Data_Receive() [1/2]

VOID TProtocol_ANVILEX_Master_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.

References ANVILEX_MASTER_PROTOCOL_RX_BUFFER_SIZE, c8_Receive_Buffer, TProtocol_Base::Is_New_Data_Present(), Receive_String(), true, and u32_Receive_Buffer_Index.

Here is the call graph for this function:

◆ Communication_Data_Receive() [2/2]

VOID TProtocol_ANVILEX_Master_Over_UART::Communication_Data_Receive ( VOID * void_Receive_Data )

virtual

◆ Enter_Protocol_Mode()

VOID TProtocol_ANVILEX_Master_Over_UART::Enter_Protocol_Mode ( )

virtual

Enter protocol mode method.

Note: None

Returns: None

Override: Requered

Attention: None

Implements TProtocol_Base.

◆ Enter_Terminal_Mode()

VOID TProtocol_ANVILEX_Master_Over_UART::Enter_Terminal_Mode ( )

virtual

Enter terminal mode method.

Note: None

Returns: None

Override: Requered

Attention: None

Implements TProtocol_Base.

◆ Execute()

VOID TProtocol_ANVILEX_Master_Over_UART::Execute ( )

virtual

Cyclic execution method.

Note: None

Override: Not allowed

Attention: None

Reimplemented from TProtocol_Base.

References ANVILEX_MASTER_FRAME_SIZE, Bin2HexTable, c8_New_Data_Buffer, enum_Idle, enum_Master_FSM, enum_Read, enum_Send_Request, enum_Write, false, TSystem_Timer_Base::Get_Actual_Time(), Get_Frame(), Get_Responce_Data_Length(), TParameter_Base::Get_Type(), TConOpSys_Variant::Get_Value_As_Hex_String(), High_Nibble_To_Hex(), Increment_Overflowed(), TProtocol_Base::Is_New_Data_Present(), Is_Remote_Parameter_List_Empty(), TSystem_Timer_Base::Is_Timeout_ms(), Low_Nibble_To_Hex(), TProtocol_Base::New_Data_Processed(), object_System_Timer, Parse_Frames_Into_Message(), REMOTE_PARAMETERS_NUMBER, TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_Hex_String(), String_To_U32(), String_To_U8(), TProtocol_Base::Transmit_Char(), TProtocol_Base::Transmit_New_Line(), u32_Node_Address, u32_Remote_Parameter_Index, u32_Remote_Read_Start_Timestamp, u32_Remote_Read_Timeout, u32_Remote_Write_Start_Timestamp, u32_Remote_Write_Timeout, u8_Frame_Counter, u8_Package_ID, u8_Ref_Package_ID, and TParameter_Base::Write_Value_As_Variant().

Here is the call graph for this function:

◆ Get_Frame()

BOOL TProtocol_ANVILEX_Master_Over_UART::Get_Frame	(	C8 *	c8_Return_Value,
		U8	u8_Frame_Number
	)

private

References ANVILEX_MASTER_FRAME_SIZE, and c8_Frame_List.

Referenced by Execute().

Here is the caller graph for this function:

◆ Get_Responce_Data_Length()

U32 TProtocol_ANVILEX_Master_Over_UART::Get_Responce_Data_Length ( )

private

References ANVILEX_MASTER_PROTOCOL_RX_BUFFER_SIZE, and c8_New_Data_Buffer.

Referenced by Execute(), and Parse_Frames_Into_Message().

Here is the caller graph for this function:

◆ Init()

VOID TProtocol_ANVILEX_Master_Over_UART::Init ( )

Protocol initialisation method.

Note: None

Override: Not allowed

Attention: None

References TProtocol_Base::Init().

Here is the call graph for this function:

◆ Is_Protocol_Mode()

BOOL TProtocol_ANVILEX_Master_Over_UART::Is_Protocol_Mode ( )

virtual

Protocol mode operation status method.

Note: None

Returns: BOOL - Protocol mode operation status

Return values

false	- Communication protocol operates not in protocol mode
true	- Communication protocol operates in protocol mode

Override: Requered

Attention: None

Implements TProtocol_Base.

◆ Is_Remote_Parameter_List_Empty()

BOOL TProtocol_ANVILEX_Master_Over_UART::Is_Remote_Parameter_List_Empty ( )

private

References u32_Remote_Parameter_Index.

Referenced by Execute().

Here is the caller graph for this function:

◆ Is_Terminal_Mode()

BOOL TProtocol_ANVILEX_Master_Over_UART::Is_Terminal_Mode ( )

virtual

Terminal mode operation status method.

Note: None

Returns: BOOL - Terminal mode operation status

Return values

false	- Communication protocol operates not in terminal mode
true	- Communication protocol operates in terminal mode

Override: Requered

Attention: None

Implements TProtocol_Base.

Referenced by Transmit_System_Ready_Message().

Here is the caller graph for this function:

◆ Parse_Frames_Into_Message()

BOOL TProtocol_ANVILEX_Master_Over_UART::Parse_Frames_Into_Message ( )

private

References ANVILEX_MASTER_FRAME_NUMBER, ANVILEX_MASTER_FRAME_SIZE, c8_Frame_List, c8_New_Data_Buffer, Get_Responce_Data_Length(), and u8_Frame_Counter.

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Protocol_Remote_Parameter_Read_Response()

BOOL TProtocol_ANVILEX_Master_Over_UART::Protocol_Remote_Parameter_Read_Response ( )

private

Protocol remote parameter response processing.

References c8_New_Data_Buffer, c8_Remote_Parameter_Value, false, High_Nibble_To_Hex(), and Low_Nibble_To_Hex().

Here is the call graph for this function:

◆ Receive_String() [1/2]

VOID TProtocol_ANVILEX_Master_Over_UART::Receive_String ( C8 * c8_String )

virtual

Receive string.

Note: None

Parameters

[in] *c8_String - Pointer to the null terminated string of characters

Returns: None

Override: Requered

Attention: None

Implements TProtocol_Base.

References ANVILEX_MASTER_PROTOCOL_RX_BUFFER_SIZE, c8_New_Data_Buffer, and TProtocol_Base::New_Data_Arrived().

Referenced by Communication_Data_Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Receive_String() [2/2]

VOID TProtocol_ANVILEX_Master_Over_UART::Receive_String	(	C8 *	c8_String,
		U32	u32_Length
	)

virtual

Receive string.

Note: None

Parameters

[in]	*c8_String	- Pointer to the string of characters
[in]	*u32_Length	- Length of the string

Returns: None

Override: Requered

Attention: None

Implements TProtocol_Base.

◆ Remote_Parameter_Index_Processing()

VOID TProtocol_ANVILEX_Master_Over_UART::Remote_Parameter_Index_Processing ( )

private

◆ Send_Information()

VOID TProtocol_ANVILEX_Master_Over_UART::Send_Information ( TProtocol_Base * object_Protocol )

virtual

Send information about protocol method.

Note: None

Parameters

[in] *object_Protocol - Pointer to the communication protocol

Returns: None

Override: Requered

Attention: None

Implements TProtocol_Base.

◆ Show_System_Ready_Message_Disable()

VOID TProtocol_ANVILEX_Master_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.

References bool_Show_System_Ready_Message_Enabled.

◆ Show_System_Ready_Message_Enable()

VOID TProtocol_ANVILEX_Master_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.

References bool_Show_System_Ready_Message_Enabled.

◆ Show_System_Welcome_Message_Disable()

VOID TProtocol_ANVILEX_Master_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.

References bool_Show_System_Welcome_Message_Enabled.

◆ Show_System_Welcome_Message_Enable()

VOID TProtocol_ANVILEX_Master_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.

References bool_Show_System_Welcome_Message_Enabled.

◆ Transmit_Boot_Welcome_Message()

VOID TProtocol_ANVILEX_Master_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.

References bool_Show_System_Welcome_Message_Enabled, CONTACT_COMPANY_EMAIL, CONTACT_COMPANY_INTERNET, COPYRIGHT_COMPANY, COPYRIGHT_YEAR, HARDWARE_VERSION, OPERATING_SYSTEM_NAME, and TProtocol_Base::Transmit_String().

Here is the call graph for this function:

◆ Transmit_Prompt()

VOID TProtocol_ANVILEX_Master_Over_UART::Transmit_Prompt ( )

Transmit prompt in terminal mode method.

Note: None

Returns: None

Override: Not allowed

Attention: This method called from interrupt

References TProtocol_Base::Transmit_Char().

Referenced by Transmit_System_Ready_Message().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Transmit_System_Ready_Message()

VOID TProtocol_ANVILEX_Master_Over_UART::Transmit_System_Ready_Message ( )

virtual

Transmit boot ready message method.

Note: None

Returns: None

Override: Not allowed

Attention: None

Implements TProtocol_Base.

References bool_Show_System_Ready_Message_Enabled, Is_Terminal_Mode(), Transmit_Prompt(), and TProtocol_Base::Transmit_String().

Here is the call graph for this function:

Member Data Documentation

◆ Bin2HexTable

const C8 TProtocol_ANVILEX_Master_Over_UART::Bin2HexTable[16] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' }

private

Bin to hex table.

Referenced by Execute().

◆ bool_Show_System_Ready_Message_Enabled

BOOL TProtocol_ANVILEX_Master_Over_UART::bool_Show_System_Ready_Message_Enabled = (BOOL)false

Show system ready message status.

Referenced by Show_System_Ready_Message_Disable(), Show_System_Ready_Message_Enable(), and Transmit_System_Ready_Message().

◆ bool_Show_System_Welcome_Message_Enabled

BOOL TProtocol_ANVILEX_Master_Over_UART::bool_Show_System_Welcome_Message_Enabled = (BOOL)false

Show system welcome message status.

Referenced by Show_System_Welcome_Message_Disable(), Show_System_Welcome_Message_Enable(), and Transmit_Boot_Welcome_Message().

◆ bool_Terminal_Mode

BOOL TProtocol_ANVILEX_Master_Over_UART::bool_Terminal_Mode = (BOOL)true

Terminal operation mode status.

◆ c8_Frame_List

C8 TProtocol_ANVILEX_Master_Over_UART::c8_Frame_List[ANVILEX_MASTER_FRAME_NUMBER][ANVILEX_MASTER_FRAME_SIZE]

private

Frames list.

Referenced by Get_Frame(), and Parse_Frames_Into_Message().

◆ c8_New_Data_Buffer

C8 TProtocol_ANVILEX_Master_Over_UART::c8_New_Data_Buffer[ANVILEX_MASTER_PROTOCOL_RX_BUFFER_SIZE] = { 0x00 }

private

New data buffer.

Referenced by Execute(), Get_Responce_Data_Length(), Parse_Frames_Into_Message(), Protocol_Remote_Parameter_Read_Response(), and Receive_String().

◆ c8_Receive_Buffer

C8 TProtocol_ANVILEX_Master_Over_UART::c8_Receive_Buffer[ANVILEX_MASTER_PROTOCOL_RX_BUFFER_SIZE] = { 0x00 }

private

Data receive buffer.

Referenced by Communication_Data_Receive().

◆ c8_Remote_Parameter_Value

C8 TProtocol_ANVILEX_Master_Over_UART::c8_Remote_Parameter_Value[64] = { 0x00 }

private

Remote parameter value as string.

Referenced by Protocol_Remote_Parameter_Read_Response().

◆ c8_Transmit_Buffer

C8 TProtocol_ANVILEX_Master_Over_UART::c8_Transmit_Buffer[ANVILEX_MASTER_PROTOCOL_TX_BUFFER_SIZE] = { 0x00 }

private

Data transmit buffer.

◆ enum_Master_FSM

TMaster_State TProtocol_ANVILEX_Master_Over_UART::enum_Master_FSM = TMaster_State::enum_Init

private

Master finite state mashine.

Referenced by Execute().

◆ u32_Node_Address

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Node_Address = (U32)0

private

Node address.

Referenced by Execute().

◆ u32_Receive_Buffer_Index

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Receive_Buffer_Index = (U32)0

private

Receive buffer index.

Referenced by Communication_Data_Receive().

◆ u32_Remote_Node_Address

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Remote_Node_Address = (U32)0

private

Remote node address.

◆ u32_Remote_Parameter_Index

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Remote_Parameter_Index = (U32)0

private

Remote parameter index.

Referenced by Execute(), and Is_Remote_Parameter_List_Empty().

◆ u32_Remote_Read_Start_Timestamp

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Remote_Read_Start_Timestamp = (U32)0

private

Timestamp for remote reading.

Referenced by Execute().

◆ u32_Remote_Read_Timeout

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Remote_Read_Timeout = (U32)0

private

Timeout for remote reading.

Referenced by Execute().

◆ u32_Remote_Write_Start_Timestamp

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Remote_Write_Start_Timestamp = (U32)0

private

Timestamp for remote writing.

Referenced by Execute().

◆ u32_Remote_Write_Timeout

U32 TProtocol_ANVILEX_Master_Over_UART::u32_Remote_Write_Timeout = (U32)0

private

Timeout for remote writing.

Referenced by Execute().

◆ u8_Frame_Counter

U8 TProtocol_ANVILEX_Master_Over_UART::u8_Frame_Counter = (U8)0

private

Frame counter.

Referenced by Execute(), and Parse_Frames_Into_Message().

◆ u8_Package_ID

U8 TProtocol_ANVILEX_Master_Over_UART::u8_Package_ID = (U8)0

private

Package ID.

Referenced by Execute().

◆ u8_Ref_Package_ID

U8 TProtocol_ANVILEX_Master_Over_UART::u8_Ref_Package_ID = (U8)0

private

Package ID.

Referenced by Execute().

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

ConOpSys/Engine/Communication/Anvilex/Protocol_ANVILEX_Master_Over_UART.h
ConOpSys/Engine/Communication/Anvilex/Protocol_ANVILEX_Master_Over_UART.cpp

Public Types

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TMaster_State

◆ TProtocol_Return_Code

Constructor & Destructor Documentation

◆ TProtocol_ANVILEX_Master_Over_UART()

◆ ~TProtocol_ANVILEX_Master_Over_UART()

Member Function Documentation

◆ Communication_Data_Receive() [1/2]

◆ Communication_Data_Receive() [2/2]

◆ Enter_Protocol_Mode()

◆ Enter_Terminal_Mode()

◆ Execute()

◆ Get_Frame()

◆ Get_Responce_Data_Length()

◆ Init()

◆ Is_Protocol_Mode()

◆ Is_Remote_Parameter_List_Empty()

◆ Is_Terminal_Mode()

◆ Parse_Frames_Into_Message()

◆ Protocol_Remote_Parameter_Read_Response()

◆ Receive_String() [1/2]

◆ Receive_String() [2/2]

◆ Remote_Parameter_Index_Processing()

◆ Send_Information()

◆ Show_System_Ready_Message_Disable()

◆ Show_System_Ready_Message_Enable()

◆ Show_System_Welcome_Message_Disable()

◆ Show_System_Welcome_Message_Enable()

◆ Transmit_Boot_Welcome_Message()

◆ Transmit_Prompt()

◆ Transmit_System_Ready_Message()

Member Data Documentation

◆ Bin2HexTable

◆ bool_Show_System_Ready_Message_Enabled

◆ bool_Show_System_Welcome_Message_Enabled

◆ bool_Terminal_Mode

◆ c8_Frame_List

◆ c8_New_Data_Buffer

◆ c8_Receive_Buffer

◆ c8_Remote_Parameter_Value

◆ c8_Transmit_Buffer

◆ enum_Master_FSM

◆ u32_Node_Address

◆ u32_Receive_Buffer_Index

◆ u32_Remote_Node_Address

◆ u32_Remote_Parameter_Index

◆ u32_Remote_Read_Start_Timestamp

◆ u32_Remote_Read_Timeout

◆ u32_Remote_Write_Start_Timestamp

◆ u32_Remote_Write_Timeout

◆ u8_Frame_Counter

◆ u8_Package_ID

◆ u8_Ref_Package_ID