Skip to content

Commit

Permalink
Update doc to cite Franka physical simulation paper
Browse files Browse the repository at this point in the history
  • Loading branch information
fspindle committed Jun 3, 2021
1 parent ad23994 commit 3898dc5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 5 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
visp_ros
========

A basket of generic ros nodes based on ViSP library.
`visp_ros` is an extension of [ViSP](https://visp.inria.fr/) library developed by Inria [Rainbow](https://team.inria.fr/rainbow/) team. While ViSP is independent to ROS, in `visp_ros` we benefit from ROS features.

`visp_ros` is compatible with ROS kinetic, melodic and noetic.

`visp_ros` contains a library:

- with new C++ classes (vpROSGrabber, vpROSRobot, vpROSRobotPioneer, vpROSRobotFrankaCoppeliasim) that could be used like usual ViSP classes. They are based on ROS, but to use them there is no need to know so much about ROS;
- that makes possible to use ROS in a transparent way, either by building classical binaries without catkin, either by building ROS nodes with catkin but without the need to write ROS specific code;
- where creating a ROS node out of ViSP becomes simple.

`visp_ros` contains also a set of ROS nodes that allow to control specific hardware such as for the moment:

- robots that can be controlled only in our lab due to proprietary drivers: Afma6 gantry robot, Biclops PT head, ADEPT Viper 650 and 850 robots described here;
- other robots that anyone can buy and use with open-source drivers interfaced in ViSP: Pioneer mobile robot, Parrot bebop2 drone.

`visp_ros` contains also a tutorial that shows how to simulate a Franka Panda robot using [CoppeliaSim](https://www.coppeliarobotics.com/). The simulation is a physical simulation with a model that has been accurately identified from a real Franka robot. If you are using this simulator we would appreciate that you cite this [paper](http://rainbow-doc.irisa.fr/publi/publi/Gaz19a-eng.html):

*C. Gaz, M. Cognetti, A. Oliva, P. Robuffo Giordano, A. De Luca, Dynamic Identification of the Franka Emika Panda Robot With Retrieval of Feasible Parameters Using Penalty-Based Optimization. IEEE RA-L, 2019.*

# Installation

Expand All @@ -11,7 +28,7 @@ Install `ros-<version>-visp` package that matches your ros distribution (kinetic

$ sudo apt-get install ros-melodic-visp

If you want to use the nodes that allow to control real robots such as Biclops PT head, Viper 650, Viper 850, Afma4 or Afma6 robots, you need to build ViSP from source and install ViSP in '/opt/ros/<ros-version>' in order to overwrite the version that was installed using the previous line.
If you want to use the nodes that allow to control real robots such as Biclops PT head, Viper 650, Viper 850, Afma4 or Afma6 robots, you need to build ViSP from source and install ViSP in `/opt/ros/<version>` in order to overwrite the version that was installed using the previous line.

$ cd visp-ws
$ git clone https://github.com/lagadic/visp.git
Expand All @@ -24,13 +41,13 @@ If you want to use the nodes that allow to control real robots such as Biclops P
Enter in catkin source folder and source ROS setup:

$ cd ~/catkin_ws/src
$ source /opt/ros/<ros-version>
$ source /opt/ros/<version>

Get vision_visp stack that contains visp_bridge package:

$ git clone https://github.com/lagadic/vision_visp.git -b $ROS_DISTRO

Get visp_ros package:
Get `visp_ros` package:

$ git clone https://github.com/lagadic/visp_ros.git

Expand Down
6 changes: 5 additions & 1 deletion doc/tutorial-franka-coppeliasim.dox
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@

\section franka_coppeliasim_intro Introduction

<a href="https://visp.inria.fr">ViSP library</a> allows to control the real Panda robot from Franka Emika to perform for example a [position-based visual-servoing](https://visp-doc.inria.fr/doxygen/visp-daily/tutorial-franka-pbvs.html) or an [image-based visual-servoing](https://visp-doc.inria.fr/doxygen/visp-daily/tutorial-franka-ibvs.html). In this tutorial, we show how to simulate a Franka robot thanks to Coppeliasim and ROS.
<a href="https://visp.inria.fr">ViSP library</a> allows to control the real Panda robot from Franka Emika to perform for example a [position-based visual-servoing](https://visp-doc.inria.fr/doxygen/visp-daily/tutorial-franka-pbvs.html) or an [image-based visual-servoing](https://visp-doc.inria.fr/doxygen/visp-daily/tutorial-franka-ibvs.html). In this tutorial, we show how to simulate a Franka robot thanks to [CoppeliaSim](https://www.coppeliarobotics.com/) and ROS.

The simulation is a physical simulation with a model that has been accurately identified from a real Franka robot. If you are using this simulator we would appreciate that you cite this [paper](http://rainbow-doc.irisa.fr/publi/publi/Gaz19a-eng.html):

<em>C. Gaz, M. Cognetti, A. Oliva, P. Robuffo Giordano, A. De Luca, Dynamic Identification of the Franka Emika Panda Robot With Retrieval of Feasible Parameters Using Penalty-Based Optimization. IEEE RA-L, 2019.</em>

\section franka_coppeliasim_install_deps Install dependencies

Expand Down

0 comments on commit 3898dc5

Please sign in to comment.