User's Guide

From TeamTalk
(Difference between revisions)
Jump to: navigation, search
(Instructions: Changed the repository location to trac. Changed build instructions.)
(Corrected size of TeamTalk repo when downloading.)
Line 54: Line 54:
 
# Install the run-time requirements as described in the [[Documentation#Run-time Requirements|Run-time Requirements]] as well as whatever developments tool may be required as described in [[Documentation#Compile-time Requirements|Compile-time Requirements]].
 
# Install the run-time requirements as described in the [[Documentation#Run-time Requirements|Run-time Requirements]] as well as whatever developments tool may be required as described in [[Documentation#Compile-time Requirements|Compile-time Requirements]].
 
# Get the following TeamTalk sources from the [http://subversion.tigris.org Subversion] repository. Ask [[User:Tkharris]] for access if needed. [http://tortoisesvn.tigris.org/ TortoiseSVN] is recommended.
 
# Get the following TeamTalk sources from the [http://subversion.tigris.org Subversion] repository. Ask [[User:Tkharris]] for access if needed. [http://tortoisesvn.tigris.org/ TortoiseSVN] is recommended.
## If you want the main development trunk checkout TeamTalk, http://trac.speech.cs.cmu.edu/repos/teamtalk/trunk/TeamTalk (~100MB), and Olympus, http://trac.speech.cs.cmu.edu/repos/olympus/trunk (~100MB), with a different folder given to each checkout.
+
## If you want the main development trunk checkout TeamTalk, http://trac.speech.cs.cmu.edu/repos/teamtalk/trunk/TeamTalk (~10MB), and Olympus, http://trac.speech.cs.cmu.edu/repos/olympus/trunk (~100MB), with a different folder given to each checkout.
 
## If you want the latest, as of 8:13 PM, Septemeber 2, 2007 (EST), semi-stable version: http://trac.speech.cs.cmu.edu/repos/teamtalk/tags/BTH-0.2/TeamTalk (~47MB) and copy the Cepstral sdk directory to ''TeamTalk\Libraries\Cepstral\sdk'' .
 
## If you want the latest, as of 8:13 PM, Septemeber 2, 2007 (EST), semi-stable version: http://trac.speech.cs.cmu.edu/repos/teamtalk/tags/BTH-0.2/TeamTalk (~47MB) and copy the Cepstral sdk directory to ''TeamTalk\Libraries\Cepstral\sdk'' .
 
# First run the Olympus build batch file ''Olympus\OlympusBuild.pl''. It will take around 4-10 min, depending on the speed of your system, for all the files to build.  
 
# First run the Olympus build batch file ''Olympus\OlympusBuild.pl''. It will take around 4-10 min, depending on the speed of your system, for all the files to build.  

Revision as of 16:23, June 3, 2008

TeamTalk consists of a set of software components that are used to interface via spoken and graphical modalities with teams of robots. This software is built using the Olympus framework. The software is currently alpha, and is not currently licensed for any kind of use.

Contents

Installation

Binary installation

Run-time Requirements

The following is a list of system requirements for running a binary version of the system. All of the following must be installed for a fully functional system.

Requirement Required By Component
Microsoft Speech API (SAPI) (Installed by default in Windows Vista and above. Kalliope uses Microsoft SAPI by default for its TTS output.
ActiveState's ActivePerl. TeamTalkNLG uses the Perl module Rosetta.
RedHat's Cygwin environment. The CMU-Cambridge SLM Toolkit language modeling software is compiled with Cygwin tools. At the very least the cygwin1.dll must be in the path. Since the dll is not normally in the path, one must either manually edit the path, or copy the dll into the %SYSTEMROOT%\win32 directory.
The Java Runtime Environment. PenDecoder, the map GUI, is written in Java.
Microsoft 2005 C++ redistributable package Probably necessary if one does not have Visual Studio .NET 2005 installed.

Instructions

Coming soon

Developer installation

Compile-time Requirements

The following table is a list of development tools that may be needed to develop the system. This list is in addition to the runtime requirements above.

Requirement Required For
A Subversion client such as TortoiseSVN. The source code is stored in a Subversion repository.
Microsoft Visual Studio .NET 2005. The AnkhSVN subversion plug-in is also recommended. Most of the components, including Helios3, Kalliope, Audio Server, Sphinx Engine, NLGServer2, Phoenix2, PrimitiveComm, Ravenclaw, TeamTalkBackend, and TeamTalkDM are all developed in this development environment.
Microsoft Speech SDK 5.1 or Better (Version 5.3 is Included with the Windows Vista Platform SDK) Required to compile Kalliope Text to Speech.
Sun's Java SDK and Netbeans IDE 6.0. These are required for editing and compiling the PenDecoder.

Instructions

  1. Install the run-time requirements as described in the Run-time Requirements as well as whatever developments tool may be required as described in Compile-time Requirements.
  2. Get the following TeamTalk sources from the Subversion repository. Ask User:Tkharris for access if needed. TortoiseSVN is recommended.
    1. If you want the main development trunk checkout TeamTalk, http://trac.speech.cs.cmu.edu/repos/teamtalk/trunk/TeamTalk (~10MB), and Olympus, http://trac.speech.cs.cmu.edu/repos/olympus/trunk (~100MB), with a different folder given to each checkout.
    2. If you want the latest, as of 8:13 PM, Septemeber 2, 2007 (EST), semi-stable version: http://trac.speech.cs.cmu.edu/repos/teamtalk/tags/BTH-0.2/TeamTalk (~47MB) and copy the Cepstral sdk directory to TeamTalk\Libraries\Cepstral\sdk .
  3. First run the Olympus build batch file Olympus\OlympusBuild.pl. It will take around 4-10 min, depending on the speed of your system, for all the files to build.
  4. Run the TeamTalk build batch file, TeamTalk\SystemBuild.pl. It will take around 4-10 min, depending on the speed of your system, for all the files to build. If you get errors and you have already run the OlypusBuild.bat file you may need to restart your computer and then run TeamTalkBuild.bat again.

Configuration

TeamTalk has a consolidated configuration file that described the robots that it needs to interface with. The file must be created before running the system. To do this, copy the plain-text file TeamTalk\Configurations\DesktopConfiguration\peerfile-example.txt to TeamTalk\Configurations\DesktopConfiguration\peerfile.txt. Edit the latter file to match your robot configuration.

The file consists of lines of the form

robotname ipaddress[:portnumber] voicename safe/dangerous

or

optrader ipaddress optrading_robotname

or

mapserver ipaddress

The robot portnumber is optional and defaults to 32788. Lines that start with a # are comments.

Here's an example:

#current local test
alphie 127.0.0.1:32788 callie safe
bashful 127.0.0.1:32787 david dangerous
optrader 127.0.0.1 alphie
mapserver 127.0.0.1

This example states that there are two robots, but running on localhost at the specified ports. An optrader server is also running on the localhost, alphie is the optrading robot, and a mapserver is running on 192.168.99.105. The optrading robot is a holdover that no longer has any meaning. At one time the optrading robot was the robot whose coordinate frame was used as the global coordinate frame. Never-the-less an optrading robot must still be supplied to the configuration, and it must be set to one of the operational robots.

Run-time Environments

Real Robots in the Field

TeamTalk has been used with Pioneer P2DX's[1] and Segway RMP's[2] outfitted as BoeingLib servers.

Simulations

TeamTalk is an interface to robots. For times when robots are not handy, and for testing the interface itself, two simulators have been developed, a low fidelity simulator and a high fidelity simulator.

Low-Fidelity Simulator

This simulator simulates a group of robots who operate without sensors and with no coherent world model. They hallucinate a static map, but are not bound to unobstructed areas. This simulator is mostly useful for simple and quick testing of the front-end.

First, one must supply a configuration that specifies robots running on the local host. The configuration example in Configuration specifies two robots, an optrader, and a mapserver all running on localhost. From the TeamTalk\Configurations\DesktopConfiguration directory, run:

..\..\Agents\TeamTalkBackend\backendstub\Release\backendstub.exe --peerfile peerfile.txt --mapserver

High-Fidelity Simulator

The High-Fidelity Simulator is a system that works with TeamTalk as a set of virtual Boeing Treasure Hunt configured MOAST robots running in a USARSim theater.

Starting the System

Make sure that either a set of real or simulated robots are running, and that a valid configuration corresponding to those robots exists.

  1. Bootstrap a language model using MakeLM. This only needs to be done once, before the first time that the system is launched. When you compile the system using TeamTalkBuild.bat or TeamTalkRebuild.bat, this will be done automatically for you.
  2. To run the full virtual TeamTalk system, in the TeamTalk directory run:
      TeamTalkVirtualRun.bat
    

    To run the non-virtual TeamTalk system, in the TeamTalk directory run:

      TeamTalkRun.bat
    
    It may be useful to create a shortcut to this. The first time it runs you may need to unblock a number of programs.
  3. Once the GUI has been launched, press the Start Session button. The robots should introduce themselves.

Use

Main article: Use Reference
Main article: Mock demo

TeamTalk is a graphical and spoken language interface for teams of heterogeneous robots. The target scenario is a treasure-hunt scenario in which people and robots work together in the field looking for some specified treasure. The people interact with each other as well as with the robots. It has been designed so that a person carrying a small tablet and wearing a headset attached to that tablet can view the status of the robots and their conception of the environment on the tablet, and may also direct the robots via speech and/or through tablet-pen gestures.

Development

Main article: Development

TeamTalk software should be considered to be in an alpha state. It is under development.

Personal tools