Communication protocol ANVILEX over UART class. More...
#include <Protocol_ANVILEX_Over_UART_V2.h>
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 } |
| 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_V2 () | |
| Class constructor method. More... | |
| ~TProtocol_ANVILEX_Over_UART_V2 () | |
| Class destructor method. More... | |
| VOID | Init () |
| Initialisation method. More... | |
| virtual VOID | Send_Information (TProtocol_Base *object_Protocol) |
| Send information about protocol method. More... | |
| virtual VOID | Enter_Terminal_Mode () |
| Enter in terminal operation mode. More... | |
| virtual VOID | Enter_Protocol_Mode () |
| Enter in protocol operation mode. More... | |
| virtual BOOL | Is_Terminal_Mode () |
| Return terminal operation mode status. More... | |
| virtual BOOL | Is_Protocol_Mode () |
| Rwturn protocol operatuin mode status. More... | |
| VOID | Show_System_Welcome_Message_Enable () |
| Enable show system welcome message. More... | |
| VOID | Show_System_Welcome_Message_Disable () |
| Disable show system welcome message. More... | |
| VOID | Show_System_Ready_Message_Enable () |
| Enable system ready message. More... | |
| VOID | Show_System_Ready_Message_Disable () |
| Disable system ready message. 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... | |
| VOID | Transmit_Prompt () |
| Transmit prompt in terminal mode. More... | |
| VOID | Transmit_Boot_Welcome_Message () |
| Transmit boot welcome message method. More... | |
| VOID | Transmit_System_Ready_Message () |
| Transmit system ready message method. More... | |
| virtual VOID | Execute () |
| Background cyclic execution method. More... | |
| U32 | Get_Request_Data_Length () |
 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... | |
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
◆ TParameter_Property_Index
◆ TProtocol_Return_Code
Constructor & Destructor Documentation
◆ TProtocol_ANVILEX_Over_UART_V2()
| TProtocol_ANVILEX_Over_UART_V2::TProtocol_ANVILEX_Over_UART_V2 | ( | ) |
Class constructor method.
References ANVILEX_PROTOCOL_RX_BUFFER_SIZE, ANVILEX_PROTOCOL_TX_BUFFER_SIZE, bool_Esc, bool_Show_System_Ready_Message_Enabled, bool_Show_System_Welcome_Message_Enabled, bool_String_Recall_Request, bool_String_Recalled, bool_Terminal_Mode, c8_Receive_Buffer, c8_Transmit_Buffer, char_Instance_Derscriptor, u32_Receive_Buffer_Index, and u8_Scan_Code.
◆ ~TProtocol_ANVILEX_Over_UART_V2()
| TProtocol_ANVILEX_Over_UART_V2::~TProtocol_ANVILEX_Over_UART_V2 | ( | ) |
Class destructor method.
Member Function Documentation
◆ Command_Execution_Request()
|
private |
Command execution request.
References c8_New_Data_Buffer, TCommand_Manager::Execute(), Is_Terminal_Mode(), object_Command_Manager, and TProtocol_Base::Transmit_String().
Referenced by Execute().
◆ Communication_Data_Receive() [1/2]
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.
◆ Communication_Data_Receive() [2/2]
◆ Enter_Protocol_Mode()
|
virtual |
◆ Enter_Terminal_Mode()
|
virtual |
◆ Execute()
|
virtual |
Background cyclic execution method.
- Note
- Override this method to implement protocol specific functionality.
- Returns
- None
- Override
- Optional
- Attention
- None
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(), Protocol_Event_Information_Request(), Protocol_Parameter_Information_Request(), Protocol_Parameter_Read_Request(), Protocol_Parameter_Write_Request(), 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.
◆ Get_Frame()
References ANVILEX_SLAVE_FRAME_SIZE, and c8_Frame_List.
Referenced by Protocol_Parameter_Read_Request(), and Protocol_Parameter_Write_Request().
◆ Get_Request_Data_Length()
| U32 TProtocol_ANVILEX_Over_UART_V2::Get_Request_Data_Length | ( | ) |
- Todo:
- ANVILEX KM: Move this method to anvilex library and add string verification
References ANVILEX_PROTOCOL_RX_BUFFER_SIZE, and c8_New_Data_Buffer.
Referenced by Parse_Frames_Into_Message(), Protocol_Parameter_Read_Request(), and Protocol_Parameter_Write_Request().
◆ Init()
| VOID TProtocol_ANVILEX_Over_UART_V2::Init | ( | ) |
◆ Is_Protocol_Mode()
|
virtual |
◆ Is_Terminal_Mode()
|
virtual |
Return terminal operation mode status.
Implements TProtocol_Base.
References bool_Terminal_Mode.
Referenced by Command_Execution_Request(), Communication_Data_Receive(), Execute(), and Transmit_System_Ready_Message().
◆ Parse_Frames_Into_Message()
|
private |
References ANVILEX_SLAVE_FRAME_NUMBER, ANVILEX_SLAVE_FRAME_SIZE, c8_Frame_List, c8_New_Data_Buffer, Get_Request_Data_Length(), and u8_Frame_Counter.
Referenced by Protocol_Parameter_Read_Request(), and Protocol_Parameter_Write_Request().
◆ Protocol_Event_Information_Request()
|
private |
Event information request in protocol mode.
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(), TProtocol_Base::Log_Event_Information_Request_Error(), Low_Nibble_To_Hex(), NULL, Protocol_Transmit_Error_Code(), and Protocol_Transmit_String().
Referenced by Execute().
◆ Protocol_Parameter_Information_Request()
|
private |
Parameter information protocol request.
References Bin2HexTable, 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(), TProtocol_Base::Log_Parameter_Information_Request_Error(), NULL, object_Parameter_Manager, Protocol_Transmit_Error_Code(), Protocol_Transmit_String(), Protocol_Transmit_U32_Value(), and Protocol_Transmit_Variant_Value().
Referenced by Execute().
◆ Protocol_Parameter_Read_Request()
|
private |
Parameter read protocol request.
References ANVILEX_SLAVE_FRAME_SIZE, Bin2HexTable, c8_New_Data_Buffer, enum_Invalid_Frame_Format, enum_Parameter_Not_Found, Get_Frame(), TParameter_Manager::Get_Parameter_By_ID(), Get_Request_Data_Length(), High_Nibble_To_Hex(), TProtocol_Base::Log_Parameter_Read_Request_Error(), Low_Nibble_To_Hex(), NULL, object_Parameter_Manager, Parse_Frames_Into_Message(), Protocol_Transmit_Error_Code(), Protocol_Transmit_Variant_Value(), TParameter_Base::Read_Value_As_Variant(), String_To_U32(), String_To_U8(), u32_Node_Address, u8_Frame_Counter, and u8_Package_ID.
Referenced by Execute().
◆ Protocol_Parameter_Write_Request()
|
private |
Parameter write protocol request.
References ANVILEX_SLAVE_FRAME_SIZE, Bin2HexTable, c8_New_Data_Buffer, enum_Invalid_Frame_Format, enum_Parameter_Not_Found, Get_Frame(), TParameter_Manager::Get_Parameter_By_ID(), Get_Request_Data_Length(), TParameter_Base::Get_Storage_Type(), TParameter_Base::Get_Type(), TParameter_Base::Get_Value(), High_Nibble_To_Hex(), TProtocol_Base::Log_Parameter_Read_Request_Error(), Low_Nibble_To_Hex(), NULL, object_Parameter_Manager, Parse_Frames_Into_Message(), Protocol_Transmit_Error_Code(), Protocol_Transmit_Variant_Value(), TConOpSys_Variant::Set_Type(), String_To_U32(), String_To_U8(), u32_Node_Address, u8_Frame_Counter, u8_Package_ID, and TParameter_Base::Write_Value_As_Hex_String().
Referenced by Execute().
◆ Protocol_Transmit_Error_Code()
|
private |
Transmit error code.
References Bin2HexTable, TProtocol_Base::Transmit_Char(), and TProtocol_Base::Transmit_New_Line().
Referenced by Protocol_Event_Information_Request(), Protocol_Parameter_Information_Request(), Protocol_Parameter_Read_Request(), and Protocol_Parameter_Write_Request().
◆ Protocol_Transmit_String()
Transmit null terminated string.
References Bin2HexTable, TProtocol_Base::Transmit_Char(), and TProtocol_Base::Transmit_New_Line().
Referenced by Protocol_Event_Information_Request(), and Protocol_Parameter_Information_Request().
◆ Protocol_Transmit_U32_Value()
Transmit U32 value.
References Bin2HexTable, TProtocol_Base::Transmit_Char(), and TProtocol_Base::Transmit_New_Line().
Referenced by Protocol_Parameter_Information_Request().
◆ Protocol_Transmit_Variant_Value() [1/2]
|
private |
Transmit variant value.
References Bin2HexTable, TConOpSys_Variant::Get_Value_As_Hex_String(), TProtocol_Base::Transmit_Char(), and TProtocol_Base::Transmit_New_Line().
Referenced by Protocol_Parameter_Information_Request(), Protocol_Parameter_Read_Request(), and Protocol_Parameter_Write_Request().
◆ Protocol_Transmit_Variant_Value() [2/2]
|
private |
Transmit variant value with node address.
References Bin2HexTable, TConOpSys_Variant::Get_Value_As_Hex_String(), TProtocol_Base::Transmit_Char(), TProtocol_Base::Transmit_New_Line(), u32_Node_Address, and u8_Package_ID.
◆ Receive_String() [1/2]
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_PROTOCOL_RX_BUFFER_SIZE, c8_New_Data_Buffer, and TProtocol_Base::New_Data_Arrived().
Referenced by Communication_Data_Receive().
◆ Receive_String() [2/2]
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.
◆ Send_Information()
|
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.
References NULL, TCommunication_Data_Link::object_Data_Link, TProtocol_Base::Transmit_String(), TProtocol_Base::Transmit_U32_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.
◆ Show_System_Ready_Message_Disable()
|
virtual |
Disable system ready message.
Implements TProtocol_Base.
References bool_Show_System_Ready_Message_Enabled.
◆ Show_System_Ready_Message_Enable()
|
virtual |
Enable system ready message.
Implements TProtocol_Base.
References bool_Show_System_Ready_Message_Enabled.
◆ Show_System_Welcome_Message_Disable()
|
virtual |
Disable show system welcome message.
Implements TProtocol_Base.
References bool_Show_System_Welcome_Message_Enabled.
◆ Show_System_Welcome_Message_Enable()
|
virtual |
Enable show system welcome message.
Implements TProtocol_Base.
References bool_Show_System_Welcome_Message_Enabled.
◆ Terminal_Event_Information_Request()
|
private |
Event information request in terminal mode.
References c8_New_Data_Buffer, enum_Event_Description, false, Hex_To_U8(), TProtocol_Base::Log_Event_Information_Request_Error(), NULL, TProtocol_Base::Transmit_New_Line(), TProtocol_Base::Transmit_String(), and TProtocol_Base::Transmit_U32_Value_As_Hex().
Referenced by Execute().
◆ Terminal_Parameter_Information_Request()
|
private |
Parameter information terminal request.
References c8_New_Data_Buffer, TParameter_Manager::Get_Parameter_By_Name(), NULL, object_Parameter_Manager, and TProtocol_Base::Transmit_String().
Referenced by Execute().
◆ Terminal_Parameter_Read_Request()
|
private |
Parameter read terminal request.
References c8_New_Data_Buffer, TParameter_Manager::Get_Parameter_By_Name(), TConOpSys_Variant::Get_Value_As_Decimal_String(), TProtocol_Base::Log_Parameter_Read_Request_Error(), NULL, object_Parameter_Manager, TParameter_Base::Read_Value_As_Variant(), and TProtocol_Base::Transmit_String().
Referenced by Execute().
◆ Terminal_Parameter_Write_Request()
|
private |
Parameter write terminal request.
References c8_New_Data_Buffer, TParameter_Manager::Get_Parameter_By_Name(), TParameter_Base::Is_Store_To_Media_Database(), TProtocol_Base::Log_Parameter_Write_Request_Error(), TParameter_Manager::Media_Database_Update(), NULL, object_Parameter_Manager, TProtocol_Base::Transmit_String(), and TParameter_Base::Write_Value_As_String().
Referenced by Execute().
◆ Transmit_Boot_Welcome_Message()
|
virtual |
Transmit boot welcome message method.
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, TProtocol_Base::Transmit_String(), TProtocol_Base::Transmit_U32_Value_As_Decimal(), and u32_Node_Address.
◆ Transmit_Prompt()
| VOID TProtocol_ANVILEX_Over_UART_V2::Transmit_Prompt | ( | ) |
Transmit prompt in terminal mode.
References TProtocol_Base::Transmit_Char().
Referenced by Execute(), and Transmit_System_Ready_Message().
◆ Transmit_System_Ready_Message()
|
virtual |
Transmit system ready message method.
Implements TProtocol_Base.
References bool_Show_System_Ready_Message_Enabled, Is_Terminal_Mode(), Transmit_Prompt(), and TProtocol_Base::Transmit_String().
Member Data Documentation
◆ bool_Esc
ESC code flag.
Referenced by Communication_Data_Receive(), and TProtocol_ANVILEX_Over_UART_V2().
◆ bool_Show_System_Ready_Message_Enabled
Show system ready message status.
Referenced by Show_System_Ready_Message_Disable(), Show_System_Ready_Message_Enable(), TProtocol_ANVILEX_Over_UART_V2(), and Transmit_System_Ready_Message().
◆ bool_Show_System_Welcome_Message_Enabled
Show system welcome message status.
Referenced by Show_System_Welcome_Message_Disable(), Show_System_Welcome_Message_Enable(), TProtocol_ANVILEX_Over_UART_V2(), and Transmit_Boot_Welcome_Message().
◆ bool_String_Recall_Request
String recall request status.
Referenced by Communication_Data_Receive(), Execute(), and TProtocol_ANVILEX_Over_UART_V2().
◆ bool_String_Recalled
String recalled status.
Referenced by Communication_Data_Receive(), Execute(), and TProtocol_ANVILEX_Over_UART_V2().
◆ bool_Terminal_Mode
Terminal operation mode status.
Referenced by Enter_Protocol_Mode(), Enter_Terminal_Mode(), Is_Protocol_Mode(), Is_Terminal_Mode(), and TProtocol_ANVILEX_Over_UART_V2().
◆ c8_Frame_List
|
private |
Frames list.
Referenced by Get_Frame(), and Parse_Frames_Into_Message().
◆ c8_New_Data_Buffer
|
private |
New data buffer.
Referenced by Command_Execution_Request(), Execute(), Get_Request_Data_Length(), Parse_Frames_Into_Message(), 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
|
private |
Data receive buffer.
Referenced by Communication_Data_Receive(), Execute(), and TProtocol_ANVILEX_Over_UART_V2().
◆ c8_Transmit_Buffer
|
private |
Data transmit buffer.
Referenced by TProtocol_ANVILEX_Over_UART_V2().
◆ char_Instance_Derscriptor
Communication module instance descriptor.
Referenced by TProtocol_ANVILEX_Over_UART_V2().
◆ u32_Node_Address
Node address.
Referenced by Protocol_Parameter_Read_Request(), Protocol_Parameter_Write_Request(), Protocol_Transmit_Variant_Value(), and Transmit_Boot_Welcome_Message().
◆ u32_Receive_Buffer_Index
Receive buffer index.
Referenced by Communication_Data_Receive(), Execute(), and TProtocol_ANVILEX_Over_UART_V2().
◆ u8_Frame_Counter
Frame counter.
Referenced by Parse_Frames_Into_Message(), Protocol_Parameter_Read_Request(), and Protocol_Parameter_Write_Request().
◆ u8_Package_ID
Package ID.
Referenced by Protocol_Parameter_Read_Request(), Protocol_Parameter_Write_Request(), and Protocol_Transmit_Variant_Value().
◆ u8_Scan_Code
Actual SCAN code.
Referenced by Communication_Data_Receive(), and TProtocol_ANVILEX_Over_UART_V2().
The documentation for this class was generated from the following files:
- ConOpSys/Engine/Protocol_ANVILEX_Over_UART_V2.h
- ConOpSys/Engine/Protocol_ANVILEX_Over_UART_V2.cpp
