Project

General

Profile

Wiki » History » Version 14

Gianluca Corsini, 2022-02-28 16:37

1 13 Gianluca Corsini
h1. Multi Agent NMPC for Active Information Acquisition wiki
2 1 Martin Jacquet
3 3 Martin Jacquet
h2. Foreword
4
5
This wiki is not entirely up-to-date, but will be very soon.
6 13 Gianluca Corsini
In case of a question, query, comment, or bug report, feel free to use the issues system or contact the corresponding author Martin Jacquet - martin.jacquet@laas.fr.
7 3 Martin Jacquet
>
8
9 2 Martin Jacquet
h2. Prerequisite
10
11 13 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 guarantee.
12
Some issues have been found while installing the software on Ubuntu 16.04 because of version incompatibility with Protoc and Protobuf.
13 2 Martin Jacquet
The installation on a non-Linux OS has to be handled by the user.
14
>
15
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 repo or by the LAAS-CNRS robotic platform aims to be installed locally in the repository folder to avoid polluting the user's system.
16
>
17
18
h2. I - Software Overview
19
20
h3. I.1. Openrobots
21
22
Collections of all the open-source software used at LAAS. You can find more details in "Openrobots Wiki-Homepage":https://www.openrobots.org/wiki
23
>
24
25
26
h3. I-2. Robotpkg
27
28
"Robotpkg":http://robotpkg.openrobots.org/ is a packaging system for installing robotics software developed by the robotic community.
29
We will use robotpkg to install the required modules for the simulations (state estimation, gazebo interface...) as well as third-party dependencies (qpOases).
30
>
31
32
33
h3. I-3. GenoM
34
35 13 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 abstracts the user from any specific choice of middleware.
37
Originally GenoM has been developed tightly with Pocolibs, then from version 3, aka GenoM3, ROS templates have been provided.
38 2 Martin Jacquet
>
39
Another specificity of GenoM is the interaction with and between components.
40 13 Gianluca Corsini
Each component is started independently like a Linux executable (within a roscore, for ROS, or an h2 instance, 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
43
h3. I-4. Pocolibs
44
45
"Pocolibs":https://www.openrobots.org/wiki/pocolibs/ is a middleware, like ROS.
46 13 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
h3. I-5. TeleKyb
50
51 13 Gianluca Corsini
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 13 Gianluca Corsini
* "mrsim":https://git.openrobots.org/projects/mrsim-genom3, a Multi-Robot SIMulator. It is 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.
54 2 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)
55 13 Gianluca Corsini
* "optitrack":https://git.openrobots.org/projects/optitrack-genom3, to export the motion capture data to the genom software stack
56 2 Martin Jacquet
* "rotorcraft":https://git.openrobots.org/projects/rotorcraft-genom3, the low-level interface, with either the simulated or real platform
57 13 Gianluca Corsini
* "nhfc":https://git.openrobots.org/projects/nhfc-genom3, near-hovering flight controller, used for unmodeled take-off and post-failure recoveries
58
* "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.
59 2 Martin Jacquet
>
60
61
h3. I-6. Gazebo
62
63
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
* "mrsim-gazebo":https://git.openrobots.org/projects/mrsim-gazebo a plugin to interface the simulated multi-rotor with the genom components (in place of mrsim)
65
* "optitrack-gazebo":https://git.openrobots.org/projects/optitrack-gazebo emulates the optitrack network interface to publish the model poses
66
>
67
The installation procedure for Gazebo can be found at http://www.gazebosim.org/tutorials?cat=install&tut=install_ubuntu&ver=9.0
68
69
70
h2. II - Installation procedure
71
72
This section is a tutorial on how to install the software architecture to run the simulations.
73
>
74
75
h3. II-0. Clone the Perceptive and torque-control NMPC repository
76
77
Clone the repo associated to this project. Its root will act as the devel folder for the following.
78
<pre><code class="shell">
79
git clone git://redmine.laas.fr/laas/perceptive-torque-nmpc.git
80
cd ./perceptive-torque-nmpc/
81
</code></pre>
82
>
83
To simplify the installation, we provide some environment variables in the @env.sh@ file.
84 13 Gianluca Corsini
In order to run all the installed executables, we need to set up the path to the newly created folders.
85 2 Martin Jacquet
We provide a @env.sh@ script that exports all the required variables.
86
*/!\* the source has to be called in the repository root since it uses the @pwd@ command to export the paths.
87
<pre><code class="shell">
88
source env.sh
89
</code></pre>
90
>
91
92
h3. II-1. Setup robotpkg
93
94
(Steps taken from http://robotpkg.openrobots.org/install.html)
95
96
h4. 1. Clone the robotpkg lastest release:
97
98
<pre><code class="shell">
99
git clone git://git.openrobots.org/robots/robotpkg
100
</code></pre>
101
102
h4. 2. Check that the @openrobots/@ folder exists in the repository root, and update the environement variables accordingly if you didn't source the @env.sh@ file:
103
104
<pre><code class="shell">
105
export ROBOTPKG_BASE=`pwd`/openrobots
106
</code></pre>
107
108
h4. 3. Install robotpkg
109
110
<pre><code class="shell">
111
cd robotpkg/bootstrap
112
./bootstrap --prefix=$ROBOTPKG_BASE
113
</code></pre>
114
115
h4. 4. Install the required components and their dependencies
116
117 13 Gianluca Corsini
The installation can be done 'manually' by navigating to the desired folder in @./robotpkg/@ and installing with @make update@; but we will simplify the process using a _set_.
118 2 Martin Jacquet
To do so, we need to edit the config file: @$ROBOTPKG_BASE/etc/robotpkg.conf@. Add the following at the end of the file:
119
<pre><code class="shell">
120
PKG_OPTIONS.%-genom3 = \
121
        codels \
122
        pocolibs-server \
123
        pocolibs-client-c
124
125
PKGSET.mpcset = \
126
    sysutils/arduio-genom3 \
127
    architecture/genom3 \
128
    architecture/genom3-pocolibs \
129
    robots/rotorcraft-genom3 \
130
    localization/pom-genom3 \
131
    localization/optitrack-genom3 \
132
    motion/nhfc-genom3 \
133
    path/libkdtp \
134
    optimization/qpoases \
135
    net/genomix \
136
    supervision/matlab-genomix \
137
    supervision/tcl-genomix \
138
    shell/eltclsh \
139
    simulation/mrsim-genom3 \
140
    simulation/mrsim-gazebo \
141
    simulation/libmrsim \
142
    simulation/optitrack-gazebo
143
144
PREFER.lapack = robotpkg
145
PREFIX.matlab = <path/to/Matlab>
146
</code></pre>
147 13 Gianluca Corsini
The last line needs to point to the Matlab root folder in the system (e.g. @/opt/Matlab@).
148
It is recommended to use Matlab for the proposed simulations since the syntax is more intuitive and comprehensible for the user to modify. 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).
149 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.
150
Also, all the above is meant for using Pocolibs, not ROS. Futur version of this tutorial might come to use the ROS install.
151
>
152
Now return to the robotpkg folder and install all the set:
153
<pre><code class="shell">
154
cd robotpkg
155
make update-mpcset
156
</code></pre>
157
>
158 13 Gianluca Corsini
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 above command.
159 2 Martin Jacquet
>
160
161
h4. 5. Matlab configuration
162
163 13 Gianluca Corsini
The last step is to update the Matlab path to use the custom libraries, if relevant.
164 2 Martin Jacquet
Add the following paths in the Matlab path window:
165
<pre><code class="shell">
166
</path/to/openrobots>/lib/matlab
167
</path/to/openrobots>/lib/matlab/simulink
168
</path/to/openrobots>/lib/matlab/simulink/genomix
169
</code></pre>
170
(change </path/to/openrobots> to the value of @$ROBOTPKG_BASE@)
171
172
h3. II-2. Install custom components
173
174
h4. List of the components
175
176
The @src/@ folder contains some additional components, in particular:
177 12 Gianluca Corsini
* *vision-idl*: the type declarations regarding the camera modules
178
* *camgazebo-genom3*: read the data from the gazebo innate cameras, via the gazebo API
179 2 Martin Jacquet
* *camviz-genom3*: record and/or display the images from a camera
180 4 Martin Jacquet
* *arucotag-genom3*: detect and the ArUco markers
181 12 Gianluca Corsini
* *ikf-genom3*: an implementation of the intermittent Kalman filter presented in the paper
182 2 Martin Jacquet
* *uavmpc-genom3*: the NMPC controller presented in the paper
183 13 Gianluca Corsini
* *tagcontrol*: both a Gazebo plugin and a genom component that work together to move the ArUco tags in the Gazebo world
184 2 Martin Jacquet
185
h4. Install the extra components
186
187 12 Gianluca Corsini
Since they are not considered 'stable' as the one provided in robotpkg, we rather install them in a devel folder.
188 2 Martin Jacquet
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:
189
<pre><code class="shell">
190
export DEVEL_BASE=`pwd`/devel
191
cd src/
192
</code></pre>
193
>
194
For the manual installation, @asciidoctor@ is needed. It can be installed using @apt@ or any package manager.
195
Each component here has to be installed manually, using @autoconf@. To do so, proceed as follow:
196
<pre><code class="shell">
197
cd src/<component>/
198
./bootstrap.sh
199
mkdir build
200
cd build
201
../configure --prefix=$DEVEL_BASE --with-templates=pocolibs/client/c,pocolibs/server
202
make install
203
</code></pre>
204
>
205
The component @vision-idl@ has to be installed first since it defines some type headers used by others.
206 12 Gianluca Corsini
The installation of the main component, @uavmpc-genom3@, is described in the next subsection.
207 2 Martin Jacquet
>
208
209
h4. Install the MPC controller
210
211
Before installing the MPC controller, we have to generate the @C@ sources corresponding to the desired model.
212
To do so, go to the @model_generation/@ folder:
213
<pre><code class="shell">
214
cd src/uavmpc-genom3/model_generation
215
</code></pre>
216
>
217
There is a README.md file there, explaining the requirements.
218
In short, the model sources are exported to @C@ using @CasADi@ in @python3@.
219
@python3@ along with @NumPy@, @SciPy@ and @CasADi@  are required, and easily installable on most Linux distributions (e.g. with @apt@ and @pip3@).
220
Then, the sources are generated using:
221
<pre><code class="shell">
222
python3 gen_model.py <quad or hexa>
223
</code></pre>
224
Then install the component as explained before, but add the following flags to the @configure@ command:
225
<pre><code class="shell">
226
configure --prefix=$GENOM_DEVEL --with-templates=pocolibs/client/c,pocolibs/server CPPFLAGS="-Wall -march=native -mfpmath=sse -I$ROBOTPKG_BASE/include" CXXFLAGS="-O3" CFLAGS="-O3" LDFLAGS="-L$ROBOTPKG_BASE/lib -Wl,-R$ROBOTPKG_BASE/lib"
227
</code></pre>
228
>
229
230 12 Gianluca Corsini
Inside each model file, the variable @number_agents@ (l. 36) can be changed to specify the number of UAVs in the system. This is needed to define the size of the parameter matrix (containing the other agents' variables).
231 6 Martin Jacquet
232 2 Martin Jacquet
h3. II-3. Setup the environment
233
234 14 Gianluca Corsini
In order to run all the installed executables, we need to set up the path to the newly created folders.
235 2 Martin Jacquet
All the required variables are exported in the @env.sh@ file.
236
237
h2. III - Running the simulation
238
239 14 Gianluca Corsini
The @ws/@ folder contains all the material to run a basic simulation with the NMPC.
240
In a terminal, launch the @launch_mpc.sh@ scrip. It takes 1 argument, being the number of UAVs. It starts all the Genom components, in the background. It is used as a console since it displays warnings or errors during runtime.
241
In another terminal, start the gazebo with one of the world files provided.
242 2 Martin Jacquet
Finally, run @matlab@ or @eltclsh@ and go to the relevant subsection below.
243
>
244
245
h3. III.1. Running the simulations with Matlab
246
247
Change the flag at the top of the script to use either the quadrotor or the hexarotor.
248
>
249 14 Gianluca Corsini
The provided scripts are organized as follow
250
* The @param_*.m@ scripts provide the parameters for either a standard colinear quadrotor (denoted *QR*) or a tilted-propeller hexarotor (denoted *tx*).
251
* The @init.m@ script that connects all the components together and calls the initialization services for all provided components.
252 2 Martin Jacquet
* The @traj_*.m@ that runs the specific trajectories for a specific scenario.
253
>
254
Run the init script and wait until it stops displaying in the console.
255 14 Gianluca Corsini
If no error occurred, run any traj script then press enter between each step to proceed to the next one. The evolution can be watched in gazebo and in the console terminal in parallel.
256 1 Martin Jacquet
>
257 2 Martin Jacquet
258 14 Gianluca Corsini
The init.m script contains some parameters at the top of the script, in particular, n_UAV. It will specify the number of UAVs to initialize.
259 2 Martin Jacquet
260 9 Martin Jacquet
h3. III.2. List of the provided trajectories
261 2 Martin Jacquet
262 9 Martin Jacquet
The @traj_mpc_1/2/3.m@ files respectively correspond to the number of UAVs to use.
263 2 Martin Jacquet
264 10 Martin Jacquet
h3. III.3. Comments on how to use the simulator
265 2 Martin Jacquet
266 10 Martin Jacquet
* The MPC weights and parameters can be tuned in the @param_*.m@ files.
267 14 Gianluca Corsini
* The marker can be moved, either using a joystick or manually, using the interface of the tagcontrol component.