FreeVR: Virtual Reality Integration Library
FreeVR
Tutorials
User Guide
Programming
Functions

FreeVR

TUTORIALS

DOWNLOADS

GUIDES
    Administrator
    User
    Programming
    Function List
    Library Dev
    Socket Interface

MAN PAGES


All materials
Copyright © 2013
William R. Sherman

Manpage of VRPNTEST

VRPNTEST

Section: FreeVR Commands (1FV)
Updated: 19 September 2013
Index Return to Main Contents

 

NAME

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

SYNOPSIS

vrpntest [-list | -nodata] [-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).  

OPTIONS

-list
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.)
-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:

% 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
*
Implement a screen-rendering option
*
Consider add 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 2013, Bill Sherman, All rights reserved.


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ARGUMENTS
ENVIRONMENT VARIABLES
EXAMPLES
TODO
SEE ALSO
LOCATION
COPYRIGHT

This document was created by man2html, using the manual pages.
Time: 20:05:17 GMT, December 13, 2013