Skip to content

Commit c388e4a

Browse files
committed
Added initial documentation
1 parent 5a4ecff commit c388e4a

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

ur_controllers/doc/index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,3 +264,31 @@ Implementation details / dataflow
264264
* When the hardware reports that execution has been aborted (The ``passthrough_trajectory_abort``
265265
command interface), the action will be aborted.
266266
* When the action is preempted, execution on the hardware is preempted.
267+
268+
.. _freedrive_mode_controller:
269+
270+
ur_controllers/FreedriveModeController
271+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
272+
273+
This controller activates the robot's *Freedrive Mode*, allowing to freely manually move the robot.
274+
For such reason, the controller is never (and can't be) coupled with any other controller.
275+
276+
Parameters
277+
""""""""""
278+
279+
+----------------------------------+--------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
280+
| Parameter name | Type | Default value | Description |
281+
| | | | |
282+
+----------------------------------+--------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
283+
| ``tf_prefix`` | string | <empty> | Urdf prefix of the corresponding arm |
284+
+----------------------------------+--------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
285+
286+
Usage
287+
"""""
288+
289+
The controller provides the ``enable_freedrive_mode`` topic of type ``[std_msgs/msg/Bool]`` for handling activation and deactivation:
290+
291+
* to start and keep the freedrive active, it is necessary to continously publish a ``True`` msg on the indicated topic.
292+
To deal with malfunctioning on the client side, the controller deactivates the freedrive mode if messages
293+
are not received anymore within the ``timeout`` parameter.
294+
+ to deactivate the freedrive mode is enough to publish a ``False`` msg on the indicated topic or to deactivate the controller.

ur_robot_driver/doc/usage/controllers.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,10 @@ Type: `position_controllers/JointGroupPositionController <https://control.ros.or
110110
Allows setting target joint velocities directly. The user is responsible for sending commands that
111111
are achievable. This controller is particularly useful when doing servoing such as
112112
``moveit_servo``.
113+
114+
freedrive_mode_controller
115+
^^^^^^^^^^^^^^^^^^^^^^^^^
116+
117+
Type: :ref `ur_controllers/FreedriveModeController <freedrive_mode_controller>`
118+
119+
Allows utilizing the robot's *Freedrive mode*, making possible to manually move the robot in a desired configuration.

0 commit comments

Comments
 (0)