Sophie

Sophie

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

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="summary">
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<h1>roomba_comm_t Struct Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="roomba_comm_t" -->
<p><a href="structroomba__comm__t-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96e8bbff5f046534354020bdc3fbd162"></a><!-- doxytag: member="roomba_comm_t::serial_port" ref="a96e8bbff5f046534354020bdc3fbd162" args="[PATH_MAX]" -->
char&nbsp;</td><td class="memItemRight" valign="bottom"><b>serial_port</b> [PATH_MAX]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5b09215d2789d95de8b31a646c7199f"></a><!-- doxytag: member="roomba_comm_t::fd" ref="aa5b09215d2789d95de8b31a646c7199f" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>fd</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42db9c58dedd08bf858ebc638eae1893"></a><!-- doxytag: member="roomba_comm_t::mode" ref="a42db9c58dedd08bf858ebc638eae1893" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>mode</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad63930f0dba40a9b377cc0b96a80a5fe"></a><!-- doxytag: member="roomba_comm_t::ox" ref="ad63930f0dba40a9b377cc0b96a80a5fe" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>ox</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa94ff9e2d31af7b9d9c082faa7614b8"></a><!-- doxytag: member="roomba_comm_t::oy" ref="aaa94ff9e2d31af7b9d9c082faa7614b8" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>oy</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a789d416b9fe74879a8f4e6c7a1a2cc32"></a><!-- doxytag: member="roomba_comm_t::oa" ref="a789d416b9fe74879a8f4e6c7a1a2cc32" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>oa</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d8f8d1e3fdfeb9a348ec5a14933217a"></a><!-- doxytag: member="roomba_comm_t::bumper_left" ref="a8d8f8d1e3fdfeb9a348ec5a14933217a" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>bumper_left</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cc6f4f877905739c2758434f0cfbd94"></a><!-- doxytag: member="roomba_comm_t::bumper_right" ref="a3cc6f4f877905739c2758434f0cfbd94" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>bumper_right</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdbd726a11043fe8de2563a8a3418cbf"></a><!-- doxytag: member="roomba_comm_t::wheeldrop_caster" ref="afdbd726a11043fe8de2563a8a3418cbf" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>wheeldrop_caster</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f11838a06902ed4cf0ae010ae5707ee"></a><!-- doxytag: member="roomba_comm_t::wheeldrop_left" ref="a4f11838a06902ed4cf0ae010ae5707ee" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>wheeldrop_left</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89fd1b8b9e651c967643dcb7a8dd3746"></a><!-- doxytag: member="roomba_comm_t::wheeldrop_right" ref="a89fd1b8b9e651c967643dcb7a8dd3746" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>wheeldrop_right</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5e7615b24f50210af8b361a83d94a33"></a><!-- doxytag: member="roomba_comm_t::wall" ref="af5e7615b24f50210af8b361a83d94a33" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>wall</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae11087687d99dcd262b24cb4d02bfba6"></a><!-- doxytag: member="roomba_comm_t::cliff_left" ref="ae11087687d99dcd262b24cb4d02bfba6" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>cliff_left</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a792b6aadaa17dd5c9a19f543ccadf73b"></a><!-- doxytag: member="roomba_comm_t::cliff_frontleft" ref="a792b6aadaa17dd5c9a19f543ccadf73b" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>cliff_frontleft</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5967777a993d57456bb67bef3a544012"></a><!-- doxytag: member="roomba_comm_t::cliff_frontright" ref="a5967777a993d57456bb67bef3a544012" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>cliff_frontright</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada1508b01678a50e704e0799b8158674"></a><!-- doxytag: member="roomba_comm_t::cliff_right" ref="ada1508b01678a50e704e0799b8158674" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>cliff_right</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b4372efe0836fdb78d6381fd86828cc"></a><!-- doxytag: member="roomba_comm_t::virtual_wall" ref="a2b4372efe0836fdb78d6381fd86828cc" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>virtual_wall</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae109a242c300146930a744dde3d45333"></a><!-- doxytag: member="roomba_comm_t::overcurrent_driveleft" ref="ae109a242c300146930a744dde3d45333" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>overcurrent_driveleft</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5fce48eedd3c475d2a2224dfad34449"></a><!-- doxytag: member="roomba_comm_t::overcurrent_driveright" ref="ac5fce48eedd3c475d2a2224dfad34449" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>overcurrent_driveright</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4677ef5a9e675d953da60450e68e9cdb"></a><!-- doxytag: member="roomba_comm_t::overcurrent_mainbrush" ref="a4677ef5a9e675d953da60450e68e9cdb" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>overcurrent_mainbrush</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5156f547d702dbcb6ede8b6d67031eca"></a><!-- doxytag: member="roomba_comm_t::overcurrent_sidebrush" ref="a5156f547d702dbcb6ede8b6d67031eca" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>overcurrent_sidebrush</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee7234452f6608994e32d36b1696db93"></a><!-- doxytag: member="roomba_comm_t::overcurrent_vacuum" ref="aee7234452f6608994e32d36b1696db93" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>overcurrent_vacuum</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a543859f7e95a19d39ed159351b6e2418"></a><!-- doxytag: member="roomba_comm_t::dirtdetector_right" ref="a543859f7e95a19d39ed159351b6e2418" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>dirtdetector_right</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26d62925849b0d50ef74878ec1835d32"></a><!-- doxytag: member="roomba_comm_t::dirtdetector_left" ref="a26d62925849b0d50ef74878ec1835d32" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>dirtdetector_left</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82fcc3062b639be7475f19ba6a708f6b"></a><!-- doxytag: member="roomba_comm_t::remote_opcode" ref="a82fcc3062b639be7475f19ba6a708f6b" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>remote_opcode</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1e128d25f8531583dc407301811a89c"></a><!-- doxytag: member="roomba_comm_t::button_power" ref="ae1e128d25f8531583dc407301811a89c" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>button_power</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cd4288493758c04825f99d29218ead3"></a><!-- doxytag: member="roomba_comm_t::button_spot" ref="a9cd4288493758c04825f99d29218ead3" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>button_spot</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add2380ac912d1fc902412e7a7d50e9a3"></a><!-- doxytag: member="roomba_comm_t::button_clean" ref="add2380ac912d1fc902412e7a7d50e9a3" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>button_clean</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2948fe990377b9bfb386b0671383563"></a><!-- doxytag: member="roomba_comm_t::button_max" ref="aa2948fe990377b9bfb386b0671383563" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>button_max</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab43d2723f52b29283607534218ad295"></a><!-- doxytag: member="roomba_comm_t::charging_state" ref="aab43d2723f52b29283607534218ad295" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>charging_state</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad11184e56bb7a38ee8fae3cd9e9c08bd"></a><!-- doxytag: member="roomba_comm_t::voltage" ref="ad11184e56bb7a38ee8fae3cd9e9c08bd" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>voltage</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9496cde923e0e1510aeb2c9832313531"></a><!-- doxytag: member="roomba_comm_t::current" ref="a9496cde923e0e1510aeb2c9832313531" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>current</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8281be7de0c80515ec81cdb121d5e5a5"></a><!-- doxytag: member="roomba_comm_t::temperature" ref="a8281be7de0c80515ec81cdb121d5e5a5" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>temperature</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1737984f5e3da7b416561d1bcf23276"></a><!-- doxytag: member="roomba_comm_t::charge" ref="ae1737984f5e3da7b416561d1bcf23276" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>charge</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a932e5be8bff4dbe28bb6960a08754aad"></a><!-- doxytag: member="roomba_comm_t::capacity" ref="a932e5be8bff4dbe28bb6960a08754aad" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>capacity</b></td></tr>
</table>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="roomba__comms_8h_source.html">roomba_comms.h</a></li>
</ul>
</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>