Skip to content
3 changes: 3 additions & 0 deletions doc/parameters/param_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,11 @@ When `plugins` parameter is not overridden, the following default plugins are lo
| ----------| --------| ------------|
| controller_frequency | 20.0 | Frequency to run controller |
| progress_checker_plugin | "progress_checker" | Check the progress of the robot |
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we explain what is meant by progress?

Copy link
Member

Choose a reason for hiding this comment

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

Can you provide a suggested text?

Copy link
Contributor

Choose a reason for hiding this comment

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

Plugin used by the controller to check whether the robot has at least covered a set distance/displacement in a set amount of time, thus checking the progress of the robot. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

| progress_checker.plugin | "nav2_controller::SimpleProgressChecker" | Default plugin |
Copy link
Contributor

Choose a reason for hiding this comment

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

Along side mentioning that this is default plugin class for progress_checker, can we mention that "progress_checker" in progress_checker.plugin parameter name is coming from the progress_checker_plugin parameter? And that it should correspond to whatever plugin class name intended to be used.

Copy link
Contributor Author

@siddhya siddhya Jul 17, 2020

Choose a reason for hiding this comment

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

Ya I was wondering what the right convention is here. <progress checker_plugin>.plugin?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah that would work - I think you could also just check what was done for the planner / controller plugins that were already updated and just mirror it

Copy link
Contributor Author

@siddhya siddhya Jul 20, 2020

Choose a reason for hiding this comment

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

Done. No other .plugin param is mentioned in this file yet.

| goal_checker_plugin | "goal_checker" | Check if the goal has been reached |
| goal_checker.plugin | "nav2_controller::SimpleGoalChecker" | Default plugin |
Copy link
Contributor

Choose a reason for hiding this comment

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

Same

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

| controller_plugins | ["FollowPath"] | List of mapped names for controller plugins for processing requests and parameters |
| FollowPath.plugin | "dwb_core::DWBLocalPlanner" | Default plugin |
| min_x_velocity_threshold | 0.0001 | Minimum X velocity to use (m/s) |
| min_y_velocity_threshold | 0.0001 | Minimum Y velocity to use (m/s) |
| min_theta_velocity_threshold | 0.0001 | Minimum angular velocity to use (rad/s) |
Expand Down