VRUIDDTEST
Section: FreeVR Commands (1fv)
Updated: 21 August 2013
Index
Return to Main Contents
NAME
vruiddtest
— test the setup of a Vrui VR device daemon server.
SYNOPSIS
vruiddtest [-nodata] [-once | -1] [-screen] [-p <port>] [-protocol <protocol>] [<hostname>]
DESCRIPTION
The vruiddtest program is used to interface with the Vrui VRDeviceDaemon
server, which in turn communicates with any number of input devices and aggregates
the data into a single input stream.
The vruiddtest program can be used to determine how many inputs are
being served by the daemon, and if there are virtual devices (protocol-3 only),
then it will list each device with it's details.
devices and provide
Once communication is established, unless the -nodata option is
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 allows communication to be established with the
server, report all the details that are received, including any potential
virtual device information, and then close the communication and quit.
- -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.
- -p <port number> | -port <port number>
-
The -p option allows one to specify which port on the server the
Vrui VRDeviceDaemon is listening for client requests. The usual default
value is 8555, but this may be overriden with the VRUIDD_PORT
environment variable (below).
- -protocol <protocol number> | -prot <protocol number>
-
The -protocol option allows one to specify with which of the
Vrui VRDeviceDaemon protocols to communicate with the server.
By sending a protocol number to the VRDeviceDaemon, it will generally
acknowledge this and ajdust what protocol is will communication with.
However, the original protocol (what we will refer to as protocol-0)
does not have this acknowledgement sequence. To accomodate this,
vruiddtest will shift from protocol-0 to protocol-1 if it
fails to connect to the server within 5 attempts.
In general, Vrui library versions have adopted new protocols when the
major version number changes:
Vrui Version | Protocol
|
|
1.x | 0*
|
2.x | 1
|
3.x | 2
|
|
* The protocol for Vrui 1.x was not specifically assigned a protocol
number, so for the purpose of interfacing with various versions of Vrui,
we have deFacto chosen to refer to this as protocol-0.
The default is to use protocol-0, which will shift to protocol-1 if
unable to connect.
ARGUMENTS
- [<hostname>]
-
The <hostname> optional argument is the name of IP address of the
computer which is hosting the Vrui VRDeviceDaemon. The usual default
value is localhost, but this may be overridden with the
VRUIDD_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.
- VRUIDD_HOST
-
Set the default value for what hostname (or IP address) to communicate
with to connect to the Vrui VRDeviceDaemon.
- VRUIDD_PORT
-
Set the default value for what port number to communicate over when
connecting to the Vrui VRDeviceDaemon.
- VRUIDD_PROTOCOL
-
Set the default value for what protocol to use for communicating
with Vrui VRDeviceDaemon.
EXAMPLES
- Establish a connection, report information and quit.
-
% vruiddtest -nodata
- Report inputs from the computer "vruiserver.indiana.edu":
-
% vruiddtest vruiserver.indiana.edu
- Set the default protocol be "2" and report events:
-
% setenv VRUIDD_PROTOCOL 2
% vruiddtest
SEE ALSO
vrpntest(1fv),
dtracktest(1fv),
joytest(1fv),
eviotest(1fv),
fobtest(1fv),
freevr(7fv)
LOCATION
The source code for vruiddtest is in the "vr_input.vruidd.c" file,
which also handles the vruidd input interface to the FreeVR library.
COPYRIGHT
Copyright 2021, Bill Sherman, All rights reserved.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- ARGUMENTS
-
- ENVIRONMENT VARIABLES
-
- EXAMPLES
-
- SEE ALSO
-
- LOCATION
-
- COPYRIGHT
-
This document was created by
man2html,
using the manual pages.
Time: 18:37:43 GMT, May 02, 2021