@@ -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.
0 commit comments