Skip to content

Add collision detector documentation#451

Merged
SteveMacenski merged 11 commits intoros-navigation:masterfrom
pixel-robotics:master
Aug 28, 2023
Merged

Add collision detector documentation#451
SteveMacenski merged 11 commits intoros-navigation:masterfrom
pixel-robotics:master

Conversation

@tonynajjar
Copy link
Copy Markdown
Contributor

@tonynajjar tonynajjar commented Aug 3, 2023

@tonynajjar tonynajjar changed the title Add collision detector docu Add collision detector documentation Aug 3, 2023
Tony Najjar added 3 commits August 3, 2023 12:42
Comment thread configuration/index.rst
Comment thread configuration/packages/configuring-collision-detector.rst Outdated
@tonynajjar
Copy link
Copy Markdown
Contributor Author

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

Comment thread configuration/packages/collision_monitor/configuring-collision-monitor-node.rst Outdated
@SteveMacenski
Copy link
Copy Markdown
Member

otherwise LGTM in general, but I'll let @AlexeyMerzlyakov review as well when he's back from vacation

Copy link
Copy Markdown
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.

I'll let Alexey approve the content of the subpages with the changes, but LGTM structurally

Comment thread configuration/packages/configuring-collision-monitor.rst Outdated
Comment thread configuration/packages/configuring-collision-monitor.rst Outdated
Comment thread configuration/packages/configuring-collision-monitor.rst Outdated
Comment thread configuration/packages/configuring-collision-monitor.rst Outdated
Comment thread configuration/packages/collision_monitor/configuring-collision-monitor-node.rst Outdated
Comment thread configuration/packages/collision_monitor/configuring-collision-detector-node.rst Outdated
Comment thread configuration/packages/collision_monitor/configuring-collision-detector-node.rst Outdated
Comment thread configuration/packages/collision_monitor/configuring-collision-detector-node.rst Outdated
@SteveMacenski
Copy link
Copy Markdown
Member

One last thing from me - add an entry in the migration guide page for the new node to show off to the users!

@tonynajjar
Copy link
Copy Markdown
Contributor Author

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 😄

Comment thread migration/Humble.rst Outdated
Comment thread migration/Iron.rst Outdated
@SteveMacenski
Copy link
Copy Markdown
Member

Just @AlexeyMerzlyakov 's comments left but I'm happy when he is

Copy link
Copy Markdown
Collaborator

@AlexeyMerzlyakov AlexeyMerzlyakov left a 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

Comment thread migration/Iron.rst
******************************************************

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. No newline at end of file
Copy link
Copy Markdown
Collaborator

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).

Comment thread migration/Iron.rst
******************************************************

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. No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
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).

@SteveMacenski SteveMacenski merged commit fa2cae6 into ros-navigation:master Aug 28, 2023
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.

3 participants