Sophie

Sophie

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

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

<p>SICK LMS 200 / PLS laser range-finder.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>SICK LMS 200 / PLS laser range-finder. </p>
<p>The sicklms200 driver controls the SICK LMS 200 and PLS scanning laser range-finders.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>LMS200 lasers may take several seconds to start up. You may want to set the 'alwayson' option for sicklms200 to '1' in your configuration file in order start the laser when player starts. Otherwise, your client may experience a timeout in trying to subscribe to this device.</dd></dl>
<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_GEOM</li>
<li>PLAYER_LASER_REQ_GET_CONFIG</li>
<li>PLAYER_LASER_REQ_SET_CONFIG</li>
</ul>
<dl class="user"><dt><b>Configuration file options</b></dt><dd></dd></dl>
<ul>
<li>port (string)<ul>
<li>Default: "/dev/ttyS1"</li>
<li>Serial port to which laser is attached. If you are using a USB/232 or USB/422 converter, this will be "/dev/ttyUSBx".</li>
</ul>
</li>
</ul>
<ul>
<li>connect_rate (integer tuple)<ul>
<li>Ordered list of rates to be tried when establishing connection with the laser.</li>
<li>Default: [9600 38400 500000]</li>
<li>Baud rate. Valid values are 9600, 38400 (RS232 or RS422) and 500000 (RS422 only).</li>
</ul>
</li>
</ul>
<ul>
<li>transfer_rate (integer)<ul>
<li>Rate desired for data transfers, negotiated after connection</li>
<li>Default: 38400</li>
<li>Baud rate. Valid values are 9600, 38400 (RS232 or RS422) and 500000 (RS422 only).</li>
</ul>
</li>
</ul>
<ul>
<li>serial_high_speed_mode (integer)<ul>
<li>Default: 0 (FTDI)</li>
<li>Method to achieve high speed (RS422) communication 0: FTDI RS422 to USB, using Linux High Speed Serial 1: CP210x RS422 to USB (And maybe others). This chipset has the hardware remap some normal baudrate (230400 for example) to 500000, so the host machine doesn't need to know it's running at 500000 (Works on Mac OS X). 2: MOXA Multiport Serial Board CP-118EL (and probably other models) An ioctl call is used to set this card to 500000 baud</li>
</ul>
</li>
<li>serial_high_speed_baudremap (integer)<ul>
<li>Default: 38400 (Needed for FTDI)</li>
<li>The fake baud rate to use after 500Kbps is achieved. In high_speed_mode 1, this is the baud rate that the hardware is remapping.</li>
</ul>
</li>
</ul>
<ul>
<li>retry (integer)<ul>
<li>Default: 0</li>
<li>If the initial connection to the laser fails, retry this many times before giving up.</li>
</ul>
</li>
</ul>
<ul>
<li>delay (integer)<ul>
<li>Default: 0</li>
<li>Delay (in seconds) before laser is initialized (set this to 32-35 if you have a newer generation Pioneer whose laser is switched on when the serial port is open).</li>
</ul>
</li>
</ul>
<ul>
<li>resolution (integer)<ul>
<li>Default: 50</li>
<li>Angular resolution. Valid values are:<ul>
<li>resolution 50 : 0.5 degree increments, 361 readings @ 5Hz (38400) or 32Hz (500000).</li>
<li>resolution 100 : 1 degree increments, 181 readings @ 10Hz (38400) or 75Hz (500000).</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>range_res (integer)<ul>
<li>Default: 1</li>
<li>Range resolution. Valid values are:<ul>
<li>range_res 1 : 1mm precision, 8.192m max range.</li>
<li>range_res 10 : 10mm precision, 81.92m max range.</li>
<li>range_res 100 : 100mm precision, 819.2m max range.</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>invert (integer)<ul>
<li>Default: 0</li>
<li>Is the laser physically inverted (i.e., upside-down)? Is so, scan data will be reversed accordingly.</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>pls_mode (integer)<ul>
<li>Default: 0</li>
<li>set this to 1 to connect to a pls laser</li>
</ul>
</li>
</ul>
<dl class="user"><dt><b>Example</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">
#linux config
driver
(
  name "sicklms200"
  provides [ "laser:0" ]
  port "/dev/ttyUSB0"
  resolution 50
  serial_high_speed_mode 1
  serial_high_speed_baudremap 230400
  connect_rate [ 9600 500000 38400]
  transfer_rate 38400
  retry 2
  alwayson 1
)

# MAC config
driver
(
  name "sicklms200"
  provides [ "laser:0" ]
  port "/dev/cu.SLAB_USBtoUART"
  resolution 50
  serial_high_speed_mode 1
  serial_high_speed_baudremap 230400
  connect_rate [ 9600 500000 38400]
  transfer_rate 38400
  retry 2
  alwayson 1
)

#FTDI Config
driver
(
  name "sicklms200"
  provides [ "laser:0" ]
  port "/dev/ttyUSB0"
  resolution 50
  serial_high_speed_mode 0
  connect_rate [ 9600 500000 38400]
  transfer_rate 38400
  retry 2
  alwayson 1
)

</pre></div><dl class="author"><dt><b>Author:</b></dt><dd>Andrew Howard, Richard Vaughan, Kasper Stoy </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>