-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass_command_line.html
529 lines (492 loc) · 24.1 KB
/
class_command_line.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CommandLine: CommandLine Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CommandLine
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_command_line-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CommandLine Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <CommandLine.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a19e464a73a137b268044e076a22d43f8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#a19e464a73a137b268044e076a22d43f8">CommandLine</a> (Stream &serial)</td></tr>
<tr class="separator:a19e464a73a137b268044e076a22d43f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a866735cd6acf26b765208273aa47bfef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#a866735cd6acf26b765208273aa47bfef">CommandLine</a> (Stream &serial, bool <a class="el" href="class_command_line.html#aa45fb55b4c3b5d11b4bc2292d27959e4">echoEnable</a>)</td></tr>
<tr class="separator:a866735cd6acf26b765208273aa47bfef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa2e7c5254078c0b9b87bb35d3057a59"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#aaa2e7c5254078c0b9b87bb35d3057a59">CrLfCommand</a> (bool <a class="el" href="class_command_line.html#a31c561071a3dde32b767e61754f1e9fe">crLfcmdEnable</a>)</td></tr>
<tr class="separator:aaa2e7c5254078c0b9b87bb35d3057a59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c89a8feb2ef35c3d3faf9ea3d7a3e5e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#a4c89a8feb2ef35c3d3faf9ea3d7a3e5e">CrLfEcho</a> (bool <a class="el" href="class_command_line.html#a8f8a73026c8f4ec6bd59aa74f00d2445">crLfechoEnable</a>)</td></tr>
<tr class="separator:a4c89a8feb2ef35c3d3faf9ea3d7a3e5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54ed9ee74d7aa4a4a494d23e600b8b92"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#a54ed9ee74d7aa4a4a494d23e600b8b92">Delimiter</a> (char delimiter)</td></tr>
<tr class="separator:a54ed9ee74d7aa4a4a494d23e600b8b92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37a45155309437e7dd2a151739a43a7d"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#a37a45155309437e7dd2a151739a43a7d">DoCmdLine</a> (void)</td></tr>
<tr class="separator:a37a45155309437e7dd2a151739a43a7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adfc7268bb816a9afccb84d451af27e64"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#adfc7268bb816a9afccb84d451af27e64">Echo</a> (bool <a class="el" href="class_command_line.html#aa45fb55b4c3b5d11b4bc2292d27959e4">echoEnable</a>)</td></tr>
<tr class="separator:adfc7268bb816a9afccb84d451af27e64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a357db1d426ac4c2302056dc3cfbf9c19"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#a357db1d426ac4c2302056dc3cfbf9c19">FlushReceive</a> (void)</td></tr>
<tr class="separator:a357db1d426ac4c2302056dc3cfbf9c19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4a3853bfe8a06e5adbbd4d5ba4e3ff7"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#ac4a3853bfe8a06e5adbbd4d5ba4e3ff7">ParseParam</a> (char *param, int32_t *retval)</td></tr>
<tr class="separator:ac4a3853bfe8a06e5adbbd4d5ba4e3ff7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24ded8a4fb8ea13c769333396025c5ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#a24ded8a4fb8ea13c769333396025c5ed">SetCustomErrorHandler</a> (<a class="el" href="_command_line_8h.html#ac02ed5e9ebc4351641336772d63e4cfa">pfnCustomErrs</a> function)</td></tr>
<tr class="separator:a24ded8a4fb8ea13c769333396025c5ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab177fb89cbb33f7380aad708f8b8d269"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#ab177fb89cbb33f7380aad708f8b8d269">SetDefaultHandler</a> (<a class="el" href="_command_line_8h.html#a5ceeba5a502c8dab64f2efc6c1bf7603">pfnCmdLine</a> function)</td></tr>
<tr class="separator:ab177fb89cbb33f7380aad708f8b8d269"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7a906d66a0ba81e3d08a8ddb79f8eff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#ae7a906d66a0ba81e3d08a8ddb79f8eff">ShowCommands</a> (bool help_info_disable=false)</td></tr>
<tr class="separator:ae7a906d66a0ba81e3d08a8ddb79f8eff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeecad0dae70ecb65ae0f5d01e41291b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_command_line.html#aeecad0dae70ecb65ae0f5d01e41291b6">Terminators</a> (char *terminators)</td></tr>
<tr class="separator:aeecad0dae70ecb65ae0f5d01e41291b6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>CommandLine Arduino library class. Version: "V1.10 7/7/2023" </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a19e464a73a137b268044e076a22d43f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19e464a73a137b268044e076a22d43f8">◆ </a></span>CommandLine() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CommandLine::CommandLine </td>
<td>(</td>
<td class="paramtype">Stream & </td>
<td class="paramname"><em>serial</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A constructor that sets up the command line processing code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">serial</td><td>the stream that a command line is implemented on (typically 'Serial')</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Defaults to enable echo of incoming characters. </dd></dl>
</div>
</div>
<a id="a866735cd6acf26b765208273aa47bfef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a866735cd6acf26b765208273aa47bfef">◆ </a></span>CommandLine() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CommandLine::CommandLine </td>
<td>(</td>
<td class="paramtype">Stream & </td>
<td class="paramname"><em>serial</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>echoEnable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A constructor that sets up the command line processing code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">serial</td><td>the stream that a command line is implemented on (typically 'Serial') </td></tr>
<tr><td class="paramname">echoEnable</td><td>a flag that is used to enable/disable echo of incoming characters (<em>true</em> = enable echo, <em>false</em> = disable echo)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaa2e7c5254078c0b9b87bb35d3057a59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa2e7c5254078c0b9b87bb35d3057a59">◆ </a></span>CrLfCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::CrLfCommand </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>crLfcmdEnable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables/disables sending CR/LF characters before processing command (default is enabled).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">crLfcmdEnable</td><td>a flag that is used to enable/disable sending CR/LF characters before processing a command (<em>true</em> = enable CR/LF response, <em>false</em> = disable CR/LF response) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4c89a8feb2ef35c3d3faf9ea3d7a3e5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c89a8feb2ef35c3d3faf9ea3d7a3e5e">◆ </a></span>CrLfEcho()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::CrLfEcho </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>crLfechoEnable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables/disables echo of incoming CR/LF characters (default is disabled).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">crLfechoEnable</td><td>a flag that is used to enable/disable echo of incoming CR/LF characters (<em>true</em> = enable echo, <em>false</em> = disable echo)</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This has no effect if <a class="el" href="class_command_line.html#adfc7268bb816a9afccb84d451af27e64">Echo()</a> is disabled. </dd></dl>
</div>
</div>
<a id="a54ed9ee74d7aa4a4a494d23e600b8b92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54ed9ee74d7aa4a4a494d23e600b8b92">◆ </a></span>Delimiter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::Delimiter </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"><em>delimiter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the parameter separator character to use (if other than the default space ' ').</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delimiter</td><td>the delimiter (or parameter separator) character </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a37a45155309437e7dd2a151739a43a7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37a45155309437e7dd2a151739a43a7d">◆ </a></span>DoCmdLine()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t CommandLine::DoCmdLine </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements the non-blocking serial command processing.</p>
<dl class="section return"><dt>Returns</dt><dd>int8_t </dd>
<dd>
0 = no command to process yet </dd>
<dd>
1 = a command was processed</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This should be called in <em>'loop()'</em> to check for/process incoming commands. </dd></dl>
</div>
</div>
<a id="adfc7268bb816a9afccb84d451af27e64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfc7268bb816a9afccb84d451af27e64">◆ </a></span>Echo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::Echo </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>echoEnable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables/disables echo of incoming characters (default is enabled).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">echoEnable</td><td>a flag that is used to enable/disable echo of incoming characters (<em>true</em> = enable echo, <em>false</em> = disable echo)</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>CR/LF will not be echoed if <a class="el" href="class_command_line.html#adfc7268bb816a9afccb84d451af27e64">Echo()</a> is enabled and <a class="el" href="class_command_line.html#a4c89a8feb2ef35c3d3faf9ea3d7a3e5e">CrLfEcho()</a> is disabled. </dd></dl>
</div>
</div>
<a id="a357db1d426ac4c2302056dc3cfbf9c19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a357db1d426ac4c2302056dc3cfbf9c19">◆ </a></span>FlushReceive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CommandLine::FlushReceive </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush the serial receive buffer. </p>
</div>
</div>
<a id="ac4a3853bfe8a06e5adbbd4d5ba4e3ff7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4a3853bfe8a06e5adbbd4d5ba4e3ff7">◆ </a></span>ParseParam()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t CommandLine::ParseParam </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>retval</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Support routine that parses a command parameter string into a decimal or hex numeric value or identifies it as a quoted string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter string to parse </td></tr>
<tr><td class="paramname">retval</td><td>place for parsed numeric value (if type DECVAL or HEXVAL)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>type of parameter </dd>
<dd>
- DECVAL = decimal numeric parameter value (1234) - value returned at *retval </dd>
<dd>
- HEXVAL = hex numeric parameter value (0x12ab) - value returned at *retval </dd>
<dd>
- STRVAL = string parameter value ("quoted string") </dd>
<dd>
- BADPARAM = bad parameter</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The command line processor (<b>CmdLineProcess()</b>) does <em>not</em> keep the contents of a quoted string intact. Each word in the string (a space is considered a word delimiter - TABs are not) is placed in a separate argument! (The argument with the first word in the quoted string contains the opening quote and the argument with the last word in the quoted string contains the closing quote.) </dd></dl>
</div>
</div>
<a id="a24ded8a4fb8ea13c769333396025c5ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24ded8a4fb8ea13c769333396025c5ed">◆ </a></span>SetCustomErrorHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::SetCustomErrorHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_command_line_8h.html#ac02ed5e9ebc4351641336772d63e4cfa">pfnCustomErrs</a> </td>
<td class="paramname"><em>function</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the custom handler function to use for commands errors (default is internal).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">function</td><td>the custom handler function for commands errors </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab177fb89cbb33f7380aad708f8b8d269"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab177fb89cbb33f7380aad708f8b8d269">◆ </a></span>SetDefaultHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::SetDefaultHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_command_line_8h.html#a5ceeba5a502c8dab64f2efc6c1bf7603">pfnCmdLine</a> </td>
<td class="paramname"><em>function</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the custom handler function to use for unknown commands (i.e. commands not in command table) (default is none).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">function</td><td>the handler function for unknown commands </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae7a906d66a0ba81e3d08a8ddb79f8eff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7a906d66a0ba81e3d08a8ddb79f8eff">◆ </a></span>ShowCommands()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::ShowCommands </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>help_info_disable</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows the menu commands.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">help_info_disable</td><td>optional flag to disable (if <em>true</em>) showing help information (default = false) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeecad0dae70ecb65ae0f5d01e41291b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeecad0dae70ecb65ae0f5d01e41291b6">◆ </a></span>Terminators()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CommandLine::Terminators </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>terminators</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the parameter separator character(s) to use (if other than the default '\r').</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">terminators</td><td>the command line terminator character(s) to use (2 maximum supported) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a31c561071a3dde32b767e61754f1e9fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31c561071a3dde32b767e61754f1e9fe">◆ </a></span>crLfcmdEnable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CommandLine::crLfcmdEnable</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8f8a73026c8f4ec6bd59aa74f00d2445"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f8a73026c8f4ec6bd59aa74f00d2445">◆ </a></span>crLfechoEnable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CommandLine::crLfechoEnable</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa45fb55b4c3b5d11b4bc2292d27959e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa45fb55b4c3b5d11b4bc2292d27959e4">◆ </a></span>echoEnable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CommandLine::echoEnable</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a278624566be8b7de957d8fff11a06a40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a278624566be8b7de957d8fff11a06a40">◆ </a></span>g_cCmdBuf</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char CommandLine::g_cCmdBuf[<a class="el" href="_command_line_8h.html#a8427d0088582c17327e754f5f08c5a56">CMD_BUF_SIZE</a>]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7b87c11b68b12ef8f2c08665b8382b3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b87c11b68b12ef8f2c08665b8382b3e">◆ </a></span>index</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t CommandLine::index</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_command_line_8h.html">CommandLine.h</a></li>
<li><a class="el" href="_command_line_8cpp.html">CommandLine.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 8 2023 19:35:28 for CommandLine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>