Nav2_tasks readme #141
Merged
Nav2_tasks readme #141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
approved these changes
Oct 6, 2018
bpwilcox
reviewed
Oct 10, 2018
nav2_tasks/README.md
Outdated
|
|
||
| The implementation of TaskClient and TaskServer is simplistic as the intention is to rely upon a ROS2 ActionLib (or equivalent) when it is available. | ||
|
|
||
| The current implementation uses four topics, one each for **Command**, **Cancel**, **Result**, and **Status** messages. The Command and Result messages are provided by the user of the classes, while the Result and Status messages are internal to the implementation. The Status message communicates whether a task has succeeded, failed, or has been canceled, while the Result message is used to return the result of the command, if successful. To keep things simple, the task library does not implement a feedback mechanism as the ROS1 ActionLib does. |
There was a problem hiding this comment.
Do you mean "The Command and Cancel messages are provided..."? I think you forgot to mention the Cancel topic.
There was a problem hiding this comment.
Yes, it should have said that "The Command and Result messages are provided by the user of the classes, while the Cancel and Status messages are internal to the implementation." I'm referring to the messages themselves. Perhaps this might be a bit confusing relative to the interface that the client uses (where one can use the client interface to send a command or cancel an active operation). I'll clarify this.
nav2_tasks/README.md
Outdated
|
|
||
| ## Overview | ||
|
|
||
| The Navigation2 architecture implements a *task hiearchy* where commands are sent to modules which are organized in a hierarchy. Each module implements a task and can utilize sub-tasks, which are themselves modules that implement tasks. |
ghost
suggested changes
Oct 10, 2018
|
@crdelsey Actually, I'm deleting the pyc file. I noticed that it was currently in master and getting rid of it. It must've snuck in with another commit. |
|
@bpwilcox Please have a look at the updated text discussing the messages. |
ghost
approved these changes
Oct 11, 2018
|
I thought we had just merged a change deleting the pyc file so I thought this must be adding it back. Sorry. |
ghost
pushed a commit
to logivations/navigation2
that referenced
this pull request
Mar 7, 2022
* pushrosnamespace in planner server * deactivate pushrosnamespace for new launchfiles Co-authored-by: Andrii Maistruk <andriy.maistruk@logivations.com>
mini-1235
pushed a commit
to mini-1235/navigation2
that referenced
this pull request
Feb 5, 2025
* corrected the BT example to the current one * fixed xml code block formatting * completed first portion of custom_bt tutorial * added NavigateWithReplanning explaination * added recovery fallback tutorial * Apply suggestions from Steve's code review Co-authored-by: Steve Macenski <stevenmacenski@gmail.com> * Added BT Custom Node Walk Through (ros-navigation#1) * adding reference to the getting started guide * fixed xml indentation * adding images, test to see how it renders * fixing XML, and BT rendering * adding overview of custom BT nodes * added pictures for pipeline sequence * fixed typos on image, and guide * added recovery node explaination * addding round robin explaination * getting rid of build folder and vscode folder * Editing, Added Explanation through Recovery subtree (ros-navigation#2) * Apply suggestions from code review Co-authored-by: Steve Macenski <stevenmacenski@gmail.com> * Update Foxy.rst * Nav through poses2: Adding parameters (ros-navigation#158) * adding documentation for nav through poses PR * adding new params for nav through poses * attempt at moving custom Nav2 BT nodes to it's own section * attempt to fix the pipe rendering issue * changing references so that they are navigate to pose with replanning and recovery * putting new page in a folder in an attempt to get the BT XML page working * fix page link for config guide, play around to render bullets * brushing up in response to comments * fixing link so that they lead directly to the specific nodes * correcting minor typos and comments * moving to main behavior tree section * fixing typo in index so that TOC works * trying relative path in case that fixes the link to nav2_specific_nodes * still trying to link to overview/specific_nodes * ok hopefully this is the final time here, successful link * fixing images Co-authored-by: Steve Macenski <stevenmacenski@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, there are many empty README.md files across the various directories. These are placeholders that we plan to populate during October as we work towards a functional stack. Each will contain background information for the particular package and a description of its contents. This particular PR is a first cut at the README file for the nav2_tasks directory. I created the diagram using LibreOffice Draw and exported it to a .svg file and checked in both to a doc subdirectory (is this how we want to do it?).