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

Plugin container layer docs #615

Merged

Conversation

alexanderjyuen
Copy link
Contributor

Added documentation for plugin container layer

Copy link
Member

@SteveMacenski SteveMacenski left a comment

Choose a reason for hiding this comment

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

Just add to the migration guide that "hey we have a new layer, here's why its nice, check out the configuration guide" with a link. Its a promotion :-)

plugins/index.rst Outdated Show resolved Hide resolved
tuning/index.rst Outdated Show resolved Hide resolved
@alexanderjyuen
Copy link
Contributor Author

Example image updated

combination_method: 1
plugins: ["static_layer", "inflation_layer"]
static_layer:
plugin: "nav2_costmap_2d::StaticLayer"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@SteveMacenski if the plugin type is explicitly defined in each constituent layer, do I still need an parameter for plugin_types

Copy link
Member

@SteveMacenski SteveMacenski Dec 11, 2024

Choose a reason for hiding this comment

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

Its not defined in the layer as I mentioned. Your util that loads the plugin (https://github.com/ros-navigation/navigation2/blob/684a4d037241674550b756c5014711fa6c13e35e/nav2_util/include/nav2_util/node_utils.hpp#L136) itself defines that .plugin parameter so it can read the string of the plugin class in order to load it. That is a parameter that you have actually added by using get_plugin_type_param. Yes, this is important to add as a parameter in the parameter guide and in this example YAML

@SteveMacenski
Copy link
Member

Otherwise, with that missing parameter + fixing DCO, I can merge this and the PR!

@alexanderjyuen alexanderjyuen force-pushed the plugin_container_layer_docs branch 3 times, most recently from 9985400 to 4d79a9a Compare December 11, 2024 22:49
@alexanderjyuen alexanderjyuen force-pushed the plugin_container_layer_docs branch from 4d79a9a to 1a9891a Compare December 11, 2024 23:14
Signed-off-by: alexander <[email protected]>
@alexanderjyuen alexanderjyuen force-pushed the plugin_container_layer_docs branch from 1a9891a to 780452e Compare December 11, 2024 23:15
@SteveMacenski SteveMacenski merged commit 560f511 into ros-navigation:master Dec 13, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants