This is a description
Note This is a note
This is a step-by-step guide to install and build all the prerequisites for running the project module on:
- Ubuntu 18.04: ROS Melodic with Gazebo 9 (preferred). You might want to skip some steps if your system is already partially installed.
Note: These instructions assume your catkin workspace (in which we will build the avoidance module) is in
~/catkin_ws, and the PX4 Firmware directory is~/Firmware. Feel free to adapt this to your situation.
-
Add ROS to sources.list:
sudo sh -c 'echo "deb http://packages.ros.org/ros/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/ros-latest.list' sudo apt-key adv --keyserver 'hkp://keyserver.ubuntu.com:80' --recv-key C1CF6E31E6BADE8868B172B4F42ED6FBAB17C654 sudo apt update
-
Install ROS with Gazebo:
sudo apt install ros-melodic-desktop-full # Source ROS echo "source /opt/ros/melodic/setup.bash" >> ~/.bashrc source ~/.bashrc
-
Initialize rosdep.
rosdep init rosdep update
-
Install catkin and create your catkin workspace directory.
sudo apt install python-catkin-tools mkdir -p ~/catkin_ws/src -
Build the workspace.
catkin build -w ~/catkin_ws -
Source the catkin setup.bash from your catkin workspace:
echo "source ~/catkin_ws/devel/setup.bash" >> ~/.bashrc source ~/.bashrc
-
Install MAVROS (version 0.29.0 or above).
Note: Instructions to install MAVROS from sources can be found here.
sudo apt install ros-melodic-mavros ros-melodic-mavros-extras
-
Install the geographiclib dataset
wget https://raw.githubusercontent.com/mavlink/mavros/master/mavros/scripts/install_geographiclib_datasets.sh chmod +x install_geographiclib_datasets.sh sudo ./install_geographiclib_datasets.sh
-
Install avoidance module dependencies (pointcloud library and octomap).
sudo apt install libpcl1 ros-melodic-octomap-* -
Clone this repository in your catkin workspace in order to build the avoidance node.
cd ~/catkin_ws/src git clone https://github.com/PX4/avoidance.git
-
Actually build the avoidance node.
catkin build -w ~/catkin_wsNote that you can build the node in release mode this way:
catkin build -w ~/catkin_ws --cmake-args -DCMAKE_BUILD_TYPE=Release
In the following section we guide you through installing and running a Gazebo simulation of both local and global planner.
-
Clone the PX4 Firmware and all its submodules (it may take some time).
cd ~ git clone https://github.com/PX4/Firmware.git --recursive cd ~/Firmware
-
Install PX4 dependencies.
# Install PX4 "common" dependencies. ./Tools/setup/ubuntu.sh --no-sim-tools --no-nuttx # Gstreamer plugins (for Gazebo camera) sudo apt install gstreamer1.0-plugins-bad gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-ugly libgstreamer-plugins-base1.0-dev
-
Build the Firmware once in order to generate SDF model files for Gazebo. This step will actually run a simulation (that you can immediately close).
# This is necessary to prevent some Qt-related errors (feel free to try to omit it) export QT_X11_NO_MITSHM=1 # Build and run simulation make px4_sitl_default gazebo # Quit the simulation (Ctrl+C) # Setup some more Gazebo-related environment variables (modify this line based on the location of the Firmware folder on your machine) . ~/Firmware/Tools/setup_gazebo.bash ~/Firmware ~/Firmware/build/px4_sitl_default
-
Add the Firmware directory to ROS_PACKAGE_PATH so that ROS can start PX4:
export ROS_PACKAGE_PATH=${ROS_PACKAGE_PATH}:~/Firmware
-
Finally, set the GAZEBO_MODEL_PATH in your bashrc:
echo "export GAZEBO_MODEL_PATH=${GAZEBO_MODEL_PATH}:~/catkin_ws/src/avoidance/avoidance/sim/models:~/catkin_ws/src/avoidance/avoidance/sim/worlds" >> ~/.bashrc
The last three steps, together with sourcing your catkin setup.bash (source ~/catkin_ws/devel/setup.bash) should be repeated each time a new terminal window is open.
You should now be ready to run the simulation using local or global planner.
This section shows how to start the local_planner and use it for avoidance in mission or offboard mode.
The planner is based on the 3DVFH+ algorithm.
Note: You may need to install some additional dependencies to run the following code (if not installed):
sudo apt install ros-melodic-stereo-image-proc ros-melodic-image-view
Any of the following three launch file scripts can be used to run local planner:
Note: The scripts run the same planner but simulate different sensor/camera setups. They all enable Obstacle Avoidance and Collision Prevention.
-
local_planner_stereo: simulates a vehicle with a stereo camera that uses OpenCV's block matching algorithm (SGBM by default) to generate depth informationroslaunch local_planner local_planner_stereo.launch
Note: The disparity map from
stereo-image-procis published as a stereo_msgs/DisparityImage message, which is not supported by rviz or rqt. To visualize the message, first open a new terminal and setup the required environment variables:source devel/setup.bashThen do either of:
- run:
rosrun image_view stereo_view stereo:=/stereo image:=image_rect_color
- publish the
DisparityImageas a simplesensor_msgs/Image:rosrun topic_tools transform /stereo/disparity /stereo/disparity_image sensor_msgs/Image 'm.image'
The disparity map can then be visualized by rviz or rqt under the topic /stereo/disparity_image.
- run:
-
local_planner_depth_camera: simulates vehicle with one forward-facing kinect sensorroslaunch local_planner local_planner_depth-camera.launch
-
local_planner_sitl_3cam: simulates vehicle with 3 kinect sensors (left, right, front)roslaunch local_planner local_planner_sitl_3cam.launch
You will see the Iris drone unarmed in the Gazebo world. To start flying, there are two options: OFFBOARD or MISSION mode. For OFFBOARD, run:
# In another terminal
rosrun mavros mavsys mode -c OFFBOARD
rosrun mavros mavsafety armThe drone will first change its altitude to reach the goal height.
It is possible to modify the goal altitude with rqt_reconfigure GUI.
Then the drone will start moving towards the goal.
The default x, y goal position can be changed in Rviz by clicking on the 2D Nav Goal button and then choosing the new goal x and y position by clicking on the visualized gray space.
If the goal has been set correctly, a yellow sphere will appear where you have clicked in the grey world.

For MISSIONS, open QGroundControl and plan a mission as described here. Set the parameter COM_OBS_AVOID true.
Start the mission and the vehicle will fly the mission waypoints dynamically recomputing the path such that it is collision free.
This section shows how to start the global_planner and use it for avoidance in offboard mode.
roslaunch global_planner global_planner_stereo.launchYou should now see the drone unarmed on the ground in a forest environment as pictured below.
To start flying, put the drone in OFFBOARD mode and arm it. The avoidance node will then take control of it.
# In another terminal
rosrun mavros mavsys mode -c OFFBOARD
rosrun mavros mavsafety armInitially the drone should just hover at 3.5m altitude.
From the command line, you can also make Gazebo follow the drone, if you want.
gz camera --camera-name=gzclient_camera --follow=irisOne can plan a new path by setting a new goal with the 2D Nav Goal button in rviz. The planned path should show up in rviz and the drone should follow the path, updating it when obstacles are detected. It is also possible to set a goal without using the obstacle avoidance (i.e. the drone will go straight to this goal and potentially collide with obstacles). To do so, set the position with the 2D Pose Estimate button in rviz.
This section shows how to start the safe_landing_planner and use it to land safely in mission or auto land mode. To run the node:
roslaunch safe_landing_planner safe_landing_planner.launchYou will see an unarmed vehicle on the ground. Open QGroundControl, either plan a mission with the last item of type Land or fly around the world in Position Control, click the Land button on the left side where you wish to land.
At the land position, the vehicle will start to descend towards the ground until it is at loiter_height from the ground/obstacle. Then it will start loitering to evaluate the ground underneeth.
If the ground is flat, the vehicle will continue landing. Otherwise it will evaluate the close by terrain in a squared spiral pattern until it finds a good enough ground to land on.
Check that some camera topics (including /camera/depth/points) are published with the following command:
rostopic list | grep cameraIf /camera/depth/points is the only one listed, it may be a sign that gazebo is not actually publishing data from the simulated depth camera. Verify this claim by running:
rostopic echo /camera/depth/pointsWhen everything runs correctly, the previous command should show a lot of unreadable data in the terminal. If you don't receive any message, it probably means that gazebo is not publishing the camera data.
Check that the clock is being published by Gazebo:
rostopic echo /clockIf it is not, you have a problem with Gazebo (Did it finish loading the world? Do you see the buildings and the drone in the Gazebo UI?). However, if it is publishing the clock, then it might be a problem with the depth camera plugin. Make sure the package ros-kinetic-gazebo-ros-pkgs is installed. If not, install it and rebuild the Firmware (with $ make px4_sitl_default gazebo as explained above).
Is the drone in OFFBOARD mode? Is it armed and flying?
# Set the drone to OFFBOARD mode
rosrun mavros mavsys mode -c OFFBOARD
# Arm
rosrun mavros mavsafety armSome tuning may be required in the file "<Firmware_dir>/posix-configs/SITL/init/rcS_gazebo_iris".
Some parameters that can be tuned in rqt reconfigure.
