diff --git a/README.md b/README.md index 9361da7..0b72f76 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,66 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ROS implementation of local goal creator + +## Environment +- Ubuntu 20.04 +- ROS Noetic + +## Install and Build +``` +# clone repository +cd /path/to/your/catkin_ws/src +git clone https://github.com/ToshikiNakamura0412/local_goal_creator_ros.git + +# build +cd /path/to/your/catkin_ws +rosdep install -riy --from-paths src --rosdistro noetic # Install dependencies +catkin build local_goal_creator_ros -DCMAKE_BUILD_TYPE=Release # Release build is recommended +``` + +## How to use +``` +roslaunch local_goal_creator_ros local_goal_creator.launch +``` + +## Running the demo +``` +# clone repository +cd /path/to/your/catkin_ws/src +git clone https://github.com/ToshikiNakamura0412/a_star_ros.git + +# build +cd /path/to/your/catkin_ws +rosdep install -riy --from-paths src --rosdistro noetic +catkin build -DCMAKE_BUILD_TYPE=Release + +# run demo +roslaunch local_goal_creator_ros test.launch +``` + +

+ +

+ +## Node I/O +![Node I/O](images/node_io.png) + +## Nodes +### local_goal_creator +#### Published Topics +- ~\/local_goal (`geometry_msgs/PoseStamped`) + - The local goal + +#### Subscribed Topics +- /path (`nav_msgs/Path`) + - The path to goal +- /robot_pose (`geometry_msgs/PoseWithCovarianceStamped`) + - The robot pose + +#### Parameters +- ~\/hz (int, default: `10` [Hz]):
+ The rate of main loop +- ~\/target_dist_to_goal (double, default: `0.5` [m]):
+ The distance from the robot to the goal +- ~\/use_direction_in_path (bool, default: `False`):
+ Use the pose orientation included in the path diff --git a/images/node_io.png b/images/node_io.png new file mode 100644 index 0000000..04fd70c Binary files /dev/null and b/images/node_io.png differ