-
Notifications
You must be signed in to change notification settings - Fork 196
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 collision detector documentation #451
Conversation
Done I believe. Sorry if it's not as verbose as you would wish but I really need to move on with this contribution; it took much more time than expected |
configuration/packages/collision_monitor/configuring-collision-monitor-node.rst
Outdated
Show resolved
Hide resolved
configuration/packages/collision_monitor/configuring-collision-monitor-node.rst
Show resolved
Hide resolved
otherwise LGTM in general, but I'll let @AlexeyMerzlyakov review as well when he's back from vacation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll let Alexey approve the content of the subpages with the changes, but LGTM structurally
configuration/packages/collision_monitor/configuring-collision-monitor-node.rst
Outdated
Show resolved
Hide resolved
configuration/packages/collision_monitor/configuring-collision-detector-node.rst
Outdated
Show resolved
Hide resolved
configuration/packages/collision_monitor/configuring-collision-detector-node.rst
Outdated
Show resolved
Hide resolved
configuration/packages/collision_monitor/configuring-collision-detector-node.rst
Outdated
Show resolved
Hide resolved
One last thing from me - add an entry in the migration guide page for the new node to show off to the users! |
Added for Jazzy and Iron, so now we have to backport to Iron 😄 |
Just @AlexeyMerzlyakov 's comments left but I'm happy when he is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nitpick comment and it is ready to-go
****************************************************** | ||
|
||
In this `PR #3693 <https://github.com/ros-planning/navigation2/pull/3500>`_ A new node was introduced in the nav2_collision_monitor: Collision Detector. | ||
It works similarly to the Collision Monitor, but does not affect the robot's velocity. It will only inform that data from the configured sources has been detected within the configured polygons via message to the ``collision_detector_state`` topic. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... that might be used by any external module (e.g. switching LED or sound alarm in case of collision).
****************************************************** | ||
|
||
In this `PR #3693 <https://github.com/ros-planning/navigation2/pull/3500>`_ A new node was introduced in the nav2_collision_monitor: Collision Detector. | ||
It works similarly to the Collision Monitor, but does not affect the robot's velocity. It will only inform that data from the configured sources has been detected within the configured polygons via message to the ``collision_detector_state`` topic. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It works similarly to the Collision Monitor, but does not affect the robot's velocity. It will only inform that data from the configured sources has been detected within the configured polygons via message to the ``collision_detector_state`` topic. | |
It works similarly to the Collision Monitor, but does not affect the robot's velocity. It will only inform that data from the configured sources has been detected within the configured polygons via message to the ``collision_detector_state`` topic that might be used by any external module (e.g. switching LED or sound alarm in case of collision). |
ros-navigation/navigation2#3500