Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI Testing Section #87

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions configuration/packages/configuring-bt-navigator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,43 @@ Parameters
Description
List of behavior tree node shared libraries.

:enable_groot_monitoring:

==== =======
Type Default
---- -------
bool false
==== =======

Description
Enable live Groot monitoring of the current BT status.
This is possible due to attaching a ZMQ server and publisher to the active behavior tree.
Consider checking out the :ref:`groot_introduction` tutorial for using this feature.

**Attention:** Groot will only work after the behavior tree is running, which means that the nav2 stack has to receive a goal first.

:groot_zmq_publisher_port:

====== ======= ======= ========
Type Default Unit Optional
------ ------- ------- --------
int 1666 Port yes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove these optional fields, any parameter with a default is technically optional. As well with unit, please stick with the format unless you'd like to update all of the parameters in all of the guides to this new format 😉

====== ======= ======= ========

Description
ZMQ publisher port for the Groot monitor. Used to consecutive publish the current status of the BT as flatbuffer.

:groot_zmq_server_port:

====== ======= ======= ========
Type Default Unit Optional
------ ------- ------- --------
int 1667 Port yes
====== ======= ======= ========

Description
ZMQ server port for the Groot monitor. Used to send the current bt factory + configuration as flatbuffer on an (empty) request by Groot.

:transform_tolerance:

====== ======= =======
Expand Down Expand Up @@ -118,6 +155,9 @@ Example
global_frame: map
robot_base_frame: base_link
transform_tolerance: 0.1
enable_groot_monitoring: True
groot_zmq_publisher_port: 1666
groot_zmq_server_port: 1667
bt_xml_filename: replace/with/path/to/bt.xml
plugin_lib_names:
- nav2_compute_path_to_pose_action_bt_node
Expand Down
249 changes: 0 additions & 249 deletions tutorials/docs/ci_testing.rst

This file was deleted.

Loading