TProtocol_ANVILEX_Over_UART Class Reference

Communication protocol ANVILEX over UART class. More...

#include <Protocol_ANVILEX_Over_UART.h>

Inheritance diagram for TProtocol_ANVILEX_Over_UART:

Collaboration diagram for TProtocol_ANVILEX_Over_UART:

Public Types
enum	TParameter_Property_Index {   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 }
	Parameter property index definitions. More...
enum	TEvent_Property_Index { enum_Event_Description = 1 }
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_Over_UART ()
	Class constructor method. More...
	~TProtocol_ANVILEX_Over_UART ()
	Base class constructor method. More...
VOID	Init ()
	Object initialisation 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...
virtual BOOL	Is_Terminal_Mode ()
	Return terminal operation mode status method. More...
virtual BOOL	Is_Protocol_Mode ()
	Return protocol operatuin mode status 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 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_Prompt ()
	Transmit prompt in terminal mode method. More...
VOID	Transmit_Boot_Welcome_Message ()
	Transmit boot welcome message method. More...
VOID	Transmit_System_Ready_Message ()
	Transmit boot ready message method. More...
virtual VOID	Execute ()
	Protocol execution method. More...
virtual VOID	Execute_Profile ()
	Profile execution 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...

Private Member Functions
BOOL	Terminal_Parameter_Information_Request ()
	Parameter information terminal request method. More...
BOOL	Protocol_Parameter_Information_Request ()
	Parameter information protocol request method. More...
BOOL	Terminal_Parameter_Read_Request ()
	Parameter read terminal request method. More...
BOOL	Protocol_Parameter_Read_Request ()
	Parameter read protocol request method. More...
BOOL	Terminal_Parameter_Write_Request ()
	Parameter write terminal request method. More...
BOOL	Protocol_Parameter_Write_Request ()
	Parameter write protocol request method. More...
VOID	Command_Execution_Request ()
	Command execution request method. More...
BOOL	Terminal_Event_Information_Request ()
	Event information request in terminal mode method. More...
BOOL	Protocol_Event_Information_Request ()
	Event information request in protocol mode method. More...
VOID	Protocol_Transmit_Error_Code (TProtocol_Return_Code enum_Return_Code)
	Transmit error code method. More...
VOID	Protocol_Transmit_Variant_Value (TConOpSys_Variant *object_Value)
	Transmit variant value method. More...
VOID	Protocol_Transmit_U32_Value (U32 u32_Value)
	Transmit U32 value method. More...
VOID	Protocol_Transmit_String (C8 *c8_String)
	Transmit null terminated string method. More...

Private Attributes
C8	char_Instance_Derscriptor = (C8)'>'
	Communication module instance descriptor. More...
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...
U32	u32_Receive_Buffer_Index = (U32)0
	Receive buffer index. More...
C8	c8_Receive_Buffer [ANVILEX_PROTOCOL_RX_BUFFER_SIZE]
	Data receive buffer. More...
C8	c8_Transmit_Buffer [ANVILEX_PROTOCOL_TX_BUFFER_SIZE]
	Data transmit buffer. More...
C8	c8_New_Data_Buffer [ANVILEX_PROTOCOL_RX_BUFFER_SIZE]
	New data buffer. More...
BOOL	bool_Esc = (BOOL)false
	ESC code flag. More...
U8	u8_Scan_Code = '\0'
	Actual SCAN code. More...
BOOL	bool_String_Recall_Request = (BOOL)false
	String recall request status. More...
BOOL	bool_String_Recalled = (BOOL)false
	String recalled status. 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 over UART class.

Member Enumeration Documentation

TEvent_Property_Index

enum TProtocol_ANVILEX_Over_UART::TEvent_Property_Index

Enumerator
enum_Event_Description

TParameter_Property_Index

enum TProtocol_ANVILEX_Over_UART::TParameter_Property_Index

Parameter property index definitions.

Enumerator
enum_ID	Parameter ID property code.
enum_Properties	Struct propertes property code.
enum_Element_Count	Element count property code.
enum_Minimum_Value	Minimum value property code.
enum_Maximum_Value	Maximum value property code.
enum_Default_Value	Default value property code.
enum_Name	Parameter name property code.
enum_Group	Parameter group property code.
enum_Description	Parameter description property code.
enum_Unit	Parameter unit property code.

TProtocol_Return_Code

enum TProtocol_ANVILEX_Over_UART::TProtocol_Return_Code

Enumerator
enum_Ok	Sucess related code.
enum_Invalid_Frame_Format	Invalid frame format related code.
enum_Invalid_Frame_CRC	Invalid frame CRC related code.
enum_Not_Implemented	Not implemented related code.
enum_Unknown_Error	unknown error related code
enum_Parameter_Not_Found	parameter not fount related code
enum_Parameter_Property_Not_Found	parameter property not found related code
enum_Parameter_Non_Readable	parameter non readable related code
enum_Parameter_Non_Writable	parameter non writable related code
enum_Parameter_Access_Denied	parameter access denied related code
enum_Parameter_Value_Out_Of_Bounds	parameter value out of bounds related code
enum_Parameter_Write_Failure	parameter write failure related code
enum_Event_Not_Found	event not found related code
enum_Event_Property_Not_Found	event property not found related code

Constructor & Destructor Documentation

TProtocol_ANVILEX_Over_UART()

TProtocol_ANVILEX_Over_UART::TProtocol_ANVILEX_Over_UART

(

)

Class constructor method.

---

Note

None

Override

Not allowed

Attention

Don't call this method directly.

References ANVILEX_PROTOCOL_RX_BUFFER_SIZE, ANVILEX_PROTOCOL_TX_BUFFER_SIZE, c8_Receive_Buffer, and c8_Transmit_Buffer.

~TProtocol_ANVILEX_Over_UART()

TProtocol_ANVILEX_Over_UART::~TProtocol_ANVILEX_Over_UART

(

)

Base class constructor method.

---

Note

None

Override

Not allowed

Attention

Don't call this method directly.

Member Function Documentation

Command_Execution_Request()

VOID TProtocol_ANVILEX_Over_UART::Command_Execution_Request ( )

private

Command execution request method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References c8_New_Data_Buffer, TCommand_Manager::Execute(), Is_Terminal_Mode(), object_Command_Manager, and TProtocol_Base::Transmit_String().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Communication_Data_Receive() [1/2]

VOID TProtocol_ANVILEX_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_PROTOCOL_RX_BUFFER_SIZE, bool_Esc, bool_String_Recall_Request, bool_String_Recalled, c8_Receive_Buffer, false, TProtocol_Base::Is_New_Data_Present(), Is_Terminal_Mode(), Receive_String(), TProtocol_Base::Transmit_Char(), true, u32_Receive_Buffer_Index, and u8_Scan_Code.

Here is the call graph for this function:

Communication_Data_Receive() [2/2]

VOID TProtocol_ANVILEX_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_ANVILEX_Over_UART::Enter_Protocol_Mode ( )

virtual

Enter in protocol operation mode method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

Implements TProtocol_Base.

References bool_Terminal_Mode.

Enter_Terminal_Mode()

VOID TProtocol_ANVILEX_Over_UART::Enter_Terminal_Mode ( )

virtual

Enter in terminal operation mode method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

Implements TProtocol_Base.

References bool_Terminal_Mode.

Execute()

VOID TProtocol_ANVILEX_Over_UART::Execute ( )

virtual

Protocol execution method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

Todo:

ANVILEX KM : Code has no action

Reimplemented from TProtocol_Base.

References ANVILEX_PROTOCOL_RX_BUFFER_SIZE, bool_String_Recall_Request, bool_String_Recalled, c8_New_Data_Buffer, c8_Receive_Buffer, Command_Execution_Request(), TProtocol_Base::Is_New_Data_Present(), Is_Terminal_Mode(), TProtocol_Base::Log_Bus_Message(), TProtocol_Base::Log_Event_Information_Request(), TProtocol_Base::Log_Parameter_Information_Request(), TProtocol_Base::Log_Parameter_Read_Request(), TProtocol_Base::Log_Parameter_Write_Request(), TProtocol_Base::Log_Slave_Unknown_Request_Error(), TProtocol_Base::New_Data_Processed(), TProtocol_Base::object_Execution_Profile, Protocol_Event_Information_Request(), Protocol_Parameter_Information_Request(), Protocol_Parameter_Read_Request(), Protocol_Parameter_Write_Request(), TExecution_Profile::Start_Recording(), TExecution_Profile::Stop_Recording(), String_Length(), Terminal_Event_Information_Request(), Terminal_Parameter_Information_Request(), Terminal_Parameter_Read_Request(), Terminal_Parameter_Write_Request(), TProtocol_Base::Transmit_Char(), TProtocol_Base::Transmit_New_Line(), Transmit_Prompt(), and u32_Receive_Buffer_Index.

Here is the call graph for this function:

Execute_Profile()

VOID TProtocol_ANVILEX_Over_UART::Execute_Profile ( )

virtual

Profile execution method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References TExecution_Profile::Execute(), and TProtocol_Base::object_Execution_Profile.

Here is the call graph for this function:

Init()

VOID TProtocol_ANVILEX_Over_UART::Init

(

)

Object initialisation method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References TProtocol_Base::Init().

Here is the call graph for this function:

Is_Protocol_Mode()

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

References bool_Terminal_Mode.

Is_Terminal_Mode()

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

References bool_Terminal_Mode.

Referenced by Command_Execution_Request(), Communication_Data_Receive(), Execute(), and Transmit_System_Ready_Message().

Here is the caller graph for this function:

Protocol_Event_Information_Request()

BOOL TProtocol_ANVILEX_Over_UART::Protocol_Event_Information_Request ( )

private

Event information request in protocol mode method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None

References c8_New_Data_Buffer, enum_Event_Description, enum_Event_Not_Found, enum_Invalid_Frame_CRC, enum_Invalid_Frame_Format, false, Hex_To_U8(), High_Nibble_To_Hex(), Is_Hex_Digit(), TProtocol_Base::Log_Event_Information_Request_Error(), Low_Nibble_To_Hex(), NULL, Protocol_Transmit_Error_Code(), Protocol_Transmit_String(), and String_Length().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Protocol_Parameter_Information_Request()

BOOL TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request ( )

private

Parameter information protocol request method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None

References c8_New_Data_Buffer, enum_Default_Value, enum_Description, enum_Element_Count, enum_Group, enum_ID, enum_Invalid_Frame_CRC, enum_Invalid_Frame_Format, enum_Maximum_Value, enum_Minimum_Value, enum_Name, enum_Parameter_Not_Found, enum_Parameter_Property_Not_Found, enum_Properties, enum_Unit, false, TParameter_Base::Get_Default_Value(), TParameter_Base::Get_Description(), TParameter_Base::Get_Group_Name(), TParameter_Base::Get_ID(), TParameter_Base::Get_Maximum_Value(), TParameter_Base::Get_Minimum_Value(), TParameter_Manager::Get_Parameter_By_Index(), TParameter_Base::Get_Parameter_Element_Count(), TParameter_Base::Get_Parameter_Name(), TParameter_Base::Get_Parameter_Properties(), TParameter_Base::Get_Unit_Name(), Hex_To_U8(), High_Nibble_To_Hex(), Is_Hex_Digit(), TProtocol_Base::Log_Parameter_Information_Request_Error(), Low_Nibble_To_Hex(), NULL, object_Parameter_Manager, Protocol_Transmit_Error_Code(), Protocol_Transmit_String(), Protocol_Transmit_U32_Value(), Protocol_Transmit_Variant_Value(), and String_Length().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Protocol_Parameter_Read_Request()

BOOL TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Read_Request ( )

private

Parameter read protocol request method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None

References c8_New_Data_Buffer, enum_Invalid_Frame_CRC, enum_Invalid_Frame_Format, enum_Parameter_Not_Found, false, TParameter_Manager::Get_Parameter_By_ID(), TConOpSys_Variant::Get_Value_As_Hex_String(), Hex_To_U8(), High_Nibble_To_Hex(), Is_Hex_Digit(), TProtocol_Base::Log_Parameter_Read_Request_Error(), Low_Nibble_To_Hex(), NULL, object_Parameter_Manager, Protocol_Transmit_Error_Code(), TParameter_Base::Read_Value_As_Variant(), String_Length(), TProtocol_Base::Transmit_Char(), TProtocol_Base::Transmit_U8_Value_As_Hex(), and true.

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Protocol_Parameter_Write_Request()

BOOL TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Write_Request ( )

private

Parameter write protocol request method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None

References Bin2HexTable, c8_New_Data_Buffer, enum_Invalid_Frame_CRC, enum_Invalid_Frame_Format, enum_Parameter_Not_Found, enum_Parameter_Write_Failure, false, TParameter_Manager::Get_Parameter_By_ID(), TParameter_Base::Get_Value(), Hex_To_U8(), Is_Hex_Digit(), TParameter_Base::Is_Store_To_Media_Database(), TProtocol_Base::Log_Parameter_Write_Request_Error(), TParameter_Manager::Media_Database_Update(), NULL, object_Parameter_Manager, Protocol_Transmit_Error_Code(), Protocol_Transmit_Variant_Value(), String_Length(), true, and TParameter_Base::Write_Value_As_Hex_String().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Protocol_Transmit_Error_Code()

VOID TProtocol_ANVILEX_Over_UART::Protocol_Transmit_Error_Code ( TProtocol_Return_Code  enum_Return_Code )

private

Transmit error code method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References Bin2HexTable, TProtocol_Base::Transmit_Char(), TProtocol_Base::Transmit_I32_Value_As_Hex(), and TProtocol_Base::Transmit_U8_Value_As_Hex().

Referenced by Protocol_Event_Information_Request(), Protocol_Parameter_Information_Request(), Protocol_Parameter_Read_Request(), and Protocol_Parameter_Write_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

Protocol_Transmit_String()

VOID TProtocol_ANVILEX_Over_UART::Protocol_Transmit_String ( C8 *  c8_String )

private

Transmit null terminated string method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References Bin2HexTable, String_Length(), TProtocol_Base::Transmit_Char(), and TProtocol_Base::Transmit_U8_Value_As_Hex().

Referenced by Protocol_Event_Information_Request(), and Protocol_Parameter_Information_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

Protocol_Transmit_U32_Value()

VOID TProtocol_ANVILEX_Over_UART::Protocol_Transmit_U32_Value ( U32  u32_Value )

private

Transmit U32 value method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References Bin2HexTable, TProtocol_Base::Transmit_Char(), TProtocol_Base::Transmit_I32_Value_As_Hex(), and TProtocol_Base::Transmit_U8_Value_As_Hex().

Referenced by Protocol_Parameter_Information_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

Protocol_Transmit_Variant_Value()

VOID TProtocol_ANVILEX_Over_UART::Protocol_Transmit_Variant_Value ( TConOpSys_Variant *  object_Value )

private

Transmit variant value method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References TConOpSys_Variant::Get_Value_As_Hex_String(), TProtocol_Base::Transmit_Char(), and TProtocol_Base::Transmit_U8_Value_As_Hex().

Referenced by Protocol_Parameter_Information_Request(), and Protocol_Parameter_Write_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

Receive_String() [1/2]

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

References ANVILEX_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_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_ANVILEX_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 TExecution_Profile::Get_Maximum_Execution_Time(), NULL, TCommunication_Data_Link::object_Data_Link, TProtocol_Base::object_Execution_Profile, TProtocol_Base::Transmit_String(), TProtocol_Base::Transmit_U32_Value_As_Decimal(), TProtocol_Base::Transmit_U64_Value_As_Decimal(), TProtocol_Base::u32_Bus_Character_Overrun_Counter, TProtocol_Base::u32_Bus_Communication_Error_Counter, TProtocol_Base::u32_Bus_CRC_Error_Counter, TProtocol_Base::u32_Bus_Message_Counter, TProtocol_Base::u32_Parameter_Information_Request_Counter, TProtocol_Base::u32_Parameter_Information_Request_Error_Counter, TProtocol_Base::u32_Parameter_Read_Request_Counter, TProtocol_Base::u32_Parameter_Read_Request_Error_Counter, TProtocol_Base::u32_Parameter_Write_Request_Counter, TProtocol_Base::u32_Parameter_Write_Request_Error_Counter, TProtocol_Base::u32_Slave_Broadcast_Message_Counter, TProtocol_Base::u32_Slave_Busy_Counter, TProtocol_Base::u32_Slave_Exception_Error_Counter, TProtocol_Base::u32_Slave_Message_Counter, TProtocol_Base::u32_Slave_No_Acknowledge_Counter, TProtocol_Base::u32_Slave_No_Response_Counter, and TProtocol_Base::u32_Slave_Unknown_Request_Counter.

Here is the call graph for this function:

Show_System_Ready_Message_Disable()

VOID TProtocol_ANVILEX_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_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_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_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.

Terminal_Event_Information_Request()

BOOL TProtocol_ANVILEX_Over_UART::Terminal_Event_Information_Request ( )

private

Event information request in terminal mode method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None

References c8_New_Data_Buffer, enum_Event_Description, false, Hex_To_U8(), Is_Hex_Digit(), TProtocol_Base::Log_Event_Information_Request_Error(), NULL, String_Length(), TProtocol_Base::Transmit_New_Line(), TProtocol_Base::Transmit_String(), and TProtocol_Base::Transmit_U32_Value_As_Hex().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Terminal_Parameter_Information_Request()

BOOL TProtocol_ANVILEX_Over_UART::Terminal_Parameter_Information_Request ( )

private

Parameter information terminal request method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None

References c8_New_Data_Buffer, TParameter_Manager::Get_Parameter_By_Name(), Get_String_Chunk_Count(), NULL, object_Parameter_Manager, String_Length(), and TProtocol_Base::Transmit_String().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Terminal_Parameter_Read_Request()

BOOL TProtocol_ANVILEX_Over_UART::Terminal_Parameter_Read_Request ( )

private

Parameter read terminal request method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None Parameter read terminal request

References c8_New_Data_Buffer, TParameter_Manager::Get_Parameter_By_Name(), Get_String_Chunk_Count(), TConOpSys_Variant::Get_Value_As_Decimal_String(), TProtocol_Base::Log_Parameter_Read_Request_Error(), NULL, object_Parameter_Manager, TParameter_Base::Read_Value_As_Variant(), String_Length(), and TProtocol_Base::Transmit_String().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Terminal_Parameter_Write_Request()

BOOL TProtocol_ANVILEX_Over_UART::Terminal_Parameter_Write_Request ( )

private

Parameter write terminal request method.

---

Note

None

Returns

BOOL - Operation status

Return values

false	- Operation faild
true	- Operation done

Override

Not allowed

Attention

None

References c8_New_Data_Buffer, TParameter_Manager::Get_Parameter_By_Name(), Get_String_Chunk_Count(), TParameter_Base::Is_Store_To_Media_Database(), TProtocol_Base::Log_Parameter_Write_Request_Error(), TParameter_Manager::Media_Database_Update(), NULL, object_Parameter_Manager, String_Length(), TProtocol_Base::Transmit_String(), and TParameter_Base::Write_Value_As_String().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Transmit_Boot_Welcome_Message()

VOID TProtocol_ANVILEX_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_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 Execute(), and 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_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

bool_Esc

BOOL TProtocol_ANVILEX_Over_UART::bool_Esc = (BOOL)false

private

ESC code flag.

Referenced by Communication_Data_Receive().

bool_Show_System_Ready_Message_Enabled

BOOL TProtocol_ANVILEX_Over_UART::bool_Show_System_Ready_Message_Enabled = (BOOL)false

private

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_Over_UART::bool_Show_System_Welcome_Message_Enabled = (BOOL)false

private

Show system welcome message status.

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

bool_String_Recall_Request

BOOL TProtocol_ANVILEX_Over_UART::bool_String_Recall_Request = (BOOL)false

private

String recall request status.

Referenced by Communication_Data_Receive(), and Execute().

bool_String_Recalled

BOOL TProtocol_ANVILEX_Over_UART::bool_String_Recalled = (BOOL)false

private

String recalled status.

Referenced by Communication_Data_Receive(), and Execute().

bool_Terminal_Mode

BOOL TProtocol_ANVILEX_Over_UART::bool_Terminal_Mode = (BOOL)true

private

Terminal operation mode status.

Referenced by Enter_Protocol_Mode(), Enter_Terminal_Mode(), Is_Protocol_Mode(), and Is_Terminal_Mode().

c8_New_Data_Buffer

C8 TProtocol_ANVILEX_Over_UART::c8_New_Data_Buffer[ANVILEX_PROTOCOL_RX_BUFFER_SIZE]

private

New data buffer.

Referenced by Command_Execution_Request(), Execute(), Protocol_Event_Information_Request(), Protocol_Parameter_Information_Request(), Protocol_Parameter_Read_Request(), Protocol_Parameter_Write_Request(), Receive_String(), Terminal_Event_Information_Request(), Terminal_Parameter_Information_Request(), Terminal_Parameter_Read_Request(), and Terminal_Parameter_Write_Request().

c8_Receive_Buffer

C8 TProtocol_ANVILEX_Over_UART::c8_Receive_Buffer[ANVILEX_PROTOCOL_RX_BUFFER_SIZE]

private

Data receive buffer.

Referenced by Communication_Data_Receive(), Execute(), and TProtocol_ANVILEX_Over_UART().

c8_Transmit_Buffer

C8 TProtocol_ANVILEX_Over_UART::c8_Transmit_Buffer[ANVILEX_PROTOCOL_TX_BUFFER_SIZE]

private

Data transmit buffer.

Referenced by TProtocol_ANVILEX_Over_UART().

char_Instance_Derscriptor

C8 TProtocol_ANVILEX_Over_UART::char_Instance_Derscriptor = (C8)'>'

private

Communication module instance descriptor.

u32_Receive_Buffer_Index

U32 TProtocol_ANVILEX_Over_UART::u32_Receive_Buffer_Index = (U32)0

private

Receive buffer index.

Referenced by Communication_Data_Receive(), and Execute().

u8_Scan_Code

U8 TProtocol_ANVILEX_Over_UART::u8_Scan_Code = '\0'

private

Actual SCAN code.

Referenced by Communication_Data_Receive().

---

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

• ConOpSys/Engine/Protocol_ANVILEX_Over_UART.h
• ConOpSys/Engine/Protocol_ANVILEX_Over_UART.cpp