Project

General

Profile

Wiki » History » Version 13

Martin Jacquet, 2020-10-19 22:26

1 1 Martin Jacquet
h1. Perceptive and torque-control NMPC wiki
2
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 5 Martin Jacquet
The Generator of Modules, aka GenoM, generator of modules, designed to be middleware independant, i.e. the same module can be compiled for, e.g., ROS 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
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 it "Matlab":https://git.openrobots.org/projects/matlab-genomix or "TCL":https://git.openrobots.org/projects/tcl-genomix. 
26
>
27 1 Martin Jacquet
28 11 Martin Jacquet
29 2 Martin Jacquet
h3. I-4. Pocolibs
30 1 Martin Jacquet
31 2 Martin Jacquet
"Pocolibs":https://www.openrobots.org/wiki/pocolibs/ is a middleware, like ROS.
32 6 Martin Jacquet
It aims at being more performant 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.
33 1 Martin Jacquet
>
34
35 11 Martin Jacquet
36 4 Martin Jacquet
h3. I-5. TeleKyb
37 2 Martin Jacquet
38
The "TeleKyb":https://git.openrobots.org/projects/telekyb3 software platform provides the aerial-robotic oriented softwares developped at LAAS-CNRS.
39
In particular, we will use:
40
* "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.
41 3 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)
42
* "optitrack":https://git.openrobots.org/projects/optitrack-genom3 export the motion capture data to the genom software stack
43
* "rotorcraft":https://git.openrobots.org/projects/rotorcraft-genom3 low-level interface, with either the simulated or real platform
44
* "nhfc":https://git.openrobots.org/projects/nhfc-genom3 near-hovering flight controller, used for unmodeled take-off and post-failure recovery
45
* "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.
46 1 Martin Jacquet
>
47
48 11 Martin Jacquet
49 4 Martin Jacquet
h3. I-6. Gazebo
50 1 Martin Jacquet
51 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:
52
* "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)
53
* "optitrack-gazebo":https://git.openrobots.org/projects/optitrack-gazebo emulates the optitrack network interface to publish the model poses
54
>
55 2 Martin Jacquet
56 11 Martin Jacquet
57
58 2 Martin Jacquet
h2. II - Installation procedure
59 7 Martin Jacquet
60
This section is a tutorial on how to install the software architecture to run the simulations.
61
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.
62
>
63
64 11 Martin Jacquet
65 7 Martin Jacquet
h3. II-0. Clone the Perceptive and torque-control NMPC repository
66
67
Clone the repo associated to this project. Its root will act as the devel folder for the following.
68
<pre><code class="shell">
69
git clone git://redmine.laas.fr/laas/perceptive-torque-nmpc.git
70
cd ./perceptive-torque-nmpc/
71
</code></pre>
72 11 Martin Jacquet
>
73 7 Martin Jacquet
74 11 Martin Jacquet
75 7 Martin Jacquet
h3. II-1. Setup robotpkg
76
77
(Steps taken from http://robotpkg.openrobots.org/install.html)
78 10 Martin Jacquet
79
h4. 1. Clone the robotpkg lastest release:
80 7 Martin Jacquet
81 1 Martin Jacquet
<pre><code class="shell">
82
git clone git://git.openrobots.org/robots/robotpkg
83 7 Martin Jacquet
</code></pre>
84 10 Martin Jacquet
85
h4. 2. Create an install folder called @openrobots/@, and update the environement variables accordingly, to ease the future steps:
86 7 Martin Jacquet
87
<pre><code class="shell">
88 1 Martin Jacquet
mkdir openrobots
89
export ROBOTPKG_BASE=`pwd`/openrobots
90 7 Martin Jacquet
</code></pre>
91
92 10 Martin Jacquet
h4. 3. Install robotpkg
93
94 1 Martin Jacquet
<pre><code class="shell">
95
cd robotpkg/bootstrap
96 7 Martin Jacquet
./bootstrap --prefix=$ROBOTPKG_BASE
97
</code></pre>
98
99 10 Martin Jacquet
h4. 4. Install the required components and there dependencies
100
101 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_.
102
To do so, we need to edit the config file: @$ROBOTPKG_BASE/etc/robotpkg.conf@. Add the following at the end of the file:
103
<pre><code class="shell">
104
PKG_OPTIONS.%-genom3 = \
105
        codels \
106
        pocolibs-server \
107
        pocolibs-client-c
108
109
PKGSET.mpcset = \
110
    sysutils/arduio-genom3 \
111
    architecture/genom3 \
112
    architecture/genom3-pocolibs \
113
    robots/rotorcraft-genom3 \
114 1 Martin Jacquet
    localization/pom-genom3 \
115
    localization/optitrack-genom3 \
116 8 Martin Jacquet
    motion/nhfc-genom3 \
117 1 Martin Jacquet
    optimization/qpoases \
118 8 Martin Jacquet
    net/genomix \
119 9 Martin Jacquet
    supervision/matlab-genomix \
120 10 Martin Jacquet
    supervision/tcl-genomix \
121
    shell/eltclsh \
122 1 Martin Jacquet
    simulation/mrsim-genom3 \
123 8 Martin Jacquet
    simulation/mrsim-gazebo \
124 1 Martin Jacquet
    simulation/libmrsim \
125
    simulation/optitrack-gazebo
126
127
PREFER.lapack = robotpkg
128
PREFIX.matlab = <path/to/Matlab>
129
</code></pre>
130 10 Martin Jacquet
The last line need to point to the Matlab root folder in the system (e.g. @/opt/Matlab@).
131
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).
132
Also, all the above is meant for using Pocolibs, not ROS. Futur version of this tutorial might come to use the ROS install.
133
>
134
Now return to the robotpkg folder and install all the set:
135
<pre><code class="shell">
136
cd ..
137
make update-mpcset
138
</code></pre>
139
>
140
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.
141
>
142
143
h4. 5. Matlab configuration
144
145
The last step is to update Matlab path to use the custom libraries, if relevant.
146
Add the following paths in the Matlab path window:
147
<pre><code class="shell">
148
</path/to/openrobots>/lib/matlab
149
</path/to/openrobots>/lib/matlab/simulink
150
</path/to/openrobots>/lib/matlab/simulink/genomix
151
</code></pre>
152 1 Martin Jacquet
(change </path/to/openrobots> to the content of @$ROBOTPKG_BASE@)
153 11 Martin Jacquet
154
155
h3. II-2. Install custom components
156
157
Now we install the component contained in the @src/@ folder of the repository.
158
Since it they are not considered 'stable' as the one provided in robotpkg, we rather install them in a devel folder.
159
Go to the project root, init the devel folder and go to the sources:
160
<pre><code class="shell">
161
mkdir devel/
162
export DEVEL_BASE=`pwd`/devel
163
cd src/
164
</code></pre>
165
>
166
Each component here has to be installed manually, using @autoconf@. To do so, proceed as follow:
167
<pre><code class="shell">
168
cd <component/folder/
169
./bootstrap.sh
170
mkdir build
171
cd build
172
../configure --prefix=$DEVEL_BASE --with-templates=pocolibs/client/c,pocolibs/server
173
make
174
make install
175
</code></pre>
176
>
177
The component @vision-idl@ has to be installed first since it defines some type headers used by others.
178
The main component, @uavmpc-genom3@ needs to be compiled with specific flags, e.g.:
179
@../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'@
180 12 Martin Jacquet
>
181
182
183
h3. II-3. Setup the environment
184
185
In order to run all the installed executables, we need to setup the path to the newly created folders.
186
We provide a @env.sh@ script that exports all the required variables. In the root folder:
187
<pre><code class="shell">
188
source env.sh
189
</code></pre>
190
>
191
192
193
194
h2. III - Running the simulation
195
196
We @ws/@ folder contains all the material to run a basic simulation with the NMPC.
197
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.
198 13 Martin Jacquet
In another terminal, start gazebo with one of the world file provided.
199
Finally, run @matlab@ or @eltclsh@ and go to the relevant subsection below.
200
>
201
202
h3. III.1. Running the simulations with Matlab
203
204
>
205
206
207
h3. III.2. Running the simulations with tcl