Project

General

Profile

Wiki » History » Version 51

Martin Jacquet, 2021-07-08 17:54

1 23 Gianluca Corsini
h1. Wiki
2
3 20 Gianluca Corsini
{{toc}}
4
5 8 Martin Jacquet
*TODO*:
6 24 Gianluca Corsini
* provide an alternative for joystick
7 40 Martin Jacquet
* how to use GInterface (section III) - ongoing
8 1 Martin Jacquet
9 23 Gianluca Corsini
h2. Prerequisites
10 18 Gianluca Corsini
>
11 27 Gianluca Corsini
The framework has been written and tested using *Ubuntu 18.04*, since it is the OS used by the LAAS-CNRS robotic platform. It should work seamlessly on a recent Linux version, but there is no guaranteet
12 1 Martin Jacquet
The installation on a non-Linux OS has to be handled by the user.
13 2 Martin Jacquet
>
14 18 Gianluca Corsini
The installation assumes the use of a package manager (e.g. @apt@) to install some dependencies, as well as the Gazebo simulator. Everything provided in this repository or by the LAAS-CNRS robotic platform aims to be installed locally in the repository folder to avoid polluting the user's system.
15 1 Martin Jacquet
>
16 41 Martin Jacquet
In order to use our launcher, it is required to use a USB joystick (such a Microsoft XBox joystick for PC or any equivalent one).
17 1 Martin Jacquet
>
18
19 23 Gianluca Corsini
h2. I - Software Overview
20 22 Gianluca Corsini
>
21 23 Gianluca Corsini
22
h3. I.1. Openrobots
23 1 Martin Jacquet
>
24 2 Martin Jacquet
Collections of all the open-source software used at LAAS. You can find more details in "Openrobots Wiki-Homepage":https://www.openrobots.org/wiki
25
>
26 22 Gianluca Corsini
27 23 Gianluca Corsini
h3. I-2. Robotpkg
28 1 Martin Jacquet
>
29 2 Martin Jacquet
"Robotpkg":http://robotpkg.openrobots.org/ is a packaging system for installing robotics software developed by the robotic community.
30
We will use robotpkg to install the required modules for the simulations (state estimation, gazebo interface...) as well as third-party dependencies (qpOases).
31
>
32
33 23 Gianluca Corsini
h3. I-3. GenoM
34 2 Martin Jacquet
>
35 18 Gianluca Corsini
GenoM is a generator of modules, designed to be middleware independent, i.e. the same module can be compiled for, e.g., ROS, YARP, or Pocolibs, without any modification.
36
This allows a great code re-usability and to abstracts the user from any specific choice of a middleware.
37 1 Martin Jacquet
Originally GenoM has been developed tightly with Pocolibs, then from version 3, aka GenoM3, ROS templates have been provided.
38 18 Gianluca Corsini
>
39 2 Martin Jacquet
Another specificity of GenoM is the interaction with and between components.
40 18 Gianluca Corsini
Each component is started independently like a Linux executable (within a roscore, for ROS, or a h2 intance, for Pocolibs), then the connection between ports (or topics) is made using a supervisor, "Genomix":https://git.openrobots.org/projects/genomix, either with "Matlab":https://git.openrobots.org/projects/matlab-genomix or "TCL":https://git.openrobots.org/projects/tcl-genomix. 
41 2 Martin Jacquet
>
42 1 Martin Jacquet
43 23 Gianluca Corsini
h3. I-4. Pocolibs
44 18 Gianluca Corsini
>
45 2 Martin Jacquet
"Pocolibs":https://www.openrobots.org/wiki/pocolibs/ is a middleware, like ROS.
46 18 Gianluca Corsini
It aims at being lighter and faster than ROS, when running on a single machine, thanks to the exploitation of shared memory. ROS, on the other hand, uses a network layer for sending messages between nodes, this leads to greater delays and loss of performance.
47 2 Martin Jacquet
>
48
49 23 Gianluca Corsini
h3. I-5. TeleKyb
50 18 Gianluca Corsini
>
51
The "TeleKyb":https://git.openrobots.org/projects/telekyb3 software platform provides the aerial-robotic oriented software developed at LAAS-CNRS.
52 2 Martin Jacquet
In particular, we will use:
53 1 Martin Jacquet
* "pom":https://git.openrobots.org/projects/pom-genom3, a UKF-based state estimator merging state feedback for different sources (e.g. mocap + IMU)
54 18 Gianluca Corsini
* "optitrack":https://git.openrobots.org/projects/optitrack-genom3, to export the motion capture data to the genom software stack
55 2 Martin Jacquet
* "rotorcraft":https://git.openrobots.org/projects/rotorcraft-genom3, the low-level interface, with either the simulated or real platform
56 18 Gianluca Corsini
* "maneuver":https://git.openrobots.org/projects/maneuver-genom3, a global trajectory planner, providing position and attitude (as quaternions) as well as first and second derivatives. It implements take-off and waypoint-to-waypoint motions. A joystick-based velocity control is implemented, but not used in this project.
57
* "dynamixel":https://git.openrobots.org/projects/dynamixel-genom3, an interface to control the Dynamixel motors. It is used since the gazebo gripper plugin used for the simulation (presented below) adopts the same interface protocol as the Dynamixel motors (precisely Dynamixel Protocol 2.0).
58 11 Martin Jacquet
* "joystick":https://git.openrobots.org/projects/joystick-genom3, a component to read the joystick inputs.
59 2 Martin Jacquet
>
60 22 Gianluca Corsini
61 23 Gianluca Corsini
h3. I-6. Gazebo
62 18 Gianluca Corsini
>
63 2 Martin Jacquet
To simulate the platform, we use the "Gazebo":http://gazebosim.org/ simulator. To interface it with the genom software stack, we use two dedicated components:
64 18 Gianluca Corsini
* "mrsim-gazebo":https://git.openrobots.org/projects/mrsim-gazebo a plugin to interface the simulated multi-rotor with the genom components. It uses "libmrsim":https://git.openrobots.org/projects/libmrsim, a Multi-Robot SIMulator interface, designed to be a transparent interface w.r.t. the real aerial vehicles used in LAAS-CNRS. It makes the transition between simulation and experiments transparent, from the software point of view.
65
* "optitrack-gazebo":https://git.openrobots.org/projects/optitrack-gazebo emulates the optitrack network interface to publish the model poses.
66 2 Martin Jacquet
>
67 1 Martin Jacquet
The installation procedure for Gazebo can be found at http://www.gazebosim.org/tutorials?cat=install&tut=install_ubuntu&ver=9.0
68 16 Martin Jacquet
>
69 22 Gianluca Corsini
70 23 Gianluca Corsini
h3. I-7. TCL
71 1 Martin Jacquet
>
72 16 Martin Jacquet
The interaction with the GenoM components is handled using a scripting language, implementing the communication through the "genomix":https://git.openrobots.org/projects/genomix HTTP server.
73
There are two available language interfaces: "matlab":https://git.openrobots.org/projects/matlab-genomix and "tcl":https://git.openrobots.org/projects/tcl-genomix.
74 18 Gianluca Corsini
"eltclsh":https://git.openrobots.org/projects/eltclsh is an in-terminal TCL shell to interact with the components. However, in the following, we provide a TCL-based software that is all-embedded to avoid the use of the inline interaction through eltclsh.
75
>
76 2 Martin Jacquet
77 23 Gianluca Corsini
h2. II - Installation procedure
78 18 Gianluca Corsini
>
79 2 Martin Jacquet
This section is a tutorial on how to install the software architecture to run the simulations.
80
>
81
82 23 Gianluca Corsini
h3. II-0. Clone the Visual and Physical Control Architecture for Flying End-Effector repository
83 18 Gianluca Corsini
>
84 4 Martin Jacquet
Clone the repo associated to this project, using the git daemon. Its root will act as the devel folder for the following.
85 2 Martin Jacquet
<pre><code class="shell">
86 1 Martin Jacquet
git git://redmine.laas.fr/laas/visual-physical-control-architecture.git
87 4 Martin Jacquet
cd ./visual-physical-control-architecture/
88 2 Martin Jacquet
</code></pre>
89 1 Martin Jacquet
>
90 21 Gianluca Corsini
To simplify the installation, we provide a @env.sh@ script that exports all the required variables.
91 24 Gianluca Corsini
In order to run all the installed executables, we need to set up the path to the newly created folders.
92 2 Martin Jacquet
*/!\* the source has to be called in the repository root since it uses the @pwd@ command to export the paths.
93
<pre><code class="shell">
94 1 Martin Jacquet
source env.sh
95
</code></pre>
96 2 Martin Jacquet
>
97 22 Gianluca Corsini
98 46 Martin Jacquet
Almost nothing has to be manually modified inside the @env.sh@, except the name of the joystick used to run the simulation. Either change the line 26 accordingly or export manually:
99
<pre><code class="shell">
100
export JOYSTICK=<joystick-name>
101
</code></pre>
102
>
103
104
In section *III-2*, we explain more in detail what this variable is used for and how to get to know this joystick name.
105
>
106
107 24 Gianluca Corsini
h3. II-1. Set up robotpkg
108 1 Martin Jacquet
>
109 2 Martin Jacquet
(Steps taken from http://robotpkg.openrobots.org/install.html)
110 18 Gianluca Corsini
>
111 30 Gianluca Corsini
*1. Clone the robotpkg lastest release*
112 2 Martin Jacquet
113
<pre><code class="shell">
114 1 Martin Jacquet
git clone git://git.openrobots.org/robots/robotpkg
115 2 Martin Jacquet
</code></pre>
116
117 30 Gianluca Corsini
*2. Check that the @openrobots/@ folder exists in the repository root, and update the environment variables accordingly if you didn't source the @env.sh@ file*
118 2 Martin Jacquet
119
<pre><code class="shell">
120
export ROBOTPKG_BASE=`pwd`/openrobots
121
</code></pre>
122
123 30 Gianluca Corsini
*3. Install robotpkg*
124 2 Martin Jacquet
125
<pre><code class="shell">
126
cd robotpkg/bootstrap
127
./bootstrap --prefix=$ROBOTPKG_BASE
128
</code></pre>
129
130 30 Gianluca Corsini
*4. Install the required components and their dependencies*
131 18 Gianluca Corsini
>
132 2 Martin Jacquet
The installation can be done 'manually' by navigating to the desired folder in @./robotpkg/@ and install with @make update@; but we will simplify the process using a _set_.
133
To do so, we need to edit the config file: @$ROBOTPKG_BASE/etc/robotpkg.conf@. Add the following at the end of the file:
134 18 Gianluca Corsini
135 2 Martin Jacquet
<pre><code class="shell">
136
PKG_OPTIONS.%-genom3 = \
137
        codels \
138
        pocolibs-server \
139
        pocolibs-client-c
140
141 28 Gianluca Corsini
PKGSET.myset = \
142 1 Martin Jacquet
    middleware/pocolibs \
143
    architecture/genom3 \
144 2 Martin Jacquet
    architecture/genom3-pocolibs \
145 1 Martin Jacquet
    robots/rotorcraft-genom3 \
146
    localization/pom-genom3 \
147 2 Martin Jacquet
    localization/optitrack-genom3 \
148
    net/genomix \
149
    supervision/tcl-genomix \
150 1 Martin Jacquet
    shell/eltclsh \
151
    simulation/mrsim-gazebo \
152
    simulation/libmrsim \
153 2 Martin Jacquet
    simulation/optitrack-gazebo \
154 1 Martin Jacquet
    joystick-genom3
155
156
PREFER.lapack = robotpkg
157
PREFIX.matlab = <path/to/Matlab>
158
</code></pre>
159 2 Martin Jacquet
160 22 Gianluca Corsini
The last line needs to point to the Matlab root folder in the system (e.g. @/opt/Matlab@).
161
It is recommended to use Matlab for the proposed simulations since the syntax is more intuitive and comprehensible for the user to modify them. However, we also provide all the launch files in tcl, as well as the environment to run them (@shell/eltclsh@ in the above list is a custom tcl script shell).
162 2 Martin Jacquet
If Matlab is not installed on the system, remove the lines @supervision/matlab-genomix \@ and @PREFIX.matlab = <path/to/Matlab>@ from the above list.
163 1 Martin Jacquet
Also, all the above is meant for using Pocolibs, not ROS. Futur version of this tutorial might come to use the ROS install.
164
>
165 2 Martin Jacquet
Now return to the robotpkg folder and install all the set:
166
<pre><code class="shell">
167
cd robotpkg
168 28 Gianluca Corsini
make update-myset
169 1 Martin Jacquet
</code></pre>
170 22 Gianluca Corsini
>
171 1 Martin Jacquet
During the installation, some required dependencies need to be installed with the usual package manager (e.g. @apt@ on Ubuntu). When the install stops, install the required packages and rerun the command above.
172 2 Martin Jacquet
>
173
174 23 Gianluca Corsini
h3. II-2. Install custom components
175 2 Martin Jacquet
>
176 30 Gianluca Corsini
*List of the components*
177 18 Gianluca Corsini
>
178 2 Martin Jacquet
The @src/@ folder contains some additional components, in particular:
179 33 Gianluca Corsini
* *vision-idl*: provides the type declarations regarding the camera modules.
180
* *camgazebo-genom3*: reads the data from the gazebo innate camera, via the gazebo API.
181
* *camviz-genom3*: records and/or displays the images from a camera.
182
* *arucotag-genom3*: detects and filters (EKF-based) the ArUco markers/tags.
183
* *phynt-genom3*: handles the physical interaction (wrench observer and admittance filter).
184
* *uavatt-genom3*: is the attitude controller for fully-actuated UAVs.
185
* *uavpos-genom3*: is the position controller for fully-actuated UAVs.
186
* *visualservoing-genom3*: implements the state machine for the pick-n-place experiment and provides the reference trajectory (either based on visual-servoing, or based on waypoints for takeoff/exploration).
187
* *dynamixel-genom3*: reads and sends data to Dynamixel devices (e.g. motors) that adopt Dynamixel protocols.
188
* *libdynamixel*: provides the type and function declarations used by magdynamixel-gazebo.
189
* *magdynamixel-gazebo*: is a gazebo plugin that emulates a magnetic gripper and adopts the Dynamixel Protocol 2.0.
190 1 Martin Jacquet
>
191 30 Gianluca Corsini
*Install the extra components*
192 1 Martin Jacquet
>
193 22 Gianluca Corsini
Since the extra necessary components are not considered 'stable' as the one provided in robotpkg, we rather install them in a devel folder.
194 18 Gianluca Corsini
Go to the project root, check that the devel folder exists, export the path if you didn't source the @env.sh@. Then go to the sources folder:
195 2 Martin Jacquet
196
<pre><code class="shell">
197 1 Martin Jacquet
export DEVEL_BASE=`pwd`/devel
198 2 Martin Jacquet
cd src/
199 1 Martin Jacquet
</code></pre>
200 2 Martin Jacquet
201 1 Martin Jacquet
For the manual installation, @asciidoctor@ is needed. It can be installed using @apt@ or any package manager.
202 22 Gianluca Corsini
Each component here has to be installed manually, using @autoconf@. To do so, proceed as follow:
203 1 Martin Jacquet
204 2 Martin Jacquet
<pre><code class="shell">
205 1 Martin Jacquet
cd src/<component>/
206 2 Martin Jacquet
./bootstrap.sh
207
mkdir build
208
cd build
209
../configure --prefix=$DEVEL_BASE --with-templates=pocolibs/client/c,pocolibs/server
210 22 Gianluca Corsini
make install
211 2 Martin Jacquet
</code></pre>
212 1 Martin Jacquet
213
The component @vision-idl@ has to be installed first since it defines some type headers used by others.
214
>
215 2 Martin Jacquet
216 23 Gianluca Corsini
h3. II-3. Set up the environment
217 18 Gianluca Corsini
>
218 2 Martin Jacquet
In order to run all the installed executables, we need to set up the path to the newly created folders.
219 47 Martin Jacquet
All the required variables are exported in the @env.sh@ file, so nothing more has to be done here.
220
However, remember to source the @env.sh@ each time that you want to run simulations from a new terminal.
221 1 Martin Jacquet
222 49 Martin Jacquet
>Remember that the @env.sh@ have to be sourced from the repository root!
223 2 Martin Jacquet
>
224 23 Gianluca Corsini
225 18 Gianluca Corsini
h2. III - Running the simulation
226 2 Martin Jacquet
>
227 18 Gianluca Corsini
>
228 2 Martin Jacquet
229 23 Gianluca Corsini
h3. III-1. GInterface
230 18 Gianluca Corsini
>
231 24 Gianluca Corsini
In order to start all the required software, connect the components together and store the parameters, we use a TCL-based interface.
232
The folder called @ginterface@ contains all the necessary scripts.
233 1 Martin Jacquet
For convenience, we provide as many generic scripts as possible.
234 24 Gianluca Corsini
The next section explains how to set up the GInterface, then how to use it to run the proposed simulation.
235
We also provide the "mission" script used in the experiment presented in the paper, so that the reader can have a glance at the parameters used in this experiment.
236 1 Martin Jacquet
>
237 15 Martin Jacquet
238 24 Gianluca Corsini
h3. III-2. Set up the GInterface
239 44 Martin Jacquet
240 51 Martin Jacquet
h4. a. Install dependencies
241 44 Martin Jacquet
242 1 Martin Jacquet
Before being able to run GInterface, the following packages might be required to be installed with the usual package manager (e.g. @apt@ on Ubuntu): @tcllib@, @rsync@, @grsync@, @rpcbind@, @python-pandas@, @python-qt4@.
243
>
244 26 Gianluca Corsini
245 51 Martin Jacquet
h4. b. Configuration
246 25 Gianluca Corsini
247 44 Martin Jacquet
In order to configure it, it is necessary to modify the content of the file user file. This file is located in the GInterface repository inside the folder @users@.
248
For convenience, we provide a generic @airpharo_user.tcl@ file that is pre-filled with environment variables exported from the @env.sh@ file.
249
>
250 1 Martin Jacquet
251 44 Martin Jacquet
> Remember that the @env.sh@ have to be sourced from the repository root!
252 1 Martin Jacquet
253 45 Martin Jacquet
Nothing needs to be modified in this file the sourced has been done correctly.
254 44 Martin Jacquet
For who is interested, the variables listed in the user file are defined as below, and must be modified according to your system setup: 
255 32 Gianluca Corsini
* *pc_name*: refers to the name of your machine, when running simulations, otherwise it should be set to the name of the aerial platform's machine when running experiments. Since these instructions will cover only how to run simulations, set this variable to the name of your machine.
256
* *ground_station_hostname*: refers to the name of your machine, when accessing it through the network (e.g. through @ssh@).
257
* *path_tcl*: is the path to @tcl-genomix@, where the software in robotpkg has been installed. If you followed these instructions it should be set to @<path-to-ginterface>/ginterface/openrobots/lib/tcl-genomix@.
258
* *path_rep*: is the path to the @ginterface@ folder of this repository in your machine.
259
* *path_sup*: is the path to the @ginterface@ folder in the aerial platform's machine. This path is not required for running the provided simulation, thus it can be left unchanged.
260
* *path_log*: is the path where the logs are saved during experiments (precisely in the machine specified at @pc_name@).
261
* *path_log_sim*: is the path where the logs are saved during simulations (precisely in the machine specified at @ground_station_hostname@).
262
* *path_launch*: is the path to the @ginterface/launchers@ folder of this repository in your machine.
263
* *path_devel*: is the path to the @devel@ folder where the extra necessary components have been installed in your machine. If you followed these instructions it should be set to @<path-to-ginterface>/ginterface/devel@.
264
* *path_openrobots*: is the path where the software in robotpkg has been installed in your machine. If you followed these instructions it should be set to @<path-to-ginterface>/ginterface/openrobots@.
265
* *path_gazebo_world*: is the path to the folder @ginterface/gazebo/worlds@ of this repository, where the world files for Gazebo are located. If you followed these instructions it should be set to @<path-to-ginterface>/ginterface/gazebo/worlds@.
266 29 Gianluca Corsini
>
267 1 Martin Jacquet
268 51 Martin Jacquet
h4. c. About the joystick
269 50 Martin Jacquet
270
As explained previously, a joytick is required to run the simulation, because this interface is primarily used to run real experiments on a remote UAV, hence control is made through a joystick.
271 51 Martin Jacquet
If the joystick is actually plugged and @no joystick found@ appears in the terminal during the simulation bootstrap, it means that it is not detected by Linux drivers and probably does not comply with the standards, so cannot be used to play the simulation.
272
>
273 50 Martin Jacquet
274 1 Martin Jacquet
h2. III-3. Run the simulation
275
>
276
277 26 Gianluca Corsini
First of all, source the @env.sh@ file. 
278
Then, connect a USB joystick to your pc, prior to running the simulation.
279 39 Gianluca Corsini
> Compatible models are: XBOX-360 Controller, Logitech Gamepad f310
280 25 Gianluca Corsini
Open a terminal and navigate to the repository root and run the following command:
281
282 1 Martin Jacquet
<pre>
283
$ ./GInterface.tcl
284 25 Gianluca Corsini
</pre>
285 1 Martin Jacquet
286
At this point, the window in the next figure should appear. 
287
>
288 37 Gianluca Corsini
!{width:30%}main_window_ginterface.png!
289 1 Martin Jacquet
>
290 34 Gianluca Corsini
Click on @File@ (pointed by the red arrow in the figure above), then on @Missions@ and select @sim_fiberthex_airpharo@, to run the proposed simulation.
291
After that, @Gazebo@ should be launched, and right after a @XTerm@ console should appear.
292
If everything worked correctly, you will have the situation depicted in the next figure.
293 26 Gianluca Corsini
>
294 38 Gianluca Corsini
!{width:80%}windows-ginterface.png!
295 25 Gianluca Corsini
>
296 35 Gianluca Corsini
Press and hold down for 3s the central button of your joypad until the propellers start to run the message @Armed!@ appears in the @Xterm@ console. 
297
> As soon as, the central button of the joypad is pressed the message @Arming...@ should appear in the @Xterm@ console and, while holding it down, a countdown should be initialized. The countdown will be reset if the central button is released before its end. If so, you have to restart the arming sequence.
298 34 Gianluca Corsini
If everything is well configured, the propellers should spin and the drone should take off.
299 1 Martin Jacquet
>