Skip to content

Commit bf9c5a3

Browse files
committed
docs: fix RST inline code backticks in userdoc.rst
1 parent 13ba712 commit bf9c5a3

File tree

2 files changed

+15
-65
lines changed

2 files changed

+15
-65
lines changed

motion_primitives_controllers/doc/README.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

motion_primitives_controllers/doc/userdoc.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,23 @@
33
.. _motion_primitives_controllers_userdoc:
44

55

6-
.. include:: README.md
7-
:parser: myst_parser.sphinx_
6+
motion_primitive_controllers
7+
==========================================
8+
9+
Package to control robots using motion primitives like LINEAR_JOINT (PTP/ MOVEJ), LINEAR_CARTESIAN (LIN/ MOVEL) and CIRCULAR_CARTESIAN (CIRC/ MOVEC)
10+
11+
Description
12+
-----------
13+
This project provides an interface for sending motion primitives to an industrial robot controller using the ``ExecuteMotionPrimitiveSequence.action`` action from ``control_msgs``. The controller receives the primitives via the action interface and forwards them through command interfaces to the robot-specific hardware interface. Currently, hardware interfaces for ``Universal Robots`` and ``KUKA Robots`` are implemented.
14+
15+
Supported motion primitives:
16+
17+
- ``LINEAR_JOINT``
18+
- ``LINEAR_CARTESIAN``
19+
- ``CIRCULAR_CARTESIAN``
820

921
Parameters
10-
,,,,,,,,,,,
22+
----------
1123

1224
This controller uses the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle its parameters. 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 the controller.
1325

0 commit comments

Comments
 (0)