Chapter 2. Quick Start

Table of Contents

Setup
Windows
Installation
Linux
RPM based distributions
Debian base distributions
Manual setup (from a tarball)
MacOs
Manual install
Evaluation mode
License setup
Urbi licensing with "webots.key" license
Urbi licensing with USB dongle
License problem
Your first run
URBI worlds
URBI controller
Send commands with a client software
Telnet
Load URBI programs at controller start
By adding the file as argument of the URBI controller
By loading the file in URBI.ini

This section describes how to setup the software on your computer and give you the basis to use URBI for Webots.

Setup

The setup process depends on your OS, please follow the corresponding instructions.

Since different packages are available for Linux, you should use the package which is designed for your distribution.

Warning: root privileges are required to install this software under Linux.

Table 2.1. Which package should I use?

Linux distributionPackage extension
RPM based distributions
  • CentOS
  • Fedora Core
  • Mandriva Linux
rpm
Debian based distributions
  • Debian GNU/Linux
  • Ubuntu
deb
Others
  • Arch Linux
  • Gentoo
  • SUSE
tarball (zip, tar.gz or tar.bz2)

Windows

Installation

To install URBI for Webots under windows, Webots must be installed on you computer. If Webots is not installed, please first proceed to Webots installation. Then double click on the "URBI Webots 1.0 Setup.exe" and follow the instructions given by the installer:

  1. The installer recommend you to close all other running applications while installing URBI for Webots. Click "Next >" to proceed to next step.

  2. Before installing URBI for Webots, you have to read and accept the Licence Agreement. Once you have read it, check "I accept the agreement" and click "Next >" to proceed to next step.

  3. The installer will automatically detect your Webots installation path and install the URBI controller, the worlds and data in the same location. For all the other files (URBI for Webots SDK and URBI for Webots Documentation) you have to provide a new location. This is what the installer is asking at this step. Choose a custom location if you don't want the default one, C:\Program Files\Gostai\URBI Webots 1.0, and click "Next >" to proceed to next step.

  4. In this step you can choose which features will be installed on your computer. Required features ("URBI Webots") cannot be unchecked. These are the URBI controller and the Urbi for Webots worlds and data. They will be installed in your Webots installation directory. Optional features are the "URBI Software Development Kit", useful if you want to develop your own UObjects and plug them in URBI, and the "URBI Documentation". Optional features will be installed in the location you provided at Step 3). Check the checkbox near the features you want to install, and click "Next >" to proceed to next step.

  5. You can customize the location where shortcuts to URBI files will be installed in you Start Menu. You can choose not to put any shortcuts just by checking "Don't create a start menu folder". Click "Next >" to proceed to next step.

  6. URBI source code files have a ".u" extension. By default the installer associate all ".u" files with URBI. If you don't want these files to be associated unckeck the corresponding checkbox. Then click "Next >" to proceed to next step.

  7. The installer prints a summary of the installation options for you to verify that it is correct. Then click "Install" to install URBI for webots on your computer.

  8. The installer display the README file. Click "Next >" to proceed to next step.

  9. You have finished to install URBI for Webots. Click "Finish" to close the installer.

Linux

RPM based distributions

rpm -hiv <package Urbi For Webots>.rpm

Debian base distributions

Execute the following command:

$ sudo dpkg --install <package Urbi For Webots>.deb

Your software is installed, you'll now have to setup the license.

Manual setup (from a tarball)

as root
$ cd /
$ tar -xvzf  <package Urbi For Webots>.tgz
or
$ cd /
$ tar -xvjf  <package Urbi For Webots>.tar.bz2

MacOs

Manual install

You have to be administrator on your machine in order to install UrbiForWebots. Extract the zip file containing URBI by double clicking on it. You obtain two folders: usr and webots. You have to copy the contains of the webots directory in the directory containing Webots installation (if you did the default installation it is in /Applications/Webots), and you have to copy the contains of the usr folder in the /usr system folder.

Let say you extracted the zip file in your Desktop folder, and that you set the variable WEBOTS_HOME to the Webots installations path as explained in Webots documentation. From a shell terminal this gives you:

    $ cd $HOME/Desktop
    $ ls
    usr webots webots-urbiengine-sdk-webots-1.03-k1462-e247-l482-powerpc-apple-darwin8-gcc-4.0.1.zip
    $ cp -r usr /
    $ cp -r webots/* $WEBOTS_HOME/