Sophie: player-doc-3.0.2-5.fc14 noarch

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>sicklms400<br/>
<small>
[<a class="el" href="group__drivers.html">Drivers</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>SICK LMS 400 laser range-finder.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>SICK LMS 400 laser range-finder. </p>
<p>The sicklms400 driver controls the SICK LMS 400 scanning laser range-finder.</p>
<dl class="user"><dt><b>Compile-time dependencies</b></dt><dd></dd></dl>
<ul>
<li>none</li>
</ul>
<dl class="user"><dt><b>Provides</b></dt><dd></dd></dl>
<ul>
<li><a class="el" href="group__interface__laser.html">laser</a></li>
</ul>
<dl class="user"><dt><b>Requires</b></dt><dd></dd></dl>
<ul>
<li>none</li>
</ul>
<dl class="user"><dt><b>Configuration requests</b></dt><dd></dd></dl>
<ul>
<li>PLAYER_LASER_REQ_GET_CONFIG</li>
<li>PLAYER_LASER_REQ_GET_GEOM</li>
<li>PLAYER_LASER_REQ_GET_ID</li>
<li>PLAYER_LASER_REQ_SET_CONFIG</li>
<li>PLAYER_LASER_REQ_SET_FILTER</li>
</ul>
<dl class="user"><dt><b>Configuration file options</b></dt><dd></dd></dl>
<ul>
<li>hostname (string)<ul>
<li>Default: "192.168.0.1"</li>
<li>IP address of the SICK LMS 400 (Ethernet version)</li>
</ul>
</li>
</ul>
<ul>
<li>port (integer)<ul>
<li>Default: 2111</li>
<li>TCP port of the SICK LMS 400 (Ethernet version)</li>
</ul>
</li>
</ul>
<ul>
<li>filter (integer)<ul>
<li>Default: 0 (disabled)</li>
<li>Filter settings. Valid values are:<ul>
<li>0 (disabled)</li>
<li>1 (enable median filter)</li>
<li>2 (enable edge filter)</li>
<li>4 (enable range filter)</li>
<li>8 (enable mean filter)</li>
</ul>
</li>
<li>Notes :<ul>
<li>1) You can combine the filters as required. If several filters are active, then the filters act one after the other on the result of the previous filter. The processing in this case follows the following sequence: edge filter, median filter, range filter, mean filter.</li>
<li>2) You can use PLAYER_LASER_REQ_SET_FILTER to enable/disable the filters as well as set their parameters from the client. The parameters of the filters are stored in a float array in the sequence mentioned above. Since the current LMS400 firmware version (1.20) supports setting the parameters for the range and mean filters, the order of the parameters in the (player_laser_set_filter_config_t - float parameters[]) array, provided that both range and mean are enabled is: [BottomLimit TopLimit Mean]</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>range_filter_parameters (float tuple)<ul>
<li>Default: [700.0 3000.0] (BottomLimit TopLimit)</li>
<li>Define a specific range within which measured values are valid and are output. Possible values: [+700.0...+3000.0 &lt;bottom limit&gt;=""&gt;...+3000.0]</li>
</ul>
</li>
</ul>
<ul>
<li>mean_filter_parameter (integer)<ul>
<li>Default: 2.</li>
<li>Define the number of means for the mean filter. Possible values: 2..200.</li>
</ul>
</li>
</ul>
<ul>
<li>angular_resolution (float)<ul>
<li>Default: 0.25 degrees</li>
<li>Angular resolution. Valid values are: 0.1 ..1 (with 0.1 degree increments)</li>
</ul>
</li>
</ul>
<ul>
<li>scanning_frequency (float)<ul>
<li>Default: 500 Hz.</li>
<li>Scanning frequency. Valid values are:<ul>
<li>200..500Hz (on the LMS400-0000)</li>
<li>360..500Hz (on the LMS400-1000)</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>min_angle (float)<ul>
<li>Default: 55 degrees.</li>
<li>Defines the minimum angle of the laser unit (where the scan should start). Valid values: 55-124 degrees.</li>
</ul>
</li>
</ul>
<ul>
<li>max_angle (float)<ul>
<li>Default: 125 degrees.</li>
<li>Defines the maximum angle of the laser unit (where the scan should end). Valid values: [min_angle]-125 degrees.</li>
</ul>
</li>
</ul>
<ul>
<li>pose (length tuple)<ul>
<li>Default: [0.0 0.0 0.0]</li>
<li>Pose (x,y,theta) of the laser, relative to its parent object (e.g., the robot to which the laser is attached).</li>
</ul>
</li>
</ul>
<ul>
<li>size (length tuple)<ul>
<li>Default: [0.15 0.15]</li>
<li>Footprint (x,y) of the laser.</li>
</ul>
</li>
</ul>
<ul>
<li>enable_eRIS (integer)<ul>
<li>Default: 1</li>
<li>Enable extended RIS detectivity. If you want to measure objects with remission values &lt; 10%, you can extend the so-called Remission Information System (RIS) on the LMS4000.</li>
</ul>
</li>
</ul>
<ul>
<li>password (string)<ul>
<li>Default: servicelevel/81BE23AA</li>
<li>Service (userlevel 3) password. Used for enabling/disabling and/or setting the filter parameters.</li>
</ul>
</li>
</ul>
<ul>
<li>debug (int)<ul>
<li>Default: 0</li>
<li>Enable debugging mode (read/writes to the device are printed on screen). Valid values: 0 (disabled), 1 (enabled for standard messages), 2 (enabled for all messages including measurements - warning: this slows down your throughoutput date!).</li>
</ul>
</li>
</ul>
<dl class="user"><dt><b>Example</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">
driver
(
  name "sicklms400"
  provides ["laser:0"]
  hostname "192.168.0.1"
  port 2111

  # Enable median, range and mean filter
  filter 13
  # Set the range filter parameters to 800...2000mm
  range_filter_parameters [800.0 2900.0]
  # Set the mean filter parameter
  mean_filter_parameter 3

  # Set the angular resolution (0.1 degrees) and scanning frequency (360Hz)
  angular_resolution 10
  scanning_frequency 360

  # Userlevel 3 password (hashed). Default: servicelevel/81BE23AA
  password "81BE23AA"
)
</pre></div><dl class="author"><dt><b>Author:</b></dt><dd>Nico Blodow and Radu Bogdan Rusu </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>