gazebo / doc / mainpage.html

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99  /** \mainpage Gazebo Gazebo is a multi-robot simulator for both indoor and outdoor environments. Like Stage, it is capable of simulating a population of robots, sensors and objects, but does so in a three-dimensional world. It generates realistic sensor feedback, object collisions and dynamics. Gazebo is normally used in conjunction with the Player device server; Player provides an abstracted, network-centric mechanism (a server) through which robot controllers (clients) can interact with robot hardware. When used with Gazebo, Player provides \e simulated data in the place of real sensor data. In principle, client programs cannot tell the difference between real devices and the Gazebo simulation of those devices. Gazebo can also be controlled through a low-level C API (libgazebo). This library is included to allow third-party developers to easily integrate Gazebo into their own (non-Player) servers or architectures. Installation instructions for Gazebo can be found \ref install "here". \section mainpage_usage Quick-start guide The Gazebo server can be started as follows: \verbatim $gazebo \endverbatim where xmlfile is an XML configuration file containing the description of the world and everything in it. Sample world files can be found in the worlds directory of the source distribution, or in the installed version under /usr/local/share/gazebo/worlds/ (default install). For example: \verbatim$ gazebo /usr/local/share/gazebo/worlds/pioneer2dx.world \endverbatim will create a simple world with a single robot. Gazebo will display a window with a view of the simulated world; the camera viewpoint can be changed by dragging the mouse in the window. \section mainpage_player Working with Player (optional) The Player device server treats Gazebo in exactly the same way that it treats real robot hardware: as a device that is a source of data and a sink for commands. Users must therefore run Player seperately, and point it at an running instance of Gazebo. Player has a number of specific drivers, such as %gz_position and %gz_laser that can be used to interact with Gazebo models. For example, after starting Gazebo as per the above example, run Player like this: \verbatim $player /usr/local/share/player/config/gazebo.cfg \endverbatim Player will output a message indicating that is has connected with the simulator: \verbatim libgazebo msg : opening /tmp/gazebo--default-sim-default \endverbatim Users can now interact with the simulated robot exactly as they would a real robot. Try running playerv, for example: \verbatim$ playerv --position:0 --laser:0 \endverbatim This will pop up the standard Player viewer utility. You should see an outline of the robot and the laser scan. Use the mouse to pan and zoom. You can drive the robot around by selecting the "command" option from the menu, then dragging the little cross hairs to where you want the robot to go. You should see the the robot in the Gazebo window moving at the same time. See \ref player for examples of typical Player/Gazebo configurations, and consult the Player manual for information on specific Player drivers. \section mainpage_info Further Information More detailed information can be found here: - \ref install - TODO install_osx - \ref gazebo_server - TODO gazebo_gui - \ref config_syntax - TODO libgazebo_usage - \ref tutorial_models */