Skip to content

Commit a8a3ee0

Browse files
committed
update readme and assets
1 parent e173e45 commit a8a3ee0

File tree

3 files changed

+37
-14
lines changed

3 files changed

+37
-14
lines changed

README.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
# turtlebot3_obstacle_avoidance
22

3+
## Introduction
4+
35
This simulation is based on [turtlebot3 website](https://emanual.robotis.com/docs/en/platform/turtlebot3/simulation/).
46

5-
## Requirement
6-
### 1. If gazebo-ros and gazebo-plugins have not been installed, please install it.
7+
## Prequisition
8+
### 1. ROS
9+
1. ros-noetic-dekstop installed.
10+
2. Install some packages below
711
```bash
812
sudo apt-get install ros-noetic-gazebo-ros ros-noetic-gazebo-plugins ros-noetic-move-base-* ros-noetic-actionlib-* ros-noetic-gazebo-ros-pkgs ros-noetic-gazebo-ros-control ros-noetic-dwa-local-planner ros-noetic-slam-karto
913
```
14+
15+
### 2. Clone repositories.
16+
1. Clone repository
17+
```bash
18+
cd ~
19+
mkdir -p noetic_ws/src && cd noetic_ws/src
20+
git clone https://github.com/labiybafakh/turtlebot3_obstacle_avoidance
21+
```
22+
2. Get turtlebot3 packages to run this reposity, but if it has been installed on system, you can skip it.
1023
If vcstool has not been installed, please install it.
1124
```bash
1225
sudo sh -c 'echo "deb http://packages.ros.org/ros/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/ros-latest.list'
@@ -15,15 +28,6 @@ curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc | sudo ap
1528
sudo apt-get update
1629
sudo apt-get install python3-vcstool
1730
```
18-
19-
### 2. Clone repositories.
20-
1. Clone this repository.
21-
```bash
22-
cd ~
23-
mkdir -p noetic_ws/src && cd noetic_ws/src
24-
git clone https://github.com/labiybafakh/turtlebot3_obstacle_avoidance
25-
```
26-
2. Get another turtlebot3 packages to run this reposity, but if it has been installed on system, you can skip it.
2731
```bash
2832
cd turtlebot3_obstacle_avoidance
2933
vcs import . < turtlebot3.repos
@@ -33,20 +37,39 @@ vcs import . < turtlebot3.repos
3337
### 1. Build
3438
```bash
3539
cd ~/noetic_ws/
36-
catkin build
40+
catkin make
41+
source devel/setup.bash
3742
```
3843
### 2. Run
39-
#### 1. Run the simulation environment.
44+
#### 1. Creating Map.
45+
```bash
46+
export TURTLEBOT3_MODEL=burger
47+
roslaunch obstacle_avoidance creating_map.launch
48+
```
49+
and save it by run another launch file.
50+
```bash
51+
source devel/setup.bash
52+
roslaunch obstacle_avoidance map_saver.launch
53+
```
54+
It also can be also done by changing the path inside the map.yaml file.
55+
```yaml
56+
image: /home/toys/noetic_ws/src/turtlebot3_obstacle_avoidance/obstacle_avoidance/maps/map.pgm
57+
```
58+
59+
#### 2. Run simulation environment.
60+
Make sure that it can be ran like the video below by using 2D Nav Goal tool in RViz. If it is ok, it is better to re-run the launch file, but it also ok to go to the next step.
4061
```bash
4162
export TURTLEBOT3_MODEL=burger
4263
source devel/setup.bash
4364
roslaunch obstacle_avoidance simulation.launch
4465
```
66+
![Navigate with rviz](assets/nav-rviz.mp4)
4567

4668
#### 2. Run the node to publish random position and keep moving.
4769
It should be run in different terminal.
4870
```bash
4971
export TURTLEBOT3_MODEL=burger
5072
source devel/setup.bash
5173
rosrun obstacle_avoidance obastacle_avoidance
52-
```
74+
```
75+
![Free moving and random goal](assets/obstalce-avoidance-with-free-move.mp4)

assets/nav-rviz.mp4

4.31 MB
Binary file not shown.
11.1 MB
Binary file not shown.

0 commit comments

Comments
 (0)