VRPNTEST

NAME

vrpntest — test the setup of an input device connected via the VRPN device daemon.  

SYNOPSIS

vrpntest [-list | -nodata] [-once | -1] [-screen | -csv] [-gt | -govern_time] [-p <port>] [<host>]  

DESCRIPTION

The vrpntest program is used to interface with devices connected via the VRPN protocol via the vrpn_server program. A vrpn_server will often be configured to interface with multiple devices and will make each of these available to clients interested in obtaining data from one or more of the devices.

Once communication with the server is established, vrpntest will output information about what devices and information vrpn_server is serving. This will be followed by a stream of information about all the input activity relayed from the server — unless the -nodata switch is given.

The opening data includes a list of devices that VRPN is serving. In general the first "device" on the list will be VRPN Control, and the last "device" will be vrpn_Forwarder_Brain. All the devices between these are the actual physical devices to which vrpn_server is interfacing. This list is then followed by a list of the type of information messages that might be sent by the server to the client — not all of these will be relevant to the devices of interest.

The program can be terminated by pressing the first two buttons of any of the devices that vrpn_server is serving, or by pressing the interrupt key (usually ^C).

One of three different rendering styles can be chosen for displaying the incoming VRPN input data stream: Simple line, CSV, and Screen. The default rendering style is the Simple line-by-line output that prints out whatever information is passed, as it is parsed. The CSV (comma-separated value) rendering style outputs the data more compactly, and in a way that is more machine readable for post processing, such as for plotting tracking data. The Screen rendering style uses screen controls to output the data for each 6-dof position tracker in a column with moving characters that reflect the current status of the device. Other areas of the screen show the current states of all the button and valuator inputs.

OPTIONS

-list or -nodata

The -list (or -nodata) establishes the connection with the vrpn_server application, reports the devices and messages servered, and then terminates. (I.e. it does not report any actual I/O data.)

-1 or -once

Only output a single packet of data from VRPN and then terminate.

-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 VRPN server.

-csv     Use the csv rendering output method which outputs information in a machine-readable / database-style format with all the information in a comma-separated value layout.

-gt or -govern_time

Use the -gt (or -govern_time) activates the feature of vrpntest that regulates the rate of output of the data based on the value of the embedded timestamp with the data such that it matches the flow of real time. Without this option, vrpntest will output data as fast as it is received.

-p or -port

The -p option allows one to use a non-standard port for communicating the the VRPN server. Note that VRPN has an officially assigned port number of 3883 by the Internet Assigned Numbers Authority (IANA) (as of October, 2003). Therefore, it will be unusual to require a port number other than the default.

The value used when no "-p" is given will first be that of the VRPN_PORT environment variable, or when that is unassigned the standard default value of 3883 will be used.

ARGUMENTS

[<host>]

The <host> argument is the host that is running the vrpn_server serving information on the devices of interest. If it is not specified on the command line, the value of the VRPN_HOST environment variable will be used, or localhost if the environment variables is not assigned.

ENVIRONMENT VARIABLES

VRPN_HOST

Set the name of the computer which is running the vrpn_server application. is provided.

VRPN_PORT

Set the port number at which the vrpn_server application is listening for new client connections.

EXAMPLES

List all VRPN I/O devices and messages served by the "localhost" on the standard VRPN port (3883):

% vrpntest -list

Report inputs from the VRPN server on host "cave.university.edu" (assuming VRPN is configured to use the standard port):

% vrpntest cave.university.edu

Report inputs from VRPN server host "caravaggio" on non-standard port 5000:

% vrpntest -p 5000 carravaggio

Report inputs on the localhost (default) on the standard port in the psuedo-graphical screen format:

% vrpntest -screen

Report inputs on the localhost (default) on the standard port:

% vrpntest

Using environment variables to alter the defaults (so they don't have to be entered on the command line each time):

% setenv VRPN_HOST "carravaggio"
% setenv VRPN_PORT 5000
% vrpntest

TODO

•

Determine how the "VRPN Control" and "vrpn_Forwarder_Brain" pseduo-devices can be reported about.

•

It would be nice to manipulate device force feedback events.

•

Consider adding the ability to report unknown I/O messages.

SEE ALSO

joytest(1fv), eviotest(1fv), vruiddtest(1fv), dtracktest(1fv), fobtest(1fv), freevr(7fv)

The VRPN web site:

http://www.cs.unc.edu/Research/vrpn

LOCATION

The source code for vrpntest is in the "vr_input.vrpn.c" file, which also handles the VRPN input interface to the FreeVR library.

To build vrpntest, use the simple command:

% make vrpntest

COPYRIGHT

Copyright 2024, Bill Sherman, All rights reserved.

Index

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

ARGUMENTS

ENVIRONMENT VARIABLES

EXAMPLES

TODO

SEE ALSO

LOCATION

COPYRIGHT