Manpage of DTRACKTEST
DTRACKTEST
Section: FreeVR Commands (1fv)
Updated: 24 February 2024
Index
Return to Main Contents
NAME
dtracktest
— test the setup of an ART DTrack device server.
SYNOPSIS
dtracktest [-screen|-csv] [-nodata|-once|-1] [-p <port>] [<DTrack server host>]
DESCRIPTION
The dtracktest program is used to interface with the
Advanced Realtime Tracking (ART) DTrack, DTrack2 or
DTrack3 device daemon.
ART Tracking systems communicate with their tracking hardware, process the
data and then serve it via socket communications.
The DTrack (and DTrack2/3) programs handle the device
interface and data servering.
The DTrack* GUI interface allows the specific data that
will be transmitted from the device to be controlled.
Features such as whether to report buttons, calibration data, or 3DoF or 6DoF
information can be specified.
The DTrack* GUI also controls coordinate system
configuration as well as the ability to Start and Stop the stream of data.
The dtracktest program establishes communication with the DTrack*
server, outputs some basic information about the communication link, and then
starts printing textual information about the information being received.
Typically this will be lines of input for each tracked constellation,
along with any button or valuator inputs from associated flystick devices.
Once communication is established, unless either the -nodata or -once
options are given
it will then report all the incoming values as they are received.
The program is terminated by pressing the interrupt key (usually ^C),
or by pressing the first two buttons on the list of buttons.
OPTIONS
- -nodata
-
The -nodata option causes the program to terminate immediately after
establishing the connection with the DTrack application and reporting
the device and messages served.
(I.e. it does not report any actual I/O data.)
- -once or -1
-
The -once (or -1) option will only output a single packet of data
from DTrack* and then terminate.
As with the -nodata option, information about the established
communication connection will also be reported — before reporting the
single data response from the server.
(This can be useful to perform a basic sanity check that the DTrack server
is fully operational.)
- -screen
-
Use the screen rendering output method which outputs information
in a text-based (pseudo-curses) GUI that "graphically" shows the inputs
values from the DTrack* server.
Location coordinates, Euler angles, and Quaternion components are represented by
the characters X, Y, Z, A, E, RfP,
i, j, k, and W.
- -csv
-
Use the CSV rendering (comma-separated values) output method which
outputs information on a line-by-line basis, similar to the default output,
but without extra descriptive information, with the assumption that the
comma-separated fields will be more easily parsed by some other computer
application.
- -p <port number> | -port <port number>
-
The -p option allows one to specify which port on the local computer the
DTrack* server is sending data to the client.
The usual default value is 5000, but this may be overridden with the
DTRACK_DATAPORT environment variable (below).
(Note: this is not to be confused with the command port.)
ARGUMENTS
- [<server host>]
-
The <server host> optional argument is the name or IP address of the
computer which is running the DTrack* application.
The default value is localhost, but this may be overridden with the
DTRACK_HOST environment variable (below).
ENVIRONMENT VARIABLES
Default values can be overridden using shell environment variables.
This allows one to continue to use the same values without entering
them on the command line each time.
- DTRACK_HOST
-
Set the default value for what hostname (or IP address) to communicate
with to connect to the DTrack* server.
- DTRACK_PORT
-
Set the default value for what port number to attempt to establish
communications with the DTrack* server.
- DTRACK_DATAPORT
-
Set the default value for what port number on which the client
(e.g. the dtracktest program itself) will be listening for input data.
NOTES
Occasionally a hung program may hold on to the DTrack communications port.
This will cause dtracktest to be unable to connect with the server.
The netstat Linux/Unix utility can often be used to discover the
offending program. The following command is thus often useful:
% netstat -nlup | grep 5000
EXAMPLES
- Establish a connection with the DTrack* server on the localhost, report connection information and quit.
-
% dtracktest -nodata
- Connect to the server and output the incoming data via "graphical" sliders.
-
% dtracktest -screen
- Connect to the server and output the a single line of incoming data in "CSV" style.
-
% dtracktest -csv -once
- Report inputs from the computer "dtrack.indiana.edu":
-
% dtracktest dtrack.indiana.edu
TODO
- •
-
Add a timeout when trying to connect to a DTrack server that isn't there
or isn't responding.
SEE ALSO
eviotest(1fv),
joytest(1fv),
vrpntest(1fv),
vruiddtest(1fv),
fobtest(1fv),
freevr(7fv)
LOCATION
The source code for dtracktest is in the "vr_input.dtrack.c" file,
which also handles the dtrack input interface to the FreeVR library.
COPYRIGHT
Copyright 2024, Bill Sherman, All rights reserved.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- ARGUMENTS
-
- ENVIRONMENT VARIABLES
-
- NOTES
-
- EXAMPLES
-
- TODO
-
- SEE ALSO
-
- LOCATION
-
- COPYRIGHT
-
This document was created by
man2html,
using the manual pages.
Time: 21:57:57 GMT, March 04, 2024