Skip to content

getting_started.rst

Latest commit

 

History

History
68 lines (46 loc) · 2.7 KB

getting_started.rst

File metadata and controls

68 lines (46 loc) · 2.7 KB

Installation and Getting Started

FreemooVR is developed and tested on Ubuntu 12.04 on the amd64 architecture using NVIDIA graphics.

Installation

As the root user, in the bash command-line in Ubuntu 12.04, run :download:`this script <install-freemoovr.sh>`. (Also, you can download the latest version of this script from here.) From the command line, this should work:

curl -sL https://raw.github.com/strawlab/freemoovr/master/docs/install-freemoovr.sh | sudo bash

Getting Started

Testing the basic installation

Once FreemooVR is installed, you should be able to run a quick demo by typing:

# setup ROS environment variables
source /opt/ros/ros-freemoovr.hydro/setup.bash

# launch the demo
roslaunch freemoovr demo_display_server.launch

If that opens a graphics window showing a 3D scene, FreemooVR is installed and running properly.

Configuring a new display

The most important part of FreemooVR is the Display Server. This is the program that draws on a single display. If you need multiple physical displays, you will run multiple display servers. (A single display server can drive multiple virtual displays, as explained in the glossary.) We need to tell the Display Server about your display.

FreemooVR uses ROS to handle configuration. To bootstrap a new system, begin by copying a default configuration file into a new location:

roscd freemoovr/config cp rosparamconfig.yaml my_display.yaml

Edit this new my_display.yaml to reflect your display. Much of this YAML file should be self-explanatory. On initial setup, the most critical information is the contents of the display: key are the X windows parameters displayNum and screenNum and the window geometry parameters x, y, width, height, and windowDecoration. FreemooVR does not switch your graphics mode, so set these values such that the display server will completely utilize your display.

You can test your new configuration by creating a new ROS launch file which will load these parameters.

roscd freemoovr/launch cp demo_display_server.launch my_test.launch

Edit this new my_test.launch file and change the name of the configuration .yaml file to refer to the file you created above. Now, run this new launch file:

roslaunch freemoovr my_test.launch

The displayed window should now have the properties you specified in my_display.yaml.

Running the pinhole calibration wizard

(To be continued...)