Skip to content

Commit c762553

Browse files
author
Guillaume Doisy
committed
bt docs
Signed-off-by: Guillaume Doisy <guillaume@dexory.com>
1 parent e440526 commit c762553

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

configuration/packages/bt-plugins/actions/ComputePathToPose.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,18 @@ Input Ports
1919
===================================== =======
2020

2121
Description
22-
Start pose. Optional. Only used if not left empty. Takes in a blackboard variable, e.g. "{start}".
22+
Start pose. Optional. Used as the planner start pose instead of the current robot pose, if ``use_start`` is not false (i.e. not provided or set to true). Takes in a blackboard variable, e.g. "{start}".
23+
24+
:use_start:
25+
26+
===================================== =======
27+
Type Default
28+
------------------------------------- -------
29+
geometry_msgs::msg::PoseStamped N/A
30+
===================================== =======
31+
32+
Description
33+
Optional. For using or not using (i.e. ignoring) the provided start pose ``start``. Takes in a blackboard variable, e.g. "{use_start}".
2334

2435
:goal:
2536

0 commit comments

Comments
 (0)