Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 827

player-doc-3.0.2-5.fc14.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">

<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->

<HEAD>


<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">

<style type="text/css">

.floatright { float: right; margin: 0 0 1em 1em; }

body {
  font-family: sans-serif;
  #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
  background-color: #FFF;
  color:#000;
}


a:link { 
	color: #A00;
}

a:visited { 
	color: #800;
}

a { text-decoration: none; }
a:hover { text-decoration: underline; }


.timestamp { text-align:right; background-color: #DDD; font-size:75%;}

h1 { 
  font-size:160%; 
}

h2 {
  font-size:110%;
  #color: #FFF;
  #background-color: #666;
  #padding:3px;
}

h3 { text-align:left; }

img {
  border: 0;
}

ul.menu { 
    position:relative;
    left:-2.5em;
    margin-bottom:0px;
    margin-top:0px;
}

ul.menu1 { 
    position:relative;
    left:-2.1em;
    margin-bottom:0px;
    margin-top:0px;
}

li.menu { 
    list-style-type: none;
    position:relative;
    #left:-0.5em;
}


#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}

#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }

div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em;  }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}

div.topbar { position: absolute; top:0px; left:9em; margin:1em; }

</style>

<TITLE>Player Manual</TITLE>

</HEAD>

<body>

<div id="sidebar"> 

<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>



<div class="box">
<div class=title>Player</div>

<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>

<div class="box">
<div class=title>User</div>

<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported&nbsp;devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client&nbsp;libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>

</ul>
</div>

<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>

<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>


</div>

<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
  <div class="headertitle">
<h1>playerjoy<br/>
<small>
[<a class="el" href="group__utils.html">Player utilities</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>Joystick control for a mobile robot.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>Joystick control for a mobile robot. </p>
<dl class="user"><dt><b>Synopsis</b></dt><dd></dd></dl>
<p>playerjoy is a console-based client that provides planar, differential-drive teleoperation of <a class="el" href="group__interface__position2d.html">position2d</a> and <a class="el" href="group__interface__position3d.html">position3d</a> devices. In other words, playerjoy allows you to manually drive your (physical or simulated) robot around. playerjoy uses velocity control, and so will only work when the underlying driver supports velocity control (most drivers do).</p>
<dl class="user"><dt><b>Usage</b></dt><dd></dd></dl>
<p>playerjoy is installed alongside player in $prefix/bin, so if player is in your PATH, then playerjoy should also be. Command-line usage is: </p>
<div class="fragment"><pre class="fragment">
$ playerjoy [options] &lt;host:port&gt; [&lt;host:port&gt;] ...
</pre></div><p> Where options can be:</p>
<ul>
<li>-v : verbose mode; print Player device state on stdout</li>
<li>-3d : connect to position3d interface (instead of position)</li>
<li>-c : continuously send commands, instead of sending commands only on change (useful with drivers with watchdog timers, like the <a class="el" href="group__driver__segwayrmp.html">segwayrmp</a>)</li>
<li>-n : dont send commands or enable motors (debugging)</li>
<li>-k : use keyboard control</li>
<li>-p : print out speeds on the console</li>
<li>-a : send car like commands (velocity and steering angle)</li>
<li>-udp : use UDP instead of TCP (deprecated, currently disabled)</li>
<li>-speed : maximum linear speed (m/sec)</li>
<li>-turnspeed : maximum angular speed (deg/sec)</li>
<li>-dev &lt;dev&gt; : Joystick device file (default /dev/js0)</li>
<li>&lt;host:port&gt; : connect to a Player on this host and port</li>
</ul>
<p>playerjoy supports both joystick and keyboard control, although joysticks are only supported in Linux. If supported, joystick control is used by default. Keyboard control will be used if: the -k option is given, or playerjoy fails to open /dev/js0 (i.e., there is no joystick).</p>
<p>Joystick control is as follows: forward/backward sets translational (x) velocity, left/right sets rotational (yaw) velocity.</p>
<p>Details of keyboard control are printed out on the console.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000045">Todo:</a></b></dt><dd>Calibrate out initial offset; should be possible by parsing the JS_EVENT_INIT message.</dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Brian Gerkey, Richard Vaughan </dd></dl>
</div>
<!-- render the modification time of the source file -->


<div class="timestamp">
<hr>

<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
          src="http://www.w3.org/Icons/valid-html401"
          alt="Valid HTML 4.01!"></a>

 <a href="http://jigsaw.w3.org/css-validator/">
  <img style="vertical-align:middle;border:0;width:88px;height:31px"
       src="http://jigsaw.w3.org/css-validator/images/vcss"
       alt="Valid CSS!">
 </a>
-->
</tr>
</table>
</div>


</tr>
</table>

</BODY>
</HTML>