Skip to content

Commit aa992bf

Browse files
committed
Add platforms information
1 parent 88bdcad commit aa992bf

File tree

13 files changed

+418
-194
lines changed

13 files changed

+418
-194
lines changed

docs/_03_aerial_platforms/_crazyflie/index.rst

Lines changed: 32 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,8 @@ Install platform package
6060
6161
sudo apt install ros-humble-as2-platform-crazyflie
6262
63-
.. warning:: This package is not available for binary installation yet. Cooming soon.
6463
65-
* For source installation, clone the platform repository into your workspace and build it.
64+
* For source installation, follow the steps below:
6665

6766
.. code-block:: bash
6867
@@ -74,10 +73,6 @@ Install platform package
7473
colcon build --packages-up-to as2_platform_crazyflie
7574
7675
77-
See it in :ref:`Aerostack2 installation guide <getting_started_ubuntu_installation_source>`.
78-
79-
80-
8176
.. _aerial_platform_crazyflie_as2_common_interface:
8277

8378
---------------------------
@@ -158,60 +153,39 @@ In order to map the adresses of the crazyflie(s) we just configured to the input
158153
In this case, we are mapping two Crazyflies with uri's ``radio://0/80/2M/E7E7E7E700`` and ``radio://0/80/2M/E7E7E7E701`` for namespaces ``cf0`` and ``cf1`` respectively.
159154
As you can see for the radio id part of the uri, the same Crazyradio is going to be used for both.
160155

161-
This configuration file's path shall serve as an input to the platform launch parameter ``swarm_config_file``. Note that this platform is launched only once, regardless of the number of crazyflies beeing used.
162-
163-
Aerostack2 Crazyflie platform provides a launch file, which parameters are:
164-
165-
.. list-table:: Gazebo Platform Parameters
166-
:widths: 50 50 50
167-
:header-rows: 1
168-
169-
* - Parameter
170-
- Type
171-
- Description
172-
* - swarm_config_file
173-
- string
174-
- Path to the swarm URI's configuration file.
175-
* - control_modes_file
176-
- string
177-
- Optional. File path with the control modes configuration. Default the one in the package.
178-
* - external_odom
179-
- bool
180-
- Optional. Use external odometry source. Default false.
181-
* - external_odom_topic
182-
- bool
183-
- Optional. Topic name of external odometry source. Default 'external_odom'.
184-
* - controller_type
185-
- int
186-
- Optional. Controller type: Any(0), PID(1), Mellinger(2), INDI(3). Default PID.
187-
* - estimator_type
188-
- int
189-
- Optional. Estimator type: Any(0), complementary(1), kalman(2). Default Kalman.
190-
191-
Example of launch command with a Crazyflies with flow deck:
156+
.. This configuration file's path shall serve as an input to the platform launch parameter ``swarm_config_file``. Note that this platform is launched only once, regardless of the number of crazyflies beeing used.
157+
158+
.. .. list-table:: Gazebo Platform Parameters
159+
.. :widths: 50 50 50
160+
.. :header-rows: 1
161+
162+
.. * - Parameter
163+
.. - Type
164+
.. - Description
165+
.. * - swarm_config_file
166+
.. - string
167+
.. - Path to the swarm URI's configuration file.
168+
.. * - control_modes_file
169+
.. - string
170+
.. - Optional. File path with the control modes configuration. Default the one in the package.
171+
.. * - external_odom
172+
.. - bool
173+
.. - Optional. Use external odometry source. Default false.
174+
.. * - external_odom_topic
175+
.. - bool
176+
.. - Optional. Topic name of external odometry source. Default 'external_odom'.
177+
.. * - controller_type
178+
.. - int
179+
.. - Optional. Controller type: Any(0), PID(1), Mellinger(2), INDI(3). Default PID.
180+
.. * - estimator_type
181+
.. - int
182+
.. - Optional. Estimator type: Any(0), complementary(1), kalman(2). Default Kalman.
183+
184+
Aerostack2 provides a launch file for this platform:
192185

193186
.. code-block:: bash
194187
195-
ros2 launch as2_platform_crazyflie crazyflie_swarm_launch.py swarm_config_file:=uris_yaml_path
196-
197-
Example of launch command with a Crazyflies with motion capture system:
198-
199-
.. code-block:: bash
200-
201-
ros2 launch as2_platform_crazyflie crazyflie_swarm_launch.py swarm_config_file:=uris_yaml_path external_odom:=true external_odom_topic:=mocap_topic_name
202-
203-
204-
205-
.. _aerial_platform_crazyflie_platform_examples:
206-
207-
--------
208-
Examples
209-
--------
210-
211-
Basic example
212-
=============
188+
ros2 launch as2_platform_crazyflie crazyflie_swarm_launch.py
213189
214-
.. toctree::
215-
:maxdepth: 1
216190
217-
../../_02_examples/crazyflie/project_crazyflie/index.rst
191+
To see all the **available parameters**, use the **'-s'** flag to show the description of each parameter in the launch file.

docs/_03_aerial_platforms/_dji/index.rst renamed to docs/_03_aerial_platforms/_dji_osdk/index.rst

Lines changed: 32 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,46 @@
1-
.. _aerial_platform_dji_matrice:
1+
.. _aerial_platform_dji_matrice_osdk_osdk:
22

3-
==================
4-
DJI Matrice Series
5-
==================
3+
=======================
4+
DJI Matrice Series OSDK
5+
=======================
66

77
.. contents:: Table of Contents
88
:depth: 3
99
:local:
1010

1111

1212

13-
.. _aerial_platform_dji_matrice_introduction:
13+
.. _aerial_platform_dji_matrice_osdk_introduction:
1414

1515
------------
1616
Introduction
1717
------------
1818

19-
DJI Matrice Series using `DJI Onboard SDK <https://github.com/dji-sdk/Onboard-SDK>`_ has compatibility with DJI M210 V2, M210 RTX V2 and M300 RTK.
19+
DJI Matrice Series using `DJI Onboard OSDK <https://github.com/dji-sdk/Onboard-SDK>`_ has compatibility with DJI M210 V2, M210 RTX V2 and M300 RTK.
2020

2121
.. figure:: resources/DJI_M300.jpg
2222
:scale: 15
2323
:class: with-shadow
2424

2525

2626

27-
.. _aerial_platform_dji_matrice_installation:
27+
.. _aerial_platform_dji_matrice_osdk_installation:
2828

2929
------------
3030
Installation
3131
------------
3232

33-
* For binary installation, install by running:
34-
35-
.. code-block:: bash
36-
37-
sudo apt install ros-humble-as2-platform-dji-osdk
38-
39-
.. warning:: This package is not available for binary installation yet. Cooming soon.
33+
.. _aerial_platform_matrice_osdk_installation_prerequisites:
4034

41-
* For source installation, clone the platform repository into your workspace and build it.
35+
Prerequisites
36+
=============
4237

43-
.. code-block:: bash
38+
Refer to the `DJI Onboard SDK documentation <https://developer.dji.com/onboard-sdk/>`_ for the harware and software requirements.
4439

45-
# If you have installed Aerostack2 from sources we recommend to clone the package in the src folder of your workspace otherwise you can clone it in any ROS 2 workspace you want.
46-
cd ~/aerostack2_ws/src/aerostack2/as2_aerial_platforms
47-
git clone [email protected]:aerostack2/as2_platform_dji_osdk.git
48-
cd ~/aerostack2_ws
49-
rosdep install as2_platform_dji_osdk --from-paths src --ignore-src -r -y
50-
colcon build --packages-up-to as2_platform_dji_osdk
40+
See `DJI Device Connection tutorial <https://developer.dji.com/onboard-sdk/documentation/quickstart/device-connection.html>`_ for connect onboard computer with Aerostack2 to DJI Matrice aircracft.
5141

5242

53-
.. _aerial_platform_dji_matrice_installation_package:
43+
.. _aerial_platform_dji_matrice_osdk_installation_package:
5444

5545
Install platform package
5646
========================
@@ -61,22 +51,20 @@ Install platform package
6151
6252
sudo apt install ros-humble-as2-platform-dji-osdk
6353
64-
.. warning:: This package is not available for binary installation yet. Cooming soon.
6554
66-
* For source installation, clone Aerostack2 repository into your workspace and build it. See it in :ref:`Aerostack2 installation guide <getting_started_ubuntu_installation_source>`.
55+
* For source installation, follow the steps below:
6756

57+
.. code-block:: bash
6858
69-
70-
.. _aerial_platform_dji_matrice_installation_conection:
71-
72-
Setup connection with DJI Matrice
73-
=================================
74-
75-
See `DJI Device Connection tutorial <https://developer.dji.com/onboard-sdk/documentation/quickstart/device-connection.html>`_ for connect onboard computer with Aerostack2 to DJI Matrice aircracft.
76-
59+
# If you have installed Aerostack2 from sources we recommend to clone the package in the src folder of your workspace otherwise you can clone it in any ROS 2 workspace you want.
60+
cd ~/aerostack2_ws/src/aerostack2/as2_aerial_platforms
61+
git clone [email protected]:aerostack2/as2_platform_dji_osdk.git
62+
cd ~/aerostack2_ws
63+
rosdep install as2_platform_dji_osdk --from-paths src --ignore-src -r -y
64+
colcon build --packages-up-to as2_platform_dji_osdk
7765
7866
79-
.. _aerial_platform_dji_matrice_as2_common_interface:
67+
.. _aerial_platform_dji_matrice_osdk_as2_common_interface:
8068

8169
---------------------------
8270
Aerostack2 Common Interface
@@ -86,7 +74,7 @@ For more details about platform control modes and sensors, see :ref:`Aerostack2
8674

8775

8876

89-
.. _aerial_platform_dji_matrice_as2_common_interface_control_modes:
77+
.. _aerial_platform_dji_matrice_osdk_as2_common_interface_control_modes:
9078

9179
Control Modes
9280
=============
@@ -112,7 +100,8 @@ These are supported control modes:
112100

113101

114102

115-
.. _aerial_platform_dji_matrice_as2_common_interface_sensors:
103+
104+
.. _aerial_platform_dji_matrice_osdk_as2_common_interface_sensors:
116105

117106
Sensors
118107
=======
@@ -138,10 +127,12 @@ These are supported sensors:
138127
* - GPS
139128
- sensor_measurements/gps
140129
- sensor_msgs/NavSatFix
130+
* - Camera
131+
- sensor_measurements/camera
132+
- sensor_msgs/Image
141133

142134

143-
144-
.. _aerial_platform_dji_matrice_platform_launch:
135+
.. _aerial_platform_dji_matrice_osdk_platform_launch:
145136

146137
---------------
147138
Platform Launch
@@ -176,9 +167,11 @@ Aerostack2 DJI OSDK platform provides a launch file, which parameters are:
176167
- bool
177168
- Optional, default false. Use for simulation with `DJI Assistant 2 <https://www.dji.com/es/downloads/softwares/assistant-dji-2-for-matrice>`_.
178169

179-
Example of launch command:
170+
Aerostack2 provides a launch file for this platform:
180171

181172
.. code-block:: bash
182173
183174
ros2 launch as2_platform_dji_osdk as2_platform_dji_osdk_launch.py namespace:=drone1 dji_app_config:=UserConfig.txt
184175
176+
177+
To see all the **available parameters**, use the **'-s'** flag to show the description of each parameter in the launch file.

0 commit comments

Comments
 (0)