[Personalrobots-commit] SF.net SVN: personalrobots:[4853] pkg/trunk

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 4853
          http://personalrobots.svn.sourceforge.net/personalrobots/?rev=4853&view=rev
Author:   hsujohnhsu
Date:     2008-09-30 22:47:46 +0000 (Tue, 30 Sep 2008)

Log Message:
-----------
more doc updates.

Modified Paths:
--------------
    pkg/trunk/demos/2dnav-gazebo/2dnav-gazebo-simple.xml
    pkg/trunk/demos/2dnav-gazebo/manifest.xml
    pkg/trunk/drivers/simulator/gazebo_plugin/doc.dox
    pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Block_Laser.hh
    pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Camera.hh
    pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Laser.hh

Added Paths:
-----------
    pkg/trunk/demos/2dnav-gazebo/doc.dox

Modified: pkg/trunk/demos/2dnav-gazebo/2dnav-gazebo-simple.xml
===================================================================

--- pkg/trunk/demos/2dnav-gazebo/2dnav-gazebo-simple.xml	2008-09-30 22:32:32 UTC (rev 4852)
+++ pkg/trunk/demos/2dnav-gazebo/2dnav-gazebo-simple.xml	2008-09-30 22:47:46 UTC (rev 4853)
@@ -1,6 +1,7 @@
 <launch>
   <master auto="start"/>
   <group name="wg">
+    <!-- this is another script that starts up a simple world with PR2 in it -->
     <include file="$(find gazebo_robot_description)/pr2_gazebo_actuators.xml"/>
     <node pkg="map_server" type="map_server" args="$(find gazebo_robot_description)/world/Media/materials/textures/map3.png 0.1" respawn="false" output="screen" />
     <node pkg="amcl_player" type="amcl_player" args="scan:=base_scan" respawn="false" output="screen" />

Added: pkg/trunk/demos/2dnav-gazebo/doc.dox
===================================================================
--- pkg/trunk/demos/2dnav-gazebo/doc.dox	                        (rev 0)
+++ pkg/trunk/demos/2dnav-gazebo/doc.dox	2008-09-30 22:47:46 UTC (rev 4853)
@@ -0,0 +1,42 @@
+/**
+@mainpage
+
+@htmlinclude manifest.html
+
+Here are the gazebo plugins which are currently implemented:
+ \li Simple world, two desks and some simple geometric objects
+   -# \2dnav-gazebo-simple.xml
+   -# \2dnav-gazebo-simple-fake_localization.xml
+   -# \2dnav-gazebo-simple-headless-.xml
+   -# \2dnav-gazebo-simple-headless--fake_localization.xml
+ \li Complex world, Willow Garage Office Map
+   -# \2dnav-gazebo-wg.xml
+   -# \2dnav-gazebo-wg-fake_localization.xml
+   -# \2dnav-gazebo-wg-headless-.xml
+   -# \2dnav-gazebo-wg-headless--fake_localization.xml
+
+ \li Example launch script \b 2dnav-gazebo.xml:
+   -# @verbatim
+      <launch>
+        <master auto="start"/>
+        <group name="wg">
+          <!-- this is another script that starts up a simple world with PR2 in it -->
+          <include file="$(find gazebo_robot_description)/pr2_gazebo_actuators.xml"/>
+          <node pkg="map_server" type="map_server" args="$(find gazebo_robot_description)/world/Media/materials/textures/map3.png 0.1" respawn="false" output="screen" />
+          <node pkg="amcl_player" type="amcl_player" args="scan:=base_scan" respawn="false" output="screen" />
+          <node pkg="wavefront_player" type="wavefront_player" args="scan:=base_scan" respawn="false" output="screen" />
+          <node pkg="nav_view" type="nav_view" respawn="false" output="screen" />
+          <!--node pkg="teleop_base_keyboard" type="teleop_base_keyboard" respawn="false" output="screen" /-->
+        </group>
+
+        <!-- Test for publication of 'tilt_scan' topic. -->
+        <test test-name="hztest_test_amcl1" pkg="rostest" type="hztest" name="amcl_test">
+          <param name="topic" value="localizedpose" />
+          <param name="hz" value="5.0" />
+          <param name="hzerror" value="3.0" />
+          <param name="test_duration" value="5.0" />
+          <param name="check_intervals" value="false" />
+        </test>
+      </launch>
+      @endverbatim
+**/

Modified: pkg/trunk/demos/2dnav-gazebo/manifest.xml
===================================================================
--- pkg/trunk/demos/2dnav-gazebo/manifest.xml	2008-09-30 22:32:32 UTC (rev 4852)
+++ pkg/trunk/demos/2dnav-gazebo/manifest.xml	2008-09-30 22:47:46 UTC (rev 4853)
@@ -1,8 +1,8 @@
 <package>
-  <description>A demo of  2-D navigation using gazebo, simply replace rosstage with rosgazebo.</description>
+  <description>A clone of  2-D navigation stack \b rosstage using a 3D simulation environment.</description>
   <author>John Hsu</author>
   <license>BSD</license>
-  <url>http://pr.willowgarage.com/wiki/FIXME</url>
+  <url>http://pr.willowgarage.com/wiki/Simulator</url>
   <depend package="nav_view"/>
   <depend package="roslaunch"/>
   <depend package="gazebo_plugin"/>

Modified: pkg/trunk/drivers/simulator/gazebo_plugin/doc.dox
===================================================================
--- pkg/trunk/drivers/simulator/gazebo_plugin/doc.dox	2008-09-30 22:32:32 UTC (rev 4852)
+++ pkg/trunk/drivers/simulator/gazebo_plugin/doc.dox	2008-09-30 22:47:46 UTC (rev 4853)
@@ -410,7 +410,7 @@
 
     /// \brief A mutex to lock access to fields that are used in message callbacks
     private: ros::thread::mutex lock_;
-    /// \brief pointer to ros node
+    /// \brief pointer to ROS node
     ros::node *rosnode_;
     rostools::Time my_message_;
 

Modified: pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Block_Laser.hh
===================================================================
--- pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Block_Laser.hh	2008-09-30 22:32:32 UTC (rev 4852)
+++ pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Block_Laser.hh	2008-09-30 22:47:46 UTC (rev 4853)
@@ -88,7 +88,7 @@
 /// \brief ROS laser block simulation.
 ///        \li Starts a ROS node if none exists.
 ///        \li This controller simulates a block of laser range detections.
-///            Resulting point cloud (std_msgs::PointCloudFloat32.msg are published as a ROS topic.
+///            Resulting point cloud (std_msgs::PointCloudFloat32.msg) is published as a ROS topic.
 class Ros_Block_Laser : public Controller
 {
   /// \brief Constructor

Modified: pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Camera.hh
===================================================================
--- pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Camera.hh	2008-09-30 22:32:32 UTC (rev 4852)
+++ pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Camera.hh	2008-09-30 22:47:46 UTC (rev 4853)
@@ -62,7 +62,7 @@
 */
 
 /// \brief Ros_Camera Controller.
-///        \li Starts a ros node if none exists. \n
+///        \li Starts a ROS node if none exists. \n
 ///        \li Simulates a generic camera and broadcast std_msgs::Image topic over ROS. \n
 class Ros_Camera : public Controller
 {

Modified: pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Laser.hh
===================================================================
--- pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Laser.hh	2008-09-30 22:32:32 UTC (rev 4852)
+++ pkg/trunk/drivers/simulator/gazebo_plugin/include/gazebo_plugin/Ros_Laser.hh	2008-09-30 22:47:46 UTC (rev 4853)
@@ -78,7 +78,7 @@
 
 /// \brief ROS laser scan controller.
 ///        \li Starts a ROS node if none exists.
-///        \li Simulates a laser range sensor and publish results over ROS on std_msgs::LaserScan.msg
+///        \li Simulates a laser range sensor and publish std_msgs::LaserScan.msg over ROS.
 class Ros_Laser : public Controller
 {
   /// \brief Constructor


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


