Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/controllers_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ Controllers for Manipulators and Other Robots
Admittance Controller <../admittance_controller/doc/userdoc.rst>
Effort Controllers <../effort_controllers/doc/userdoc.rst>
Forward Command Controller <../forward_command_controller/doc/userdoc.rst>
Gpio Command Controller <../gpio_controllers/doc/userdoc.rst>
Joint Trajectory Controller <../joint_trajectory_controller/doc/userdoc.rst>
Motion Primitive Controller <../motion_primitives_controllers/doc/userdoc.rst>
Parallel Gripper Controller <../parallel_gripper_controller/doc/userdoc.rst>
PID Controller <../pid_controller/doc/userdoc.rst>
Position Controllers <../position_controllers/doc/userdoc.rst>
Velocity Controllers <../velocity_controllers/doc/userdoc.rst>
Gpio Command Controller <../gpio_controllers/doc/userdoc.rst>
Motion Primitive Controller <../motion_primitives_controllers/userdoc.rst>

Broadcasters
**********************
Expand Down
53 changes: 53 additions & 0 deletions motion_primitives_controllers/doc/userdoc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
:github_url: https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/motion_primitives_controllers/doc/userdoc.rst

.. _motion_primitives_controllers_userdoc:

motion_primitive_controllers
==========================================

Package to control robots using motion primitives like LINEAR_JOINT (PTP/ MOVEJ), LINEAR_CARTESIAN (LIN/ MOVEL) and CIRCULAR_CARTESIAN (CIRC/ MOVEC)

.. warning::

There is no guarantee that the motion defined by the motion primitive will actually be executed exactly as planned. In particular, for motions in Cartesian space such as LIN primitives, it is not necessarily ensured that the robot will execute the motion exactly in that way, since the inverse kinematics is not always unique.

.. include:: README.md
:parser: myst_parser.sphinx_

Parameters
----------

These controllers use the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle their parameters.

Parameter of motion_primitives_forward_controller
.................................................

.. _definition_file_forward:

The parameter `definition file located in the src folder <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/motion_primitives_controllers/src/motion_primitives_forward_controller_parameter.yaml>`__ contains descriptions for all the parameters used by this controller.

.. generate_parameter_library_details:: ../src/motion_primitives_forward_controller_parameter.yaml

.. _test_file_forward:

An example parameter file for this controller can be found in `the test directory <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/motion_primitives_controllers/test/motion_primitives_forward_controller_params.yaml>`__:

.. literalinclude:: ../test/motion_primitives_forward_controller_params.yaml
:language: yaml


Parameter of motion_primitives_from_trajectory_controller
...........................................................

.. _definition_file_trajectory:

The parameter `definition file located in the src folder <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/motion_primitives_controllers/src/motion_primitives_from_trajectory_controller_parameter.yaml>`__ contains descriptions for all the parameters used by this controller.

.. generate_parameter_library_details:: ../src/motion_primitives_from_trajectory_controller_parameter.yaml

.. _test_file_trajectory:

An example parameter file for this controller can be found in `the test directory <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/motion_primitives_controllers/test/motion_primitives_from_trajectory_controller_params.yaml>`__:

.. literalinclude:: ../test/motion_primitives_from_trajectory_controller_params.yaml
:language: yaml
19 changes: 0 additions & 19 deletions motion_primitives_controllers/userdoc.rst

This file was deleted.