-
Notifications
You must be signed in to change notification settings - Fork 0
/
CommandLineOptions.txt
494 lines (436 loc) · 15.5 KB
/
CommandLineOptions.txt
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
ARIA 2.9.4
Summary of command line options
Some classes in ARIA and ArNetworking check a program's run time options to
specify parameters and options. These options are used to configure run time
accessory device parameters (ports, speeds, etc.) used by ARIA; host names,
port numbers, etc. used by ArNetworking; and various other run time options.
Options may be given as program arguments on the command line, or globally
saved as defaults in the file /etc/Aria.args if on Linux, or in the ARIAARGS
environment variable. Arguments given on the command line may override some
internal defaults or values read from the robot parameter files.
Note, an option will be available only in programs that instantiate an
object of the class that uses it. Some programs may also check for
program-specific command line options.
Use the special "-help" command line option to cause a program to
print out its available options.
A list of options used by each class follows.
ArRobotConnector
----------------
Options for ArRobotConnector (see docs for more details):
Robot options:
-remoteHost <remoteHostNameOrIP>
-rh <remoteHostNameOrIP>
-robotPort <robotSerialPort>
-rp <robotSerialPort>
-robotBaud <baud>
-rb <baud>
-remoteRobotTcpPort <remoteRobotTcpPort>
-rrtp <remoteRobotTcpPort>
-remoteIsSim
-ris
-remoteIsNotSim
-rins
-robotLogPacketsReceived
-rlpr
-robotLogPacketsSent
-rlps
-robotLogMovementReceived
-rlmr
-robotLogMovementSent
-rlms
-robotLogVelocitiesReceived
-rlvr
-robotLogActions
-rla
ArLaserConnector
----------------
Laser types and options may also be set in the robot parameter file. See the
ARIA reference documentation for details.
If a program supports multiple lasers, then options for additional lasers
after the first are given by appending the laser number (e.g. -laserType2)
To enable use of a laser, choose its type with the -laserType<N> options
(e.g.: -laserType lms2xx -laserType2 urg2.0)
The default laser type for the primary laser (laser 1) is specified in the
robot type parameter file in the ARIA "params" directory. For many robots
it is "lms2xx", the SICK LMS200. For some it is "lms1xx", for the SICK
LMS100 or LMS111.
Instruct a program to connect to a laser using the -connectLaser<N> option
or by setting LaserAutoConnect to true in the robot's parameter file.
If a program requires use of a laser it usually always attempts to connect to
the primary laser, however.
The index number is optional in any options for the primary laser; i.e. 1 is
assumed if the index number is omitted.
For laser type "lms2xx" (SICK LMS-200):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 32000
-laserDegrees <100|180>
-ld <100|180>
-laserIncrement <half|one>
-li <half|one>
-laserUnits <1mm|1cm|10cm>
-lu <1mm|1cm|10cm>
-laserReflectorBits <1ref|2ref|3ref>
-lrb <1ref|2ref|3ref>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserStartingBaud <9600|19200|38400>
-lsb <9600|19200|38400>
-laserAutoBaud <9600|19200|38400>
-lab <9600|19200|38400>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "lms1xx" (SICK LMS-100, LMS-111, etc.):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 50000
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and 135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -135 and 135
-laserIncrement <half|quarter>
-li <half|quarter>
-laserReflectorBits <none|8bits>
-lrb <none|8bits>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "urg2.0" (URG with SCIP 2.0):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 262144
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -180 and 180
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -180 and 180
-laserIncrementByDegrees <incrementByDegrees>
-libd <incrementByDegrees>
<incrementByDegrees> is a double between 0 and 180
-laserStartingBaud <0|019200|057600|115200|250000|500000|750000>
-lsb <0|019200|057600|115200|250000|500000|750000>
-laserAutoBaud <0|019200|057600|115200|250000|500000|750000>
-lab <0|019200|057600|115200|250000|500000|750000>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "urg" (URG with old SCIP 1.0):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 4095
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and 135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -135 and 135
-laserIncrementByDegrees <incrementByDegrees>
-libd <incrementByDegrees>
<incrementByDegrees> is a double between 0 and 135
-laserStartingBaud <019200|057600|115200|250000|500000|750000>
-lsb <019200|057600|115200|250000|500000|750000>
-laserAutoBaud <019200|057600|115200|250000|500000|750000>
-lab <019200|057600|115200|250000|500000|750000>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "lms5XX" (SICK LMS-500):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 80000
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -95 and 95
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -95 and 95
-laserIncrement <half|one|quarter>
-li <half|one|quarter>
-laserReflectorBits <none|8bits>
-lrb <none|8bits>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "sZseries" (Keyence SZ):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 16382
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and -135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between 135 and 135
-laserIncrementByDegrees <incrementByDegrees>
-libd <incrementByDegrees>
<incrementByDegrees> is a double between 0.5 and 0.5
-laserPowerControlled <true|false>
-lpc <true|false>
-laserStartingBaud <9600|19200|38400|57600|115200|230400|460800>
-lsb <9600|19200|38400|57600|115200|230400|460800>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "s3series" (SICK S-300, S-3000, etc.):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 20000
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and -135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between 135 and 135
-laserIncrement <half>
-li <half>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserStartingBaud <9600|19200|38400|57600|115200|230400|460800>
-lsb <9600|19200|38400|57600|115200|230400|460800>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "tim510" or "tim3XX" (SICK TiM310 and TiM510):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 4000
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and 135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -135 and 135
-laserIncrement <three>
-li <three>
-laserReflectorBits <none|8bits>
-lrb <none|8bits>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserStartingBaud <115200>
-lsb <115200>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "tim551" (SICK TiM551):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 10000
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and 135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -135 and 135
-laserIncrement <one>
-li <one>
-laserReflectorBits <none|8bits>
-lrb <none|8bits>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "tim561" (SICK TiM561):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 10000
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and 135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -135 and 135
-laserIncrement <one>
-li <one>
-laserReflectorBits <none|8bits>
-lrb <none|8bits>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
For laser type "tim571" (SICK TiM571):
-laserPort <laserPort>
-lp <laserPort>
-laserPortType <serial|serial422|tcp>
-lpt <serial|serial422|tcp>
-remoteLaserTcpPort <remoteLaserTcpPort>
-rltp <remoteLaserTcpPort>
-laserFlipped <true|false>
-lf <true|false>
-laserMaxRange <maxRange>
-lmr <maxRange>
<maxRange> is an unsigned int less than 25000
-laserDegreesStart <startAngle>
-lds <startAngle>
<startAngle> is a double between -135 and 135
-laserDegreesEnd <endAngle>
-lde <endAngle>
<endAngle> is a double between -135 and 135
-laserIncrement <third>
-li <third>
-laserReflectorBits <none|8bits>
-lrb <none|8bits>
-laserPowerControlled <true|false>
-lpc <true|false>
-laserAdditionalIgnoreReadings <readings>
-lair <readings>
<readings> is a string that contains readings to ignore separated by commas, where ranges are acceptable with a -, example '75,76,90-100,-75,-76,-90--100'
ArPTZConnector
--------------
Common PTU and Camera PTZ options:
-ptzType <type> Select PTZ/PTU type. Required. Available types are:
dpptu
rvision
sony
vcc
vcc4
vcc50i
none
-ptzInverted <true|false> If true, reverse tilt and pan axes for cameras mounted upside down.
Only one of the following sets of connection parameters may be given:
For computer serial port connections:
-ptzSerialPort <port> Serial port name.
For Pioneer robot auxilliary serial port connections:
-ptzRobotAuxSerialPort <1|2|3> Use specified Pioneer robot auxilliary serial port.
For network connections:
-ptzAddress <address> Network address or hostname for network connection.
-ptzTcpPort <port> TCP port number for network connections.
-ptzUsername <username> Username, if camera requires it
-ptzPassword <password> Password, if camera requires it
Parameters for multiple cameras/units may be given like: -ptz1Type, -ptz2Type, -ptz3Type, etc.
Some PTZ/PTU types may accept additional type-specific options. Refer to option documentation text specific to those types.
ArGPSConnector
--------------
GPS options:
-gpsType <standard|novatel|novatelspan|trimble|sim> Select GPS device type (default: standard)
-gpsPort <gpsSerialPort> Use the given serial port (default: /dev/ttyS1)
-gpsBaud <gpsSerialBaudRate> Use the given serial Baud rate (default: 9600)
-remoteGpsTcpHost <host> Use a TCP connection instead of serial, and connect to remote host <host>
-remoteGpsTcpPort <host> Use the given port number for TCP connection, if using TCP. (default 8103)
ArCompassConnector
------------------
Compass options:
-compassType <robot|serialTCM> Select compass device type (default: robot)
-compassPort <port> Serial port for "serialTCM" type compass. (default: /dev/ttyS3)
ArSonarConnector
----------------
Options for ArSonarConnector:
-sonarLogPacketsReceived
-slpr
-sonarLogPacketsSent
-slps
Options shown are for currently set up sonars. Activate sonars with -sonarType<N> option
to see options for that sonar (e.g. "-help -sonarType1 sonarMTX").
Valid sonar types are: mtx
See docs for details.
ArBatteryConnector
------------------
Options for ArBatteryConnector:
-batteryLogPacketsReceived
-blpr
-batteryLogPacketsSent
-blps
Options shown are for currently set up batteries. Activate batteries with -batteryType<N> option
to see options for that battery (e.g. "-help -batteryType1 batteryMTX").
Valid battery types are: mtx
See docs for details.
ArLCDConnector
--------------
Options for ArLCDConnector:
-lcdLogPacketsReceived
-lcdlpr
-lcdLogPacketsSent
-lcdlps
Options shown are for currently set up lcds. Activate lcds with -lcdType<N> option
to see options for that lcd (e.g. "-help -lcdType1 lcdMTX").
Valid lcd types are: mtx
See docs for details.