Skip to content

Commit 4e01d50

Browse files
authored
Just groot migration and params (#121)
* add Groot to foxy migration guide * add groot monitoring parameters to documentation * Update Migration * update bt_navigator params * fixes * make params just 2 columns :)
1 parent 2211b53 commit 4e01d50

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

configuration/packages/configuring-bt-navigator.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,42 @@ Parameters
5353
Description
5454
List of behavior tree node shared libraries.
5555

56+
:enable_groot_monitoring:
57+
58+
==== =======
59+
Type Default
60+
---- -------
61+
bool true
62+
==== =======
63+
64+
Description
65+
Enable live Groot monitoring of the current BT status.
66+
This is possible due to attaching a ZMQ server and publisher to the active behavior tree.
67+
68+
**Attention:** Groot will only work after the behavior tree is running, which means that the nav2 stack has to receive a goal first.
69+
70+
:groot_zmq_publisher_port:
71+
72+
====== =======
73+
Type Default
74+
------ -------
75+
int 1666
76+
====== =======
77+
78+
Description
79+
ZMQ publisher port for the Groot monitor. Used to consecutive publish the current status of the BT as flatbuffer.
80+
81+
:groot_zmq_server_port:
82+
83+
====== =======
84+
Type Default
85+
------ -------
86+
int 1667
87+
====== =======
88+
89+
Description
90+
ZMQ server port for the Groot monitor. Used to send the current bt factory + configuration as flatbuffer on an (empty) request by Groot.
91+
5692
:transform_tolerance:
5793

5894
====== ======= =======
@@ -118,6 +154,9 @@ Example
118154
global_frame: map
119155
robot_base_frame: base_link
120156
transform_tolerance: 0.1
157+
enable_groot_monitoring: True
158+
groot_zmq_publisher_port: 1666
159+
groot_zmq_server_port: 1667
121160
bt_xml_filename: replace/with/path/to/bt.xml
122161
plugin_lib_names:
123162
- nav2_compute_path_to_pose_action_bt_node

migration/Foxy.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ BackUp Recovery Interface Changes
2424
``target.x`` in a backup recovery goal should be positive indicating the distance to drive backward.
2525
In both cases negative values are silently inverted.
2626

27+
Groot Support
28+
*************
29+
30+
Live Monitoring and Editing of behavior trees with Groot is now possible.
31+
Switching bt-xmls on the fly through a new goal request is also included.
32+
This is all done without breaking any APIs.
33+
Enabled by default.
34+
2735
New Plugins
2836
***********
2937

0 commit comments

Comments
 (0)