ConOpSys V2970  P004.07
ANVILEX control operating system
Protocol_ANVILEX_Over_UART.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file Protocol_ANVILEX_Over_UART.h
3 //! @brief Communication protocol ANVILEX over UART class header file.
4 //! @attention No special attention requered.
5 //! @copyright (C) 2015-2020 ANVILEX LLC
6 //! $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/Protocol_ANVILEX_Over_UART.h $
7 //! $Revision: 2849 $
8 //! $Date: 2021-08-20 12:37:56 +0500 (Fr, 20 Aug 2021) $
9 //! $Author: ggavrituhin $
10 //------------------------------------------------------------------------------
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are met:
14 //
15 // 1. Redistributions of source code must retain the above copyright notice,
16 // this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright notice,
19 // this list of conditions and the following disclaimer in the documentation
20 // and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of ANVILEX nor the names of its contributors may be
23 // used to endorse or promote products derived from this software without
24 // specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
30 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 // POSSIBILITY OF SUCH DAMAGE.
37 //
38 //------------------------------------------------------------------------------
39 
40 #pragma once
41 
42 //------------------------------------------------------------------------------
43 // Include system files
44 //------------------------------------------------------------------------------
45 
46 #include "Protocol_Base.h"
47 #include "ConOpSys_Variant.h"
48 
49 //------------------------------------------------------------------------------
50 
51 #define ANVILEX_PROTOCOL_RX_BUFFER_SIZE ( (U32)0x080 )
52 #define ANVILEX_PROTOCOL_TX_BUFFER_SIZE ( (U32)0x100 )
53 
54 //------------------------------------------------------------------------------
55 // Class definitions
56 //------------------------------------------------------------------------------
57 
58 //! @brief Communication protocol ANVILEX over UART class
60 {
61 
62  //----------------------------------------------------------------------------
63  // Public defines, methods and variables
64  //----------------------------------------------------------------------------
65 
66  public:
67 
68  //--------------------------------------------------------------------------
69  // Public defines
70  //--------------------------------------------------------------------------
71 
72  //! @brief Parameter property index definitions
73  typedef enum
74  {
75 
76  //! @brief Parameter ID property code
77  enum_ID = 1,
78 
79  //! @brief Struct propertes property code
81 
82  //! @brief Element count property code
84 
85  //! @brief Minimum value property code
87 
88  //! @brief Maximum value property code
90 
91  //! @brief Default value property code
93 
94  //! @brief Parameter name property code
95  enum_Name = 7,
96 
97  //! @brief Parameter group property code
99 
100  //! @brief Parameter description property code
102 
103  //! @brief Parameter unit property code
104  enum_Unit = 10
105 
107 
108  // Event property index definitions
109  typedef enum
110  {
111 
113 
115 
116  typedef enum
117  {
118 
119  //! @brief Sucess related code
120  enum_Ok = 0x00000000,
121 
122  //! @brief Invalid frame format related code
124 
125  //! @brief Invalid frame CRC related code
127 
128  //! @brief Not implemented related code
129  enum_Not_Implemented = 0x00000003,
130 
131  //! @brief unknown error related code
132  enum_Unknown_Error = 0x00000004,
133 
134  //! @brief parameter not fount related code
136 
137  //! @brief parameter property not found related code
139 
140  //! @brief parameter non readable related code
142 
143  //! @brief parameter non writable related code
145 
146  //! @brief parameter access denied related code
148 
149  //! @brief parameter value out of bounds related code
151 
152  //! @brief parameter write failure related code
154 
155  //! @brief event not found related code
156  enum_Event_Not_Found = 0x0000000C,
157 
158  //! @brief event property not found related code
159  enum_Event_Property_Not_Found = 0x0000000D
160 
162 
163  //--------------------------------------------------------------------------
164  // Public methods
165  //--------------------------------------------------------------------------
166 
167  //!-------------------------------------------------------------------------
168  //! @brief Class constructor method.
169  //! @note None
170  //! \par Override
171  //! Not allowed
172  //! @attention Don't call this method directly.
173  //--------------------------------------------------------------------------
174 
176 
177  //!-------------------------------------------------------------------------
178  //! @brief Base class constructor method.
179  //! @note None
180  //! \par Override
181  //! Not allowed
182  //! @attention Don't call this method directly.
183  //--------------------------------------------------------------------------
184 
186 
187  //!-------------------------------------------------------------------------
188  //! @brief Object initialisation method.
189  //! @note None
190  //! @return None
191  //! \par Override
192  //! Not allowed
193  //! @attention None
194  //--------------------------------------------------------------------------
195 
196  VOID Init();
197 
198  //!-------------------------------------------------------------------------
199  //! @brief Method sends actual driver information over specified communication link protocol.
200  //! @note None
201  //! @param [in] *object_Protocol - Pointer to the connunication link protocol
202  //! @return None
203  //! \par Override
204  //! Not allowed
205  //! @attention None
206  //--------------------------------------------------------------------------
207 
208  virtual VOID Send_Information( TProtocol_Base *object_Protocol );
209 
210  //!-------------------------------------------------------------------------
211  //! @brief Enter in terminal operation mode method.
212  //! @note None
213  //! @return None
214  //! \par Override
215  //! Not allowed
216  //! @attention None
217  //--------------------------------------------------------------------------
218 
219  virtual VOID Enter_Terminal_Mode();
220 
221  //!-------------------------------------------------------------------------
222  //! @brief Enter in protocol operation mode method.
223  //! @note None
224  //! @return None
225  //! \par Override
226  //! Not allowed
227  //! @attention None
228  //--------------------------------------------------------------------------
229 
230  virtual VOID Enter_Protocol_Mode();
231 
232  //!-------------------------------------------------------------------------
233  //! @brief Return terminal operation mode status method.
234  //! @note None
235  //! @return BOOL - Protocol operatuin mode status
236  //! @retval false - Non-terminal mode selected
237  //! @retval true - Terminal mode selected
238  //! \par Override
239  //! Not allowed
240  //! @attention None
241  //--------------------------------------------------------------------------
242 
243  virtual BOOL Is_Terminal_Mode();
244 
245  //!-------------------------------------------------------------------------
246  //! @brief Return protocol operatuin mode status method.
247  //! @note None
248  //! @return BOOL - Protocol operatuin mode status
249  //! @retval false - Non-protocol mode selected
250  //! @retval true - Protocol mode selected
251  //! \par Override
252  //! Not allowed
253  //! @attention None
254  //--------------------------------------------------------------------------
255 
256  virtual BOOL Is_Protocol_Mode();
257 
258  //!-------------------------------------------------------------------------
259  //! @brief Enable show system welcome message method.
260  //! @note None
261  //! @return None
262  //! \par Override
263  //! Not allowed
264  //! @attention None
265  //--------------------------------------------------------------------------
266 
268 
269  //!-------------------------------------------------------------------------
270  //! @brief Disable show system welcome message method.
271  //! @note None
272  //! @return None
273  //! \par Override
274  //! Not allowed
275  //! @attention None
276  //--------------------------------------------------------------------------
277 
279 
280  //!-------------------------------------------------------------------------
281  //! @brief Enable system ready message method.
282  //! @note None
283  //! @return None
284  //! \par Override
285  //! Not allowed
286  //! @attention None
287  //--------------------------------------------------------------------------
288 
290 
291  //!-------------------------------------------------------------------------
292  //! @brief Disable system ready message method.
293  //! @note None
294  //! @return None
295  //! \par Override
296  //! Not allowed
297  //! @attention None
298  //--------------------------------------------------------------------------
299 
301 
302  //!-------------------------------------------------------------------------
303  //! @brief Communication data receive method
304  //! @note None
305  //! @param [in] u8_Receive_Value - Received value
306  //! @return None
307  //! \par Override
308  //! Requered
309  //! @attention None
310  //--------------------------------------------------------------------------
311 
312  virtual VOID Communication_Data_Receive( U8 u8_Receive_Value );
313 
314  //!-------------------------------------------------------------------------
315  //! @brief Communication data receive method
316  //! @note None
317  //! @param [in] void_Receive_Data - Pointer on received data
318  //! @return None
319  //! \par Override
320  //! Requered
321  //! @attention None
322  //--------------------------------------------------------------------------
323 
324  virtual VOID Communication_Data_Receive( VOID *void_Receive_Data );
325 
326  //!-------------------------------------------------------------------------
327  //! @brief Receiveed string processing method
328  //! @note None
329  //! @param [in] *c8_String - Pointer to the null terminated string
330  //! @return None
331  //! \par Override
332  //! Not allowed
333  //! @attention This method called from interrupt
334  //--------------------------------------------------------------------------
335 
336  virtual VOID Receive_String( C8 *c8_String );
337 
338  //!-------------------------------------------------------------------------
339  //! @brief Receiveed string processing method
340  //! @note This method is not used in this object.
341  //! @param [in] *c8_String - Pointer to the null terminated string
342  //! @param [in] u32_Length - Length of the string
343  //! @return None
344  //! \par Override
345  //! Not allowed
346  //! @attention This method called from interrupt
347  //--------------------------------------------------------------------------
348 
349  virtual VOID Receive_String( C8 *c8_String, U32 u32_Length );
350 
351  //!-------------------------------------------------------------------------
352  //! @brief Transmit prompt in terminal mode method
353  //! @note None
354  //! @return None
355  //! \par Override
356  //! Not allowed
357  //! @attention This method called from interrupt
358  //--------------------------------------------------------------------------
359 
361 
362  //!-------------------------------------------------------------------------
363  //! @brief Transmit boot welcome message method
364  //! @note None
365  //! @return None
366  //! \par Override
367  //! Not allowed
368  //! @attention This method called from interrupt
369  //--------------------------------------------------------------------------
370 
372 
373  //!-------------------------------------------------------------------------
374  //! @brief Transmit boot ready message method.
375  //! @note None
376  //! @return None
377  //! \par Override
378  //! Not allowed
379  //! @attention None
380  //--------------------------------------------------------------------------
381 
383 
384  //!-------------------------------------------------------------------------
385  //! @brief Protocol execution method.
386  //! @note None
387  //! @return None
388  //! \par Override
389  //! Not allowed
390  //! @attention None
391  //--------------------------------------------------------------------------
392 
393  virtual VOID Execute();
394 
395  //!-------------------------------------------------------------------------
396  //! @brief Profile execution method.
397  //! @note None
398  //! @return None
399  //! \par Override
400  //! Not allowed
401  //! @attention None
402  //--------------------------------------------------------------------------
403 
404  virtual VOID Execute_Profile();
405 
406  //----------------------------------------------------------------------------
407  // Protected defines, methods and variables
408  //----------------------------------------------------------------------------
409 
410  protected:
411 
412  //----------------------------------------------------------------------------
413  // Private defines, methods and variables
414  //----------------------------------------------------------------------------
415 
416  private:
417 
418  //--------------------------------------------------------------------------
419  // Private methods
420  //--------------------------------------------------------------------------
421 
422  //!-------------------------------------------------------------------------
423  //! @brief Parameter information terminal request method.
424  //! @note None
425  //! @return BOOL - Operation status
426  //! @retval false - Operation faild
427  //! @retval true - Operation done
428  //! \par Override
429  //! Not allowed
430  //! @attention None
431  //--------------------------------------------------------------------------
432 
434 
435  //!-------------------------------------------------------------------------
436  //! @brief Parameter information protocol request method.
437  //! @note None
438  //! @return BOOL - Operation status
439  //! @retval false - Operation faild
440  //! @retval true - Operation done
441  //! \par Override
442  //! Not allowed
443  //! @attention None
444  //--------------------------------------------------------------------------
445 
447 
448  //!-------------------------------------------------------------------------
449  //! @brief Parameter read terminal request method.
450  //! @note None
451  //! @return BOOL - Operation status
452  //! @retval false - Operation faild
453  //! @retval true - Operation done
454  //! \par Override
455  //! Not allowed
456  //! @attention None
457  //--------------------------------------------------------------------------
458 
459  BOOL Terminal_Parameter_Read_Request(); //!< Parameter read terminal request
460 
461  //!-------------------------------------------------------------------------
462  //! @brief Parameter read protocol request method.
463  //! @note None
464  //! @return BOOL - Operation status
465  //! @retval false - Operation faild
466  //! @retval true - Operation done
467  //! \par Override
468  //! Not allowed
469  //! @attention None
470  //--------------------------------------------------------------------------
471 
473 
474  //!-------------------------------------------------------------------------
475  //! @brief Parameter write terminal request method.
476  //! @note None
477  //! @return BOOL - Operation status
478  //! @retval false - Operation faild
479  //! @retval true - Operation done
480  //! \par Override
481  //! Not allowed
482  //! @attention None
483  //--------------------------------------------------------------------------
484 
486 
487  //!-------------------------------------------------------------------------
488  //! @brief Parameter write protocol request method.
489  //! @note None
490  //! @return BOOL - Operation status
491  //! @retval false - Operation faild
492  //! @retval true - Operation done
493  //! \par Override
494  //! Not allowed
495  //! @attention None
496  //--------------------------------------------------------------------------
497 
499 
500  //!-------------------------------------------------------------------------
501  //! @brief Command execution request method.
502  //! @note None
503  //! @return None
504  //! \par Override
505  //! Not allowed
506  //! @attention None
507  //--------------------------------------------------------------------------
508 
510 
511  //!-------------------------------------------------------------------------
512  //! @brief Event information request in terminal mode method.
513  //! @note None
514  //! @return BOOL - Operation status
515  //! @retval false - Operation faild
516  //! @retval true - Operation done
517  //! \par Override
518  //! Not allowed
519  //! @attention None
520  //--------------------------------------------------------------------------
521 
523 
524  //!-------------------------------------------------------------------------
525  //! @brief Event information request in protocol mode method.
526  //! @note None
527  //! @return BOOL - Operation status
528  //! @retval false - Operation faild
529  //! @retval true - Operation done
530  //! \par Override
531  //! Not allowed
532  //! @attention None
533  //--------------------------------------------------------------------------
534 
536 
537  //!-------------------------------------------------------------------------
538  //! @brief Transmit error code method.
539  //! @note None
540  //! @return None
541  //! \par Override
542  //! Not allowed
543  //! @attention None
544  //--------------------------------------------------------------------------
545 
547 
548  //!-------------------------------------------------------------------------
549  //! @brief Transmit variant value method.
550  //! @note None
551  //! @return None
552  //! \par Override
553  //! Not allowed
554  //! @attention None
555  //--------------------------------------------------------------------------
556 
558 
559  //!-------------------------------------------------------------------------
560  //! @brief Transmit U32 value method.
561  //! @note None
562  //! @return None
563  //! \par Override
564  //! Not allowed
565  //! @attention None
566  //--------------------------------------------------------------------------
567 
568  VOID Protocol_Transmit_U32_Value( U32 u32_Value );
569 
570  //!-------------------------------------------------------------------------
571  //! @brief Transmit null terminated string method.
572  //! @note None
573  //! @return None
574  //! \par Override
575  //! Not allowed
576  //! @attention None
577  //--------------------------------------------------------------------------
578 
579  VOID Protocol_Transmit_String( C8 *c8_String );
580 
581  //--------------------------------------------------------------------------
582  // Private variables
583  //--------------------------------------------------------------------------
584 
585  //! @brief Communication module instance descriptor
587 
588  //! @brief Terminal operation mode status
590 
591  //! @brief Show system welcome message status
593 
594  //! @brief Show system ready message status
596 
597  //! @brief Receive buffer index
599 
600  //! @brief Data receive buffer
602 
603  //! @brief Data transmit buffer
605 
606  //! @brief New data buffer
608 
609  //! @brief ESC code flag
610  BOOL bool_Esc = (BOOL)false;
611 
612  //! @brief Actual SCAN code
613  U8 u8_Scan_Code = '\0';
614 
615  //! @brief String recall request status
617 
618  //! @brief String recalled status
620 
621 };
622 
623 //------------------------------------------------------------------------------
624 // End of file
625 //------------------------------------------------------------------------------
ConOpSys variant class header file.
int BOOL
Boolean datatype definition.
Definition: Defines.h:124
unsigned char U8
Binary 8-Bit unsigned integer datatype defenition.
Definition: Defines.h:183
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
unsigned long U32
Binary 32-Bit unsigned integer datatype defenition.
Definition: Defines.h:203
char C8
ASCII 8-Bit char datatype defenition.
Definition: Defines.h:156
#define ANVILEX_PROTOCOL_TX_BUFFER_SIZE
Definition: Protocol_ANVILEX_Over_UART.h:52
#define ANVILEX_PROTOCOL_RX_BUFFER_SIZE
Definition: Protocol_ANVILEX_Over_UART.h:51
Communication protocol base class header file.
ConOpSys variant class.
Definition: ConOpSys_Variant.h:851
Communication protocol ANVILEX over UART class.
Definition: Protocol_ANVILEX_Over_UART.h:60
virtual VOID Send_Information(TProtocol_Base *object_Protocol)
Method sends actual driver information over specified communication link protocol.
Definition: Protocol_ANVILEX_Over_UART.cpp:3636
TProtocol_Return_Code
Definition: Protocol_ANVILEX_Over_UART.h:117
@ enum_Parameter_Non_Readable
parameter non readable related code
Definition: Protocol_ANVILEX_Over_UART.h:141
@ enum_Not_Implemented
Not implemented related code.
Definition: Protocol_ANVILEX_Over_UART.h:129
@ enum_Parameter_Non_Writable
parameter non writable related code
Definition: Protocol_ANVILEX_Over_UART.h:144
@ enum_Invalid_Frame_Format
Invalid frame format related code.
Definition: Protocol_ANVILEX_Over_UART.h:123
@ enum_Parameter_Not_Found
parameter not fount related code
Definition: Protocol_ANVILEX_Over_UART.h:135
@ enum_Ok
Sucess related code.
Definition: Protocol_ANVILEX_Over_UART.h:120
@ enum_Event_Property_Not_Found
event property not found related code
Definition: Protocol_ANVILEX_Over_UART.h:159
@ enum_Parameter_Access_Denied
parameter access denied related code
Definition: Protocol_ANVILEX_Over_UART.h:147
@ enum_Parameter_Value_Out_Of_Bounds
parameter value out of bounds related code
Definition: Protocol_ANVILEX_Over_UART.h:150
@ enum_Parameter_Write_Failure
parameter write failure related code
Definition: Protocol_ANVILEX_Over_UART.h:153
@ enum_Unknown_Error
unknown error related code
Definition: Protocol_ANVILEX_Over_UART.h:132
@ enum_Invalid_Frame_CRC
Invalid frame CRC related code.
Definition: Protocol_ANVILEX_Over_UART.h:126
@ enum_Parameter_Property_Not_Found
parameter property not found related code
Definition: Protocol_ANVILEX_Over_UART.h:138
@ enum_Event_Not_Found
event not found related code
Definition: Protocol_ANVILEX_Over_UART.h:156
U32 u32_Receive_Buffer_Index
Receive buffer index.
Definition: Protocol_ANVILEX_Over_UART.h:598
VOID Show_System_Ready_Message_Enable()
Enable system ready message method.
Definition: Protocol_ANVILEX_Over_UART.cpp:189
BOOL Protocol_Parameter_Information_Request()
Parameter information protocol request method.
Definition: Protocol_ANVILEX_Over_UART.cpp:1265
virtual VOID Enter_Protocol_Mode()
Enter in protocol operation mode method.
Definition: Protocol_ANVILEX_Over_UART.cpp:129
virtual VOID Communication_Data_Receive(U8 u8_Receive_Value)
Communication data receive method.
Definition: Protocol_ANVILEX_Over_UART.cpp:213
U8 u8_Scan_Code
Actual SCAN code.
Definition: Protocol_ANVILEX_Over_UART.h:613
virtual VOID Execute()
Protocol execution method.
Definition: Protocol_ANVILEX_Over_UART.cpp:680
BOOL Terminal_Event_Information_Request()
Event information request in terminal mode method.
Definition: Protocol_ANVILEX_Over_UART.cpp:2936
BOOL bool_Terminal_Mode
Terminal operation mode status.
Definition: Protocol_ANVILEX_Over_UART.h:589
C8 c8_New_Data_Buffer[ANVILEX_PROTOCOL_RX_BUFFER_SIZE]
New data buffer.
Definition: Protocol_ANVILEX_Over_UART.h:607
TEvent_Property_Index
Definition: Protocol_ANVILEX_Over_UART.h:110
@ enum_Event_Description
Definition: Protocol_ANVILEX_Over_UART.h:112
VOID Protocol_Transmit_String(C8 *c8_String)
Transmit null terminated string method.
Definition: Protocol_ANVILEX_Over_UART.cpp:3517
BOOL Protocol_Parameter_Write_Request()
Parameter write protocol request method.
Definition: Protocol_ANVILEX_Over_UART.cpp:2476
BOOL Terminal_Parameter_Write_Request()
Parameter write terminal request method.
Definition: Protocol_ANVILEX_Over_UART.cpp:2299
VOID Show_System_Welcome_Message_Enable()
Enable show system welcome message method.
Definition: Protocol_ANVILEX_Over_UART.cpp:165
BOOL Protocol_Parameter_Read_Request()
Parameter read protocol request method.
Definition: Protocol_ANVILEX_Over_UART.cpp:1934
TProtocol_ANVILEX_Over_UART()
Class constructor method.
Definition: Protocol_ANVILEX_Over_UART.cpp:69
VOID Protocol_Transmit_Variant_Value(TConOpSys_Variant *object_Value)
Transmit variant value method.
Definition: Protocol_ANVILEX_Over_UART.cpp:3442
VOID Transmit_System_Ready_Message()
Transmit boot ready message method.
Definition: Protocol_ANVILEX_Over_UART.cpp:616
C8 char_Instance_Derscriptor
Communication module instance descriptor.
Definition: Protocol_ANVILEX_Over_UART.h:586
virtual VOID Receive_String(C8 *c8_String)
Receiveed string processing method.
Definition: Protocol_ANVILEX_Over_UART.cpp:521
BOOL bool_Esc
ESC code flag.
Definition: Protocol_ANVILEX_Over_UART.h:610
BOOL Terminal_Parameter_Information_Request()
Parameter information terminal request method.
Definition: Protocol_ANVILEX_Over_UART.cpp:1067
virtual VOID Enter_Terminal_Mode()
Enter in terminal operation mode method.
Definition: Protocol_ANVILEX_Over_UART.cpp:117
BOOL Terminal_Parameter_Read_Request()
Parameter read terminal request method.
Definition: Protocol_ANVILEX_Over_UART.cpp:1734
BOOL bool_String_Recalled
String recalled status.
Definition: Protocol_ANVILEX_Over_UART.h:619
C8 c8_Receive_Buffer[ANVILEX_PROTOCOL_RX_BUFFER_SIZE]
Data receive buffer.
Definition: Protocol_ANVILEX_Over_UART.h:601
VOID Command_Execution_Request()
Command execution request method.
Definition: Protocol_ANVILEX_Over_UART.cpp:3557
BOOL bool_Show_System_Welcome_Message_Enabled
Show system welcome message status.
Definition: Protocol_ANVILEX_Over_UART.h:592
C8 c8_Transmit_Buffer[ANVILEX_PROTOCOL_TX_BUFFER_SIZE]
Data transmit buffer.
Definition: Protocol_ANVILEX_Over_UART.h:604
~TProtocol_ANVILEX_Over_UART()
Base class constructor method.
Definition: Protocol_ANVILEX_Over_UART.cpp:82
VOID Transmit_Boot_Welcome_Message()
Transmit boot welcome message method.
Definition: Protocol_ANVILEX_Over_UART.cpp:571
VOID Show_System_Welcome_Message_Disable()
Disable show system welcome message method.
Definition: Protocol_ANVILEX_Over_UART.cpp:177
VOID Protocol_Transmit_Error_Code(TProtocol_Return_Code enum_Return_Code)
Transmit error code method.
Definition: Protocol_ANVILEX_Over_UART.cpp:3408
VOID Init()
Object initialisation method.
Definition: Protocol_ANVILEX_Over_UART.cpp:90
VOID Protocol_Transmit_U32_Value(U32 u32_Value)
Transmit U32 value method.
Definition: Protocol_ANVILEX_Over_UART.cpp:3482
BOOL bool_String_Recall_Request
String recall request status.
Definition: Protocol_ANVILEX_Over_UART.h:616
BOOL bool_Show_System_Ready_Message_Enabled
Show system ready message status.
Definition: Protocol_ANVILEX_Over_UART.h:595
virtual BOOL Is_Terminal_Mode()
Return terminal operation mode status method.
Definition: Protocol_ANVILEX_Over_UART.cpp:141
BOOL Protocol_Event_Information_Request()
Event information request in protocol mode method.
Definition: Protocol_ANVILEX_Over_UART.cpp:3154
virtual VOID Execute_Profile()
Profile execution method.
Definition: Protocol_ANVILEX_Over_UART.cpp:3624
TParameter_Property_Index
Parameter property index definitions.
Definition: Protocol_ANVILEX_Over_UART.h:74
@ enum_Group
Parameter group property code.
Definition: Protocol_ANVILEX_Over_UART.h:98
@ enum_Unit
Parameter unit property code.
Definition: Protocol_ANVILEX_Over_UART.h:104
@ enum_Description
Parameter description property code.
Definition: Protocol_ANVILEX_Over_UART.h:101
@ enum_ID
Parameter ID property code.
Definition: Protocol_ANVILEX_Over_UART.h:77
@ enum_Properties
Struct propertes property code.
Definition: Protocol_ANVILEX_Over_UART.h:80
@ enum_Maximum_Value
Maximum value property code.
Definition: Protocol_ANVILEX_Over_UART.h:89
@ enum_Minimum_Value
Minimum value property code.
Definition: Protocol_ANVILEX_Over_UART.h:86
@ enum_Element_Count
Element count property code.
Definition: Protocol_ANVILEX_Over_UART.h:83
@ enum_Default_Value
Default value property code.
Definition: Protocol_ANVILEX_Over_UART.h:92
@ enum_Name
Parameter name property code.
Definition: Protocol_ANVILEX_Over_UART.h:95
VOID Show_System_Ready_Message_Disable()
Disable system ready message method.
Definition: Protocol_ANVILEX_Over_UART.cpp:201
VOID Transmit_Prompt()
Transmit prompt in terminal mode method.
Definition: Protocol_ANVILEX_Over_UART.cpp:668
virtual BOOL Is_Protocol_Mode()
Return protocol operatuin mode status method.
Definition: Protocol_ANVILEX_Over_UART.cpp:153
Definition: Protocol_Base.h:57