Basic FAQ

From The Player Project

Jump to: navigation, search
(How do I contribute documentation?)
Line 18: Line 18:
==Where can I find binary packages?==
==Where can I find binary packages?==
-
We don't maintain binary packages, but some users do. Look on the [[Download]] page.  
+
We don't maintain binary packages for Unix-like systems, but some users and Linux distributions do. We do provide a binary installer for Windows. Look on the [[Download]] page for more details.  
==What's the story of Player's creation?==
==What's the story of Player's creation?==
-
The story of the Player/Stage project can be read in the [[PlayerHistory| player's history]] page.
+
The story of the Player/Stage project can be read in the [[PlayerHistory| Player's history]] page.
==What other information about the Player/Stage Project is available online?==
==What other information about the Player/Stage Project is available online?==
Line 54: Line 54:
=Player=
=Player=
==What is Player?==
==What is Player?==
-
Player is a device server that provides a powerful, flexible interface to a variety of sensors and actuators (e.g., robots). Because Player uses a TCP socket-based client/server model, robot control programs can be written in any programming language and can execute on any computer with network connectivity to the robot. In addition, Player supports multiple concurrent client connections to devices, creating new possibilities for distributed and collaborative sensing and control.  
+
[[Player]] is a device server that provides a powerful, flexible interface to a variety of sensors and actuators (e.g., robots). Because Player uses a TCP socket-based client/server model, robot control programs can be written in any programming language and can execute on any computer with network connectivity to the robot. In addition, Player supports multiple concurrent client connections to devices, creating new possibilities for distributed and collaborative sensing and control.  
More information on the [[Player]] page.
More information on the [[Player]] page.
Line 70: Line 70:
==How do I cross-compile Player (e.g., for the iPAQ or Gumstix)?==
==How do I cross-compile Player (e.g., for the iPAQ or Gumstix)?==
-
Of course you can find the [http://playerstage.sourceforge.net/doc/Player-svn/player/group__tutorial__crosscompiling.html proper tutorial] for this.
+
Of course you can. Tutorials are available for users of [[Cross_Compile_Player_with_Openembedded_and_BitBake | OpenEmbedded]], and for [[Cross-compiling]] Player from the command line.
==What is the difference between Player and Stage and Gazebo? What is the difference between Player device drivers and simulated device models in Stage or Gazebo?==
==What is the difference between Player and Stage and Gazebo? What is the difference between Player device drivers and simulated device models in Stage or Gazebo?==
Line 84: Line 84:
==How do I add a device driver to Player?==
==How do I add a device driver to Player?==
-
Read [http://playerstage.sourceforge.net/doc/Player-svn/player/group__tutorial__plugins.html this tutorial].  
+
If you already have a working plugin driver and wish to integrate it, read [[Adding drivers to Player 3]]. If you want to create your own plugin driver, read [[Writing a Player driver]]
==When I run Player (possibly under Stage), it exits with the message "unknown host; probably should quit." 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?==
Line 96: Line 96:
==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?==
If you get a syntax error involving PKG_CHECK_MODULES, it is likely that aclocal can't find the pkg.m4 file, which defines this macro. This is common on OS X with Fink, as the pkg-config package puts this file in /sw/share/aclocal, while the standard OS X aclocal program is looking in /usr/share/aclocal. Unfortunately, there is no reliable search path mechanism for aclocal, so the best  fix is just to copy (or symlink) /sw/share/aclocal/pkg.m4 to /usr/share/aclocal. This FAQ taken from the [http://www.cs.sfu.ca/research/groups/autonomy Autonomy Lab's] [http://deckard.cs.sfu.ca:8080/Wiki/PkgCheckModules P/S Wiki].  
If you get a syntax error involving PKG_CHECK_MODULES, it is likely that aclocal can't find the pkg.m4 file, which defines this macro. This is common on OS X with Fink, as the pkg-config package puts this file in /sw/share/aclocal, while the standard OS X aclocal program is looking in /usr/share/aclocal. Unfortunately, there is no reliable search path mechanism for aclocal, so the best  fix is just to copy (or symlink) /sw/share/aclocal/pkg.m4 to /usr/share/aclocal. This FAQ taken from the [http://www.cs.sfu.ca/research/groups/autonomy Autonomy Lab's] [http://deckard.cs.sfu.ca:8080/Wiki/PkgCheckModules P/S Wiki].  
 +
 +
Note that this only applied to versions of Player before Player 3.0.0.  Player 3 uses the CMake build system.
==How can I get high data rates from my SICK LMS laser rangefinder?==
==How can I get high data rates from my SICK LMS laser rangefinder?==
Line 161: Line 163:
==What is the purpose of the key in a provides or requires field (e.g., the "odometry" in "odometry::position:0")?==
==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-svn/player/group__tutorial__config.html#device_key here].
+
This is explained in the [[Writing configuration files#The key field in a device address | Writing Confguration Files]] tutorial.
==What is set odometry, and what does set odometry do?==
==What is set odometry, and what does set odometry do?==
Line 332: Line 334:
Patches to fix up the docs would be most appreciated.  
Patches to fix up the docs would be most appreciated.  
Patches against SVN/GIT 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/GIT (and submit to the [http://sourceforge.net/tracker/?group_id=42445&atid=433166 patch tracker] at SourceForge; that way it won't get lost).
Patches against SVN/GIT 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/GIT (and submit to the [http://sourceforge.net/tracker/?group_id=42445&atid=433166 patch tracker] at SourceForge; that way it won't get lost).
 +
 +
Please also read the [[Contributing]] page, the [[Roadmap]], and the [[Wishlist]].
[[Category:Documentation]]
[[Category:Documentation]]

Revision as of 20:10, 13 February 2011

Personal tools