Skip to content

Commit 1b7e257

Browse files
committed
Update the default ports
Related to ros-navigation/navigation2#4060
1 parent d922833 commit 1b7e257

File tree

4 files changed

+88
-1
lines changed

4 files changed

+88
-1
lines changed

configuration/packages/bt-plugins/conditions/GloballyUpdatedGoal.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,31 @@ Returns failure if the goal is the same, if it changes, it returns success.
99
This node differs from the GoalUpdated by retaining the state of the current goal/goals throughout each tick of the BehaviorTree
1010
such that it will update on any "global" change to the goal.
1111

12+
Input Ports
13+
-----------
14+
15+
:goal:
16+
17+
=============================== =======
18+
Type Default
19+
------------------------------- -------
20+
geometry_msgs::msg::PoseStamped "{goal}"
21+
=============================== =======
22+
23+
Description
24+
Destination to check. Takes in a blackboard variable, "{goal}" if not specified.
25+
26+
:goals:
27+
28+
============================================ ========
29+
Type Default
30+
-------------------------------------------- -------
31+
std::vector<geometry_msgs::msg::PoseStamped> "{goals}"
32+
============================================ ========
33+
34+
Description
35+
Vector of goals to check. Takes in a blackboard variable, "{goals}" if not specified.
36+
1237
Example
1338
-------
1439

configuration/packages/bt-plugins/conditions/GoalUpdated.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,34 @@
33
GoalUpdated
44
===========
55

6-
Checks if the global navigation goal has changed in the blackboard.
6+
Checks if the global navigation goal, or a vector of goals, has changed in the blackboard.
77
Returns failure if the goal is the same, if it changes, it returns success.
88

9+
Input Ports
10+
-----------
11+
12+
:goal:
13+
14+
=============================== =======
15+
Type Default
16+
------------------------------- -------
17+
geometry_msgs::msg::PoseStamped "{goal}"
18+
=============================== =======
19+
20+
Description
21+
Destination to check. Takes in a blackboard variable, "{goal}" if not specified.
22+
23+
:goals:
24+
25+
============================================ ========
26+
Type Default
27+
-------------------------------------------- -------
28+
std::vector<geometry_msgs::msg::PoseStamped> "{goals}"
29+
============================================ ========
30+
31+
Description
32+
Vector of goals to check. Takes in a blackboard variable, "{goals}" if not specified.
33+
934
Example
1035
-------
1136

configuration/packages/bt-plugins/conditions/InitialPoseReceived.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ InitialPoseReceived
55

66
Node that returns success when the initial pose is sent to AMCL via `/initial_pose``.
77

8+
Input Ports
9+
-----------
10+
11+
:initial_pose_received:
12+
13+
===== =========================
14+
Type Default
15+
----- -------------------------
16+
bool "{initial_pose_received}"
17+
===== =========================
18+
19+
Description
20+
Success if the value in the port is true. Takes in a blackboard variable,
21+
"{initial_pose_received}" if not specified.
22+
823
Example
924
-------
1025

configuration/packages/bt-plugins/decorators/SpeedController.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,28 @@ Input Ports
6666
Description
6767
Duration (secs) over which robot velocity should be smoothed.
6868

69+
:goal:
70+
71+
=============================== =======
72+
Type Default
73+
------------------------------- -------
74+
geometry_msgs::msg::PoseStamped "{goal}"
75+
=============================== =======
76+
77+
Description
78+
Destination to check. Takes in a blackboard variable, "{goal}" if not specified.
79+
80+
:goals:
81+
82+
============================================ ========
83+
Type Default
84+
-------------------------------------------- -------
85+
std::vector<geometry_msgs::msg::PoseStamped> "{goals}"
86+
============================================ ========
87+
88+
Description
89+
Vector of goals to check. Takes in a blackboard variable, "{goals}" if not specified.
90+
6991
Example
7092
-------
7193

0 commit comments

Comments
 (0)