|FreeVR: Virtual Reality Integration Library|
INTROSection: FreeVR Commands (1FV)
Updated: 27 November 2013
Index Return to Main Contents
Section 1 of the FreeVR manual describes user commands and tools such as sample virtual reality applications, input device test programs and utilities to reverse engineer serial and socket protocols. Combined, these programs are useful for setting up, configuring and even operating a virtual reality system.
NOTESFreeVR is an open-source application programming interface (API) for interfacing with virtual reality (VR) input/output hardware. FreeVR applications are not written for any particular VR display, but conform to any individual system at run-time based on a flexible configuration specification.
ApplicationsTwo virtual reality applications are included with the FreeVR distribution: "travel" and "inputs.
The "travel" application is a mostly constant world filled with colorful boxes and pyramids. A single white-pyramid has been placed in the virtual world, and thus allows the user to travel relative to that one object using the joystick. All the other objects are placed in the real-world (and therefore don't actually travel), but are positioned in strategically interesting locations for testing inside a CAVE or other virtual reality display.
The "inputs" application simply gives a live presentation of all the inputs received by the configured virtual reality system. This alone has great value, but "inputs" also serves well as an input server/repeater.
UtilitiesTwo utilities designed to evaluate communications between input and other devices either through serial port or socket connections are the serialspy and socketspy tools respectively. Communications are represented in hexadecimal and ASCII output to help decipher the, frequently unique, protocols. Each tool has its own manpage.
Three other utilities are "cave2fvr", "fvri.tcl", and "ipcrms". The "cave2fvr" program converts old-style CAVE configuration files into FreeVR configuration files. The "fvri.tcl" program interfaces with running FreeVR applications to analyze and optionally modify the parameters of the application. The "ipcrms" program is used to clean up left-over shared memory segments when an application undergoing development crashes and leaves behind unused segments.
Test programsEach FreeVR input type has an associated "test" application that can be used to verify a working connection with the inputs (both for input devices and input daemons). Each input testing tool has its own manpage. There are also test programs for specific areas of FreeVR operation.
inputs(1FV), travel(1FV), joytest(1FV), eviotest(1FV), vrpntest(1FV), vruiddtest(1FV), fobtest(1FV), freevrrc(5FV) freevr(7FV)
Additional documentation is available at the FreeVR web site:
Here is the most current citation to use when citing FreeVR:
Copyright 2013, Bill Sherman, All rights reserved.
This document was created by man2html, using the manual pages.
Time: 05:02:19 GMT, December 13, 2013