Skip to content

Commit

Permalink
doc: added documentation for the smart RTH feature
Browse files Browse the repository at this point in the history
  • Loading branch information
vasarhelyi committed Mar 4, 2024
1 parent d39156b commit 7bc9826
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
Binary file modified doc/modules/ROOT/assets/images/panels/swarm/return_to_home.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions doc/modules/ROOT/pages/panels/formations/swarm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@ This button should be pressed after all formations of the show are inserted to t

CAUTION: It is not guaranteed that each drone will land at the same position where it took off from. In the vast majority of cases, they will land at a different position in the grid. This is intentional; safe collision-free trajectories are easier and faster to design when the software is free to choose which drone should occupy which landing position.

=== Smart return to home

If you intend to land each drone to its original home position, check the btn:[Use smart RTH] checkbox. This is an experimental/pro feature that attempts to create a special trajectory for each drone from its latest location to its original home position, without collisions, using the minimum distance safety checking threshold in its planner.

If you use the smart RTH option, you do not need to land your drones afterwards, as the landing process is an integrated part of the smart RTH manoeuvre. For the same reason, the layer height parameter is also neglected in this case.

CAUTION: it is not ensured that there is a smart RTH solution for each situation. If the planner fails to perform the operation, try reducing the minimum distance threshold or change the RTH altitude setting.

== Land

The btn:[Land] button lands the drones, starting from a given frame such that they move downwards in a straight line from their current position until they reach the given target altitude (ground is assumed to be at Z = 0). As usual, the _average_ velocity of the descent can be adjusted.
Expand Down

0 comments on commit 7bc9826

Please sign in to comment.