Skip to content

Commit 7bc8df1

Browse files
committed
Update controller documentation
1 parent f5bcaea commit 7bc8df1

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

ur_controllers/doc/index.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -384,12 +384,16 @@ The controller provides the ``~/enable_freedrive_mode`` topic of type ``[std_msg
384384

385385
ur_controllers/ToolContactController
386386
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
387-
This controller can enable tool contact on the robot. When tool contact is enabled,
388-
and the robot senses that the tool has made contact with something, it will stop all motion,
389-
and retract to where it first sensed the contact.
387+
This controller can enable tool contact on the robot. When tool contact is enabled, and the robot
388+
senses whether the tool has made contact with something. When that happens, it will stop all
389+
motion, and retract to where it first sensed the contact.
390+
390391
This controller can be used with any of the motion controllers.
391-
This is not a complete interface of the URScript function ``tool_contact(direction)``, as it does not allow for choosing the direction.
392-
The direction of tool contact will always be the current TCP direction of movement.
392+
393+
The controller is not a direct representation of the URScript function `tool_contact(direction)
394+
<https://www.universal-robots.com/manuals/EN/HTML/SW5_21/Content/prod-scriptmanual/all_scripts/tool_contact(direction).htm?Highlight=tool_contact>`_,
395+
as it does not allow for choosing the direction. The direction of tool contact will always be the
396+
current TCP direction of movement.
393397

394398
Parameters
395399
""""""""""
@@ -409,11 +413,12 @@ The controller provides one action for enabling tool contact. For the controller
409413

410414
* ``~/detect_tool_contact [ur_msgs/action/ToolContact]``
411415

412-
The action definition of ``ur_msgs/action/ToolContact`` has no fields, as a call to the action implicitly means that tool contact should be enabled.
413-
The result of the action is available through the status of the action itself. If the action succeeds it means that tool contact was detected, otherwise tool contact will remain active until it is either cancelled by the user, or aborted by the hardware.
414-
The action provides no feedback.
416+
The action definition of ``ur_msgs/action/ToolContact`` has no fields, as a call to the action implicitly means that tool contact should be enabled.
417+
The result of the action is available through the status of the action itself. If the action succeeds it means that tool contact was detected, otherwise tool contact will remain active until it is either cancelled by the user, or aborted by the hardware.
418+
The action provides no feedback.
415419

416-
The action can be called from the command line using the following command, when the controller is active:
417-
.. code-block::
420+
The action can be called from the command line using the following command, when the controller is active:
421+
422+
.. code-block::
418423
419-
ros2 action send_goal /tool_contact_controller/detect_tool_contact ur_msgs/action/ToolContact
424+
ros2 action send_goal /tool_contact_controller/detect_tool_contact ur_msgs/action/ToolContact

0 commit comments

Comments
 (0)