<!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 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 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="#groups">Modules</a> </div> <div class="headertitle"> <h1>Device proxies<br/> <small> [<a class="el" href="group__player__clientlib__libplayerc.html">libplayerc</a>]</small> </h1> </div> </div> <div class="contents"> <p>Each interface has a corresponding proxy. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="groups"></a> Modules</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__aio.html">aio</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The aio proxy provides an interface to the analog input/output sensors. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__actarray.html">actarray</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The actarray proxy provides an interface to actuator arrays such as the ActivMedia Pioneer Arm. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html">audio</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The audio proxy provides access to drivers supporting the audio_interface. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__blackboard.html">blackboard</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The blackboard proxy provides an interface to a simple data-store in a similar fashion to a hash-map. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__blinkenlight.html">blinkenlight</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The blinkenlight proxy provides an interface to a (possibly colored and/or blinking) indicator light. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__blobfinder.html">blobfinder</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The blobfinder proxy provides an interface to color blob detectors such as the ACTS vision system. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__bumper.html">bumper</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The bumper proxy provides an interface to the bumper sensors built into robots such as the RWI B21R. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__camera.html">camera</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The camera proxy can be used to get images from a camera. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__dio.html">dio</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The dio proxy provides an interface to the digital input/output sensors. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__fiducial.html">fiducial</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The fiducial proxy provides an interface to a fiducial detector. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__graphics2d.html">graphics2d</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The graphics2d proxy provides an interface to the graphics2d. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__graphics3d.html">graphics3d</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The graphics3d proxy provides an interface to the graphics3d. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__gripper.html">gripper</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The gripper proxy provides an interface to the gripper. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__health.html">health</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The health proxy provides an interface to the HEALTH Module. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ir.html">ir</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The ir proxy provides an interface to the ir sensors built into robots such as the RWI B21R. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__joystick.html">joystick</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The joystick proxy can be used to get images from a joystick. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__laser.html">laser</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The laser proxy provides an interface to scanning laser range finders such as the <a class="el" href="group__driver__sicklms200.html">sicklms200</a>. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__limb.html">limb</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The limb proxy provides an interface to limbs using forward/inverse kinematics, such as the ActivMedia Pioneer Arm. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__localize.html">localize</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The localize proxy provides an interface to localization drivers. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__log.html">log</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The log proxy provides start/stop control of data logging. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__map.html">map</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The map proxy provides an interface to a map. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html">vectormap</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The vectormap proxy provides an interface to a map of geometric features. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__opaque.html">opaque</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The opaque proxy provides an interface for generic messages to drivers. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html">planner</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The planner proxy provides an interface to a 2D motion planner. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__position1d.html">position1d</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The position1d proxy provides an interface to 1 DOF actuator such as a linear or rotational actuator. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__position2d.html">position2d</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The position2d proxy provides an interface to a mobile robot base, such as the ActiveMedia Pioneer series. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__position3d.html">position3d</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The position3d proxy provides an interface to a mobile robot base, such as the Segway RMP series. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__power.html">power</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The power proxy provides an interface through which battery levels can be monitored. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html">ptz</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The ptz proxy provides an interface to pan-tilt units such as the Sony PTZ camera. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ranger.html">ranger</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The ranger proxy provides an interface to ranger sensor devices. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__sonar.html">sonar</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The sonar proxy provides an interface to the sonar range sensors built into robots such as the ActiveMedia Pioneer series. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__wifi.html">wifi</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The wifi proxy is used to query the state of a wireless network. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html">simulation</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The simulation proxy is used to interact with objects in a simulation. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__speech.html">speech</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The speech proxy provides an interface to a speech synthesis system. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__speech__recognition.html">speech recognition</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The speech recognition proxy provides an interface to a speech recognition system. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__rfid.html">rfid</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The rfid proxy provides an interface to a RFID reader. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__pointcloud3d.html">pointcloud3d</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The pointcloud3d proxy provides an interface to a pointcloud3d device. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__stereo.html">stereo</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The stereo proxy provides an interface to a stereo device. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__imu.html">imu</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The imu proxy provides an interface to an Inertial Measurement Unit. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__wsn.html">wsn</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The wsn proxy provides an interface to a Wireless Sensor Network. </p> <br/></td></tr> </p> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Each interface has a corresponding proxy. </p> </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>