Project

General

Profile

Wiki » History » Version 38

Martin Jacquet, 2020-10-27 14:42

1 32 Martin Jacquet
qh1. Perceptive and torque-control NMPC wiki
2 1 Martin Jacquet
3 2 Martin Jacquet
h2. I - Software Overview
4 1 Martin Jacquet
5 2 Martin Jacquet
h3. I.1. Openrobots
6 1 Martin Jacquet
7
Collections of all the open-source software used at LAAS. You can find more details in "Openrobots Wiki-Homepage":https://www.openrobots.org/wiki
8
>
9
10 11 Martin Jacquet
11 2 Martin Jacquet
h3. I-2. Robotpkg
12 1 Martin Jacquet
13 2 Martin Jacquet
"Robotpkg":http://robotpkg.openrobots.org/ is a packaging system for installing robotics software developed by the robotic community.
14
We will use robotpkg to install the required modules for the simulations (state estimation, gazebo interface...) as well as third-party dependencies (qpOases).
15 1 Martin Jacquet
>
16
17 11 Martin Jacquet
18 2 Martin Jacquet
h3. I-3. GenoM
19 1 Martin Jacquet
20 31 Martin Jacquet
GenoM is a generator of modules, designed to be middleware independant, i.e. the same module can be compiled for, e.g., ROS, YARP, or Pocolibs, without any modification.
21 2 Martin Jacquet
This allows a great code re-usability and to abstract the user from any specific choice of a middleware.
22 5 Martin Jacquet
Originally GenoM has been developed tightly with Pocolibs, then from version 3, aka GenoM3, ROS templates has been provided.
23 1 Martin Jacquet
>
24 2 Martin Jacquet
Another specificity of GenoM is the interaction with and between components.
25 32 Martin Jacquet
Each component is started independantly 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. 
26 2 Martin Jacquet
>
27 1 Martin Jacquet
28 2 Martin Jacquet
h3. I-4. Pocolibs
29 1 Martin Jacquet
30
"Pocolibs":https://www.openrobots.org/wiki/pocolibs/ is a middleware, like ROS.
31 33 Martin Jacquet
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 performances.
32 1 Martin Jacquet
>
33 11 Martin Jacquet
34 4 Martin Jacquet
h3. I-5. TeleKyb
35 2 Martin Jacquet
36
The "TeleKyb":https://git.openrobots.org/projects/telekyb3 software platform provides the aerial-robotic oriented softwares developped at LAAS-CNRS.
37
In particular, we will use:
38 34 Martin Jacquet
* "mrsim":https://git.openrobots.org/projects/mrsim-genom3, a Multi-Robot SIMulator. It is design to be a transparent interface w.r.t. the real aerial vehicles used in LAAS-CNRS. It makes the transition between simulation and experiment transparent, from the software point of view.
39
* "pom":https://git.openrobots.org/projects/pom-genom3, a UKF-based state estimator merging state feedback for different sources (e.g. mocap + IMU)
40
* "optitrack":https://git.openrobots.org/projects/optitrack-genom3,, to export the motion capture data to the genom software stack
41
* "rotorcraft":https://git.openrobots.org/projects/rotorcraft-genom3, the low-level interface, with either the simulated or real platform
42 35 Martin Jacquet
* "nhfc":https://git.openrobots.org/projects/nhfc-genom3, near-hovering flight controller, used for unmodeled take-off and post-failure recoverues
43 34 Martin Jacquet
* "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 implement take-off and waypoint-to-waypoint motions. A joystick-based velocity control is implemented, but not used in this project.
44 1 Martin Jacquet
>
45 11 Martin Jacquet
46 4 Martin Jacquet
h3. I-6. Gazebo
47 1 Martin Jacquet
48 4 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:
49
* "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)
50
* "optitrack-gazebo":https://git.openrobots.org/projects/optitrack-gazebo emulates the optitrack network interface to publish the model poses
51
>
52 2 Martin Jacquet
53 11 Martin Jacquet
54
55 2 Martin Jacquet
h2. II - Installation procedure
56 7 Martin Jacquet
57
This section is a tutorial on how to install the software architecture to run the simulations.
58
Note that everything has been tested on Ubuntu 18.04 since it is the OS used by the LAAS-CNRS robotic platform. It should work seamlessly on other OS, but there is no guarantee.
59
>
60
61 11 Martin Jacquet
62 7 Martin Jacquet
h3. II-0. Clone the Perceptive and torque-control NMPC repository
63
64
Clone the repo associated to this project. Its root will act as the devel folder for the following.
65
<pre><code class="shell">
66
git clone git://redmine.laas.fr/laas/perceptive-torque-nmpc.git
67
cd ./perceptive-torque-nmpc/
68
</code></pre>
69 11 Martin Jacquet
>
70 15 Martin Jacquet
To simplify the installation, we provide some environment variables in the @env.sh@ file.
71
In order to run all the installed executables, we need to setup the path to the newly created folders.
72
We provide a @env.sh@ script that exports all the required variables. In the root folder, do:
73
<pre><code class="shell">
74
source env.sh
75
</code></pre>
76
>
77 7 Martin Jacquet
78 11 Martin Jacquet
79 7 Martin Jacquet
h3. II-1. Setup robotpkg
80
81
(Steps taken from http://robotpkg.openrobots.org/install.html)
82 10 Martin Jacquet
83
h4. 1. Clone the robotpkg lastest release:
84 7 Martin Jacquet
85 1 Martin Jacquet
<pre><code class="shell">
86
git clone git://git.openrobots.org/robots/robotpkg
87 7 Martin Jacquet
</code></pre>
88 10 Martin Jacquet
89 26 Martin Jacquet
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:
90 7 Martin Jacquet
91
<pre><code class="shell">
92 1 Martin Jacquet
export ROBOTPKG_BASE=`pwd`/openrobots
93 7 Martin Jacquet
</code></pre>
94
95 10 Martin Jacquet
h4. 3. Install robotpkg
96
97 1 Martin Jacquet
<pre><code class="shell">
98
cd robotpkg/bootstrap
99 7 Martin Jacquet
./bootstrap --prefix=$ROBOTPKG_BASE
100
</code></pre>
101
102 10 Martin Jacquet
h4. 4. Install the required components and there dependencies
103
104 8 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_.
105
To do so, we need to edit the config file: @$ROBOTPKG_BASE/etc/robotpkg.conf@. Add the following at the end of the file:
106
<pre><code class="shell">
107
PKG_OPTIONS.%-genom3 = \
108
        codels \
109
        pocolibs-server \
110
        pocolibs-client-c
111
112
PKGSET.mpcset = \
113
    sysutils/arduio-genom3 \
114
    architecture/genom3 \
115
    architecture/genom3-pocolibs \
116
    robots/rotorcraft-genom3 \
117 1 Martin Jacquet
    localization/pom-genom3 \
118
    localization/optitrack-genom3 \
119 8 Martin Jacquet
    motion/nhfc-genom3 \
120 30 Martin Jacquet
    path/libkdtp \
121 1 Martin Jacquet
    optimization/qpoases \
122 8 Martin Jacquet
    net/genomix \
123 9 Martin Jacquet
    supervision/matlab-genomix \
124 10 Martin Jacquet
    supervision/tcl-genomix \
125
    shell/eltclsh \
126 1 Martin Jacquet
    simulation/mrsim-genom3 \
127 8 Martin Jacquet
    simulation/mrsim-gazebo \
128 1 Martin Jacquet
    simulation/libmrsim \
129
    simulation/optitrack-gazebo
130
131
PREFER.lapack = robotpkg
132
PREFIX.matlab = <path/to/Matlab>
133
</code></pre>
134 10 Martin Jacquet
The last line need to point to the Matlab root folder in the system (e.g. @/opt/Matlab@).
135
It is recommanded 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).
136 24 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.
137 10 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.
138
>
139
Now return to the robotpkg folder and install all the set:
140
<pre><code class="shell">
141 38 Martin Jacquet
cd robotpkg
142 10 Martin Jacquet
make update-mpcset
143
</code></pre>
144
>
145
During the installation, some required dependencies need to be install with the usual package manager (e.g. @apt@ on Ubuntu). When the install stops, install the required packages and rerun the above command.
146
>
147
148
h4. 5. Matlab configuration
149
150
The last step is to update Matlab path to use the custom libraries, if relevant.
151
Add the following paths in the Matlab path window:
152
<pre><code class="shell">
153
</path/to/openrobots>/lib/matlab
154
</path/to/openrobots>/lib/matlab/simulink
155
</path/to/openrobots>/lib/matlab/simulink/genomix
156
</code></pre>
157 37 Martin Jacquet
(change </path/to/openrobots> to the value of @$ROBOTPKG_BASE@)
158 11 Martin Jacquet
159
h3. II-2. Install custom components
160 1 Martin Jacquet
161 18 Martin Jacquet
h4. List of the components
162
163
The @src/@ folder contains some additional components, in particular:
164
* *vision-idl*: the type declaration regarding the camera modules
165
* *camgazebo-genom3*: read the data from the gazebo inate cameras, via the gazebo API
166
* *camviz-genom3*: record and/or display the images from a camera
167
* *arucotag-genom3*: detect and filter (EKF-based) the ArUco markers/tags
168
* *maneuver-genom3*: custom version of maneuver (already mentionned) that publishes the reference trajectory for a specified receding horizon
169 36 Martin Jacquet
* *uavmpc-genom3*: the NMPC controller presented in the paper
170 18 Martin Jacquet
171 14 Martin Jacquet
h4. Install the extra components
172 11 Martin Jacquet
173
Since it they are not considered 'stable' as the one provided in robotpkg, we rather install them in a devel folder.
174 27 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:
175 11 Martin Jacquet
<pre><code class="shell">
176
export DEVEL_BASE=`pwd`/devel
177
cd src/
178
</code></pre>
179
>
180 29 Martin Jacquet
For the manual installation, @asciidoctor@ is needed. It can be installed using @apt@ or any package manager.
181 11 Martin Jacquet
Each component here has to be installed manually, using @autoconf@. To do so, proceed as follow:
182 1 Martin Jacquet
<pre><code class="shell">
183 19 Martin Jacquet
cd src/<component>/
184 11 Martin Jacquet
./bootstrap.sh
185
mkdir build
186
cd build
187
../configure --prefix=$DEVEL_BASE --with-templates=pocolibs/client/c,pocolibs/server
188
make install
189 1 Martin Jacquet
</code></pre>
190 11 Martin Jacquet
>
191
The component @vision-idl@ has to be installed first since it defines some type headers used by others.
192 14 Martin Jacquet
The installation of the main component, @uavmpc-genom3@, is described in the next subection.
193 11 Martin Jacquet
>
194 1 Martin Jacquet
195 14 Martin Jacquet
h4. Install the MPC controller
196 1 Martin Jacquet
197 14 Martin Jacquet
Before installing the MPC controller, we have to generate the @C@ sources corresponding to the desired model.
198
To do so, go to the @model_generation/@ folder:
199
<pre><code class="shell">
200
cd src/uavmpc-genom3/model_generation
201
</code></pre>
202
>
203
There is a README.md file there, explaining the requirements.
204
In short, the model sources are exported to @C@ using @CasADi@ in @python3@.
205
@python3@ along with @NumPy@, @SciPy@ and @CasADi@  are required, and easily installable on most Linux distributions (e.g. with @apt@ and @pip3@).
206
Then, the sources are generated using:
207
<pre><code class="shell">
208
python3 gen_model.py <quad or hexa>
209
</code></pre>
210
Then install the component as explained before, but add the following flags to the @configure@ command:
211
<pre><code class="shell">
212 12 Martin Jacquet
../configure --prefix=$GENOM_DEVEL --with-templates=pocolibs/client/c,pocolibs/server CFLAGS='-Wall -O3 -march=native -mfpmath=sse' CXXFLAGS='-std=c++14 -Wall -O3 -march=native -mfpmath=sse' CPPFLAGS='-I$ROBOTPKG_BASE/include' LDFLAGS='-L$ROBOTPKG_BASE/lib -Wl,-R$ROBOTPKG_BASE/lib'
213 1 Martin Jacquet
</code></pre>
214 12 Martin Jacquet
>
215
216
h3. II-3. Setup the environment
217
218
In order to run all the installed executables, we need to setup the path to the newly created folders.
219 15 Martin Jacquet
All the required variables are exported in the @env.sh@ file.
220 12 Martin Jacquet
221
h2. III - Running the simulation
222
223
We @ws/@ folder contains all the material to run a basic simulation with the NMPC.
224
In a terminal, launch the @launch.sh@ script. It starts all the genom components, in background. It is used as a console since it displays warnings or error during runtime.
225 13 Martin Jacquet
In another terminal, start gazebo with one of the world file provided.
226 1 Martin Jacquet
Finally, run @matlab@ or @eltclsh@ and go to the relevant subsection below.
227 13 Martin Jacquet
>
228
229 14 Martin Jacquet
230 1 Martin Jacquet
h3. III.1. Running the simulations with Matlab
231
232 20 Martin Jacquet
Change the flag at the top of the script to use either the quadrotor or the hexarotor.
233
Change also the variable @devel_path@ to the value of @$DEVEL_BASE@
234
>
235 14 Martin Jacquet
The provided scripts are organised as follow
236
* The two @param_*.m@ scripts provide the parameters for either a standard colinear quadrotor (denoted *qr*) and a tilted-propeller hexarotor (denoted *hr*).
237
* The @init.m@ script that connects all the components together and call the initialization services for all provided components.
238
* The @traj_*.m@ that runs the specific trajectories for a specific scenario.
239
Launch the 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.
240 13 Martin Jacquet
>
241 1 Martin Jacquet
242
243
h3. III.2. Running the simulations with tcl
244
245 22 Martin Jacquet
_The TCL scripts are not included yet_
246
_I will wait for the the current matlab scripts to be tested by other users, include potential feedback, then finalize the tcl versions_
247 14 Martin Jacquet
The tcl scripts are called from the @eltclsh@ shell environment.
248
In order to run the script and keep the variables in the environment, use the @source@ command.
249 20 Martin Jacquet
The script architecture is the same as the matlab one. Change the flag and @devel_path@ in the init.tcl script, then:
250 14 Martin Jacquet
<pre><code class="tcl">
251
source init.tcl
252
source traj_<name_name>.tcl
253
</code></pre>
254
>
255
256
h3. III.3. List of the provided trajectories
257
258
* @traj_mpc@ runs a flight using the nmpc without any perceptive constraint, reaching successive waypoints.
259
* @traj_track@ runs a flight using the nmpc with a couple of perceptive constraints, again reaching successive waypoints.
260
It corresponds to the experiment presented in section *V-B* in the paper.
261
* @traj_follow@ runs a flight where we follow a _target_ quadrotor equipped with a marker. The NMPC-controlled UAV needs to stay on top of it, while the _target_ quadrotor is given successive waypoints.
262
It corresponds to the experiment presented in Section *V-C* in the paper.
263 22 Martin Jacquet
>
264
In order to perform the exact simulation performed in Section *V-E* of the paper, one need first to uncomment the tracking of the second tag in the @model_hexa.py@ file and recompile @uavmpc-genom3@.
265
Then, modify the parameters in @init.m@: @z_desired = 2;@ and @target_compliant = 0;@