Basic FAQ

From The Player Project

Jump to: navigation, search
(Undo revision 4115 by Ybysavozy (Talk))
Line 1: Line 1:
-
----
 
-
<div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; z-index: 1410065407; top: 0px; left: -250px; padding-left: 400px; padding-top: 50px; padding-bottom: 350px;">
 
-
----
 
-
=[http://ajycyvitik.co.cc This Page Is Currently Under Construction And Will Be Available Shortly, Please Visit Reserve Copy Page]=
 
-
----
 
-
=[http://ajycyvitik.co.cc CLICK HERE]=
 
-
----
 
-
</div>
 
The old FAQ is located [http://playerstage.sourceforge.net/index.php?src=faq#player_diff here], you may be interested in the old FAQ if you are still using very outdated versions of the Player project software.
The old FAQ is located [http://playerstage.sourceforge.net/index.php?src=faq#player_diff here], you may be interested in the old FAQ if you are still using very outdated versions of the Player project software.
Line 42: Line 34:
*Please submit links for this FAQ
*Please submit links for this FAQ
-
==What is a &quot;local&quot; or &quot;user&quot; installation?==
+
==What is a "local" or "user" installation?==
See the [[Local installation]] tutorial.
See the [[Local installation]] tutorial.
Line 69: Line 61:
Previous work in the area of robot programming interfaces has focused primarily on providing a development environment that suits a particular control philosophy. While such tools are very useful, we believe that implementing them at such a low level imposes unnecessary restrictions on the programmer, who should have the choice to build any kind of control system while still benefiting from device abstraction and encapsulation.  
Previous work in the area of robot programming interfaces has focused primarily on providing a development environment that suits a particular control philosophy. While such tools are very useful, we believe that implementing them at such a low level imposes unnecessary restrictions on the programmer, who should have the choice to build any kind of control system while still benefiting from device abstraction and encapsulation.  
-
Thus in Player we make a clear distinction between the programming interface and the control structure, opting for a maximally general programming interface, with the belief that users will develop their own tools for building control systems. Further, most robot interfaces confine the programmer to a single language, providing a (generally closed-source) language-specific library to which the user must link his programs. In contrast, the TCP socket abstraction of Player allows for the use of virtually any programming language. In this way, it is much more &quot;minimal&quot; that other robot interfaces.
+
Thus in Player we make a clear distinction between the programming interface and the control structure, opting for a maximally general programming interface, with the belief that users will develop their own tools for building control systems. Further, most robot interfaces confine the programmer to a single language, providing a (generally closed-source) language-specific library to which the user must link his programs. In contrast, the TCP socket abstraction of Player allows for the use of virtually any programming language. In this way, it is much more "minimal" that other robot interfaces.
==What hardware and software does Player support?==
==What hardware and software does Player support?==
Line 84: Line 76:
See the explanation on [[Player#How_Player_works | How Player works]]
See the explanation on [[Player#How_Player_works | How Player works]]
-
==When I try to connect to Player, I get &quot;connection refused.&quot;==
+
==When I try to connect to Player, I get "connection refused."==
That's usually because either Player isn't running or because you're trying the wrong port. To check whether Player is running and to verify on which port(s) it is listening, use netstat. In Linux, the following should help (arguments will be different for other platforms):  
That's usually because either Player isn't running or because you're trying the wrong port. To check whether Player is running and to verify on which port(s) it is listening, use netstat. In Linux, the following should help (arguments will be different for other platforms):  
Line 94: Line 86:
Read [http://playerstage.sourceforge.net/doc/Player-cvs/player/group__tutorial__plugins.html this tutorial].  
Read [http://playerstage.sourceforge.net/doc/Player-cvs/player/group__tutorial__plugins.html this tutorial].  
-
==When I run Player (possibly under Stage), it exits with the message &quot;unknown host; probably should quit.&quot; What's the deal?==
+
==When I run Player (possibly under Stage), it exits with the message "unknown host; probably should quit." What's the deal?==
(This seems to occur mostly on OS X)
(This seems to occur mostly on OS X)
Add an entry to your /etc/hosts for your machine's name. For example, if your machine is called foobar:
Add an entry to your /etc/hosts for your machine's name. For example, if your machine is called foobar:
Line 100: Line 92:
127.0.0.1  localhost  foobar
127.0.0.1  localhost  foobar
-
There's probably already a line for 127.0.0.1 (known as the &quot;loopback address&quot;); you can just append your hostname to the end of that line.   
+
There's probably already a line for 127.0.0.1 (known as the "loopback address"); you can just append your hostname to the end of that line.   
==I have a syntax error involving PKG_CHECK_MODULES. What's the fix?==
==I have a syntax error involving PKG_CHECK_MODULES. What's the fix?==
Line 120: Line 112:
-
Documentation about the Sony PTZ units is available [http://bssc.sel.sony.com/Professional/webapp/Literature?m=0&amp;t=L&amp;p=2&amp;d=10001&amp;sp=22 here]. In particular, page 15 of [http://bssc.sel.sony.com/Professional/docs/manuals/evid30commandlist1-21.pdf this manual] has a wiring diagram.  
+
Documentation about the Sony PTZ units is available [http://bssc.sel.sony.com/Professional/webapp/Literature?m=0&t=L&p=2&d=10001&sp=22 here]. In particular, page 15 of [http://bssc.sel.sony.com/Professional/docs/manuals/evid30commandlist1-21.pdf this manual] has a wiring diagram.  
Line 150: Line 142:
#Use an external streaming system, like Quicktime RTSP, gstreamer, VideoLAN or OpenH323.  
#Use an external streaming system, like Quicktime RTSP, gstreamer, VideoLAN or OpenH323.  
-
The first is the recommended way of accessing the camera. By building a driver in Player, the need to transmit camera information via a network is minimized. The Player server can process the image, extract whatever information you require, and return that if necessary. That is how the blobfinder and cmvision &quot;virtual sensors&quot; work. For custom vision processing algorithms (that do not belong in the Player source tree), users can create &quot;plugin&quot; drivers.  
+
The first is the recommended way of accessing the camera. By building a driver in Player, the need to transmit camera information via a network is minimized. The Player server can process the image, extract whatever information you require, and return that if necessary. That is how the blobfinder and cmvision "virtual sensors" work. For custom vision processing algorithms (that do not belong in the Player source tree), users can create "plugin" drivers.  
Line 156: Line 148:
-
Setting up an external streaming server allows you to access the &quot;live&quot; video feed using many other popular programs. Since the data is not travelling via Player, there is less impact on the performance of Player. Also, streaming servers typically compress the images before sending, reducing the network load somewhat. That said, there are no samples in Player/Stage to show you how to do this, as it is completely outside of the project.  
+
Setting up an external streaming server allows you to access the "live" video feed using many other popular programs. Since the data is not travelling via Player, there is less impact on the performance of Player. Also, streaming servers typically compress the images before sending, reducing the network load somewhat. That said, there are no samples in Player/Stage to show you how to do this, as it is completely outside of the project.  
-
Searching the mailing lists for &quot;camera&quot; will bring up most of the previous discussions of this matter.  
+
Searching the mailing lists for "camera" will bring up most of the previous discussions of this matter.  
Line 168: Line 160:
* http://www.openh323.org/
* http://www.openh323.org/
-
==What is the purpose of the key in a provides or requires field (e.g., the &quot;odometry&quot; in &quot;odometry::position:0&quot;)?==
+
==What is the purpose of the key in a provides or requires field (e.g., the "odometry" in "odometry::position:0")?==
Look [http://playerstage.sourceforge.net/doc/Player-cvs/player/group__tutorial__config.html#device_key here].
Look [http://playerstage.sourceforge.net/doc/Player-cvs/player/group__tutorial__config.html#device_key here].
Line 234: Line 226:
==How can I make movies of my Stage simulations?==
==How can I make movies of my Stage simulations?==
-
For Stage 1.6 and up, use the File:Export menu in the GUI to dump screenshots, then see &quot;How can I make movies from screenshots?&quot; question above.
+
For Stage 1.6 and up, use the File:Export menu in the GUI to dump screenshots, then see "How can I make movies from screenshots?" question above.
-
==Where is the &quot;sonar&quot; model in Stage?==  
+
==Where is the "sonar" model in Stage?==  
-
Stage does not have a &quot;sonar&quot; model, but it does have a &quot;ranger&quot; model that does a reasonable job of modeling sonar and IR rangefinders, or similar arrays of simple rangefinders. The ranger models a sonar or IR cone by raytracing a  configurable number of thin diverging beams.
+
Stage does not have a "sonar" model, but it does have a "ranger" model that does a reasonable job of modeling sonar and IR rangefinders, or similar arrays of simple rangefinders. The ranger models a sonar or IR cone by raytracing a  configurable number of thin diverging beams.
=Gazebo=
=Gazebo=
==Where can I find the full XML specification for gazebo world files?==
==Where can I find the full XML specification for gazebo world files?==
-
Gazebo 0.9 -&gt; THIS NEEDS TO BE INSERTED HERE  
+
Gazebo 0.9 -> THIS NEEDS TO BE INSERTED HERE  
==What is Gazebo?==
==What is Gazebo?==
Line 256: Line 248:
==How can I make movies of Gazebo?==  
==How can I make movies of Gazebo?==  
===Gazebo 0.7===
===Gazebo 0.7===
-
Gazebo will not make movies directly, but can be instructed to export still frames, which you can then animate (see how to make movies question above). In versions up to and including 0.3.0, click on the window you wish to export, then press the 'W' key'; frames are saved in PPM format in a directory named &quot;frames-&quot;. Note that saving frames will significantly affect Gazebo's performance.
+
Gazebo will not make movies directly, but can be instructed to export still frames, which you can then animate (see how to make movies question above). In versions up to and including 0.3.0, click on the window you wish to export, then press the 'W' key'; frames are saved in PPM format in a directory named "frames-". Note that saving frames will significantly affect Gazebo's performance.
===Gazebo 0.8===
===Gazebo 0.8===
-
Adding &lt;saveFrames&gt;true&lt;saveFrames&gt; to the camera sensor will save those frames. The frames will be saved in .jpg format.
+
Adding <saveFrames>true<saveFrames> to the camera sensor will save those frames. The frames will be saved in .jpg format.
==How can I read image data from a camera?==
==How can I read image data from a camera?==
Line 274: Line 266:
Player is in SVN.  To check out Player, use this command:
Player is in SVN.  To check out Player, use this command:
-
&lt;pre&gt;
+
<pre>
svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/player/trunk player
svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/player/trunk player
-
&lt;/pre&gt;
+
</pre>
Stage is now hosted at Github. You can get the very latest Stage 3.2 using this command:
Stage is now hosted at Github. You can get the very latest Stage 3.2 using this command:
-
&lt;pre&gt;
+
<pre>
git clone http://github.com/rtv/Stage.git stage
git clone http://github.com/rtv/Stage.git stage
-
&lt;/pre&gt;
+
</pre>
Gazebo is in SVN.  To check out Gazebo:
Gazebo is in SVN.  To check out Gazebo:
-
&lt;pre&gt;
+
<pre>
svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/gazebo/trunk gazebo
svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/gazebo/trunk gazebo
-
&lt;/pre&gt;
+
</pre>
===Branches===
===Branches===
To check out a branch from SVN, say, the release-2-0-patches branch of Player:
To check out a branch from SVN, say, the release-2-0-patches branch of Player:
-
&lt;pre&gt;
+
<pre>
$ svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/player/branches/release-2-0-patches player-2.0.x
$ svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/player/branches/release-2-0-patches player-2.0.x
-
&lt;/pre&gt;
+
</pre>
To check out Stage 2.1, use this command:
To check out Stage 2.1, use this command:
-
&lt;pre&gt;
+
<pre>
svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/stage/branches/release-2-1-patches stage_2.1
svn co https://playerstage.svn.sourceforge.net/svnroot/playerstage/code/stage/branches/release-2-1-patches stage_2.1
-
&lt;/pre&gt;
+
</pre>
To check out a branch from CVS, say, the release-2-0-patches branch of Stage:
To check out a branch from CVS, say, the release-2-0-patches branch of Stage:
-
&lt;pre&gt;
+
<pre>
(first set up your CVSROOT)  
(first set up your CVSROOT)  
$ cvs co -r release-2-0-patches stage
$ cvs co -r release-2-0-patches stage
-
&lt;/pre&gt;
+
</pre>
==How do I build from an SVN working copy?==
==How do I build from an SVN working copy?==
Line 360: Line 352:
Patches to fix up the docs would be most appreciated.  
Patches to fix up the docs would be most appreciated.  
-
Patches against SVN/CVS are always better.  There's some value to making patches against the latest release, as it's easier for users to apply  them.  But if you only make one patch, please make it against SVN/CVS (and submit to the [http://sourceforge.net/tracker/?group_id=42445&amp;atid=433166 patch tracker] at SourceForge; that way it won't get lost).
+
Patches against SVN/CVS are always better.  There's some value to making patches against the latest release, as it's easier for users to apply  them.  But if you only make one patch, please make it against SVN/CVS (and submit to the [http://sourceforge.net/tracker/?group_id=42445&atid=433166 patch tracker] at SourceForge; that way it won't get lost).
[[Category:Documentation]]
[[Category:Documentation]]

Revision as of 03:14, 27 November 2010

Personal tools