Skip to content

Commit 13ba712

Browse files
committed
fix: motion_primitive_controller TOC in docs (#2216)
1 parent 2942d73 commit 13ba712

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

doc/controllers_index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ Controllers for Manipulators and Other Robots
4242
Admittance Controller <../admittance_controller/doc/userdoc.rst>
4343
Effort Controllers <../effort_controllers/doc/userdoc.rst>
4444
Forward Command Controller <../forward_command_controller/doc/userdoc.rst>
45+
Gpio Command Controller <../gpio_controllers/doc/userdoc.rst>
4546
Joint Trajectory Controller <../joint_trajectory_controller/doc/userdoc.rst>
47+
Motion Primitive Controller <../motion_primitives_controllers/doc/userdoc.rst>
4648
Parallel Gripper Controller <../parallel_gripper_controller/doc/userdoc.rst>
4749
PID Controller <../pid_controller/doc/userdoc.rst>
4850
Position Controllers <../position_controllers/doc/userdoc.rst>
4951
Velocity Controllers <../velocity_controllers/doc/userdoc.rst>
50-
Gpio Command Controller <../gpio_controllers/doc/userdoc.rst>
51-
Motion Primitive Controller <../motion_primitives_controllers/userdoc.rst>
5252

5353
Broadcasters
5454
**********************

motion_primitives_controllers/README.md renamed to motion_primitives_controllers/doc/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If multiple motion primitives are passed to the controller via the action, the c
1515

1616
The action interface also allows stopping the current execution of motion primitives. When a stop request is received, the controller sends `STOP_MOTION` to the hardware interface, which then halts the robot's movement. Once the controller receives confirmation that the robot has stopped, it sends `RESET_STOP` to the hardware interface. After that, new commands can be sent.
1717

18-
![Action Image](doc/Moprim_Controller_ExecuteMotion_Action.drawio.png)
18+
![Action Image](Moprim_Controller_ExecuteMotion_Action.drawio.png)
1919

2020
This can be done, for example, via a Python script as demonstrated in the [`example python script`](https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ur_robot_driver/examples/examples.py) in the `Universal_Robots_ROS2_Driver` package.
2121

@@ -49,14 +49,14 @@ These interfaces are used to communicate the internal status of the hardware int
4949
# Architecture Overview
5050
Architecture for a UR robot with [`Universal_Robots_ROS2_Driver` in motion primitives mode](https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver).
5151

52-
![UR Robot Architecture](doc/ros2_control_motion_primitives_ur.drawio.png)
52+
![UR Robot Architecture](ros2_control_motion_primitives_ur.drawio.png)
5353

5454
Architecture for a KUKA robot with [`kuka_eki_motion_primitives_hw_interface`](https://github.com/b-robotized-forks/kuka_experimental/tree/motion_primitive_kuka_driver/kuka_eki_motion_primitives_hw_interface).
5555

56-
![KUKA Robot Architecture](doc/ros2_control_motion_primitives_kuka.drawio.png)
56+
![KUKA Robot Architecture](ros2_control_motion_primitives_kuka.drawio.png)
5757

5858
# Demo-Video with UR10e
59-
[![UR demo video](doc/moprim_forward_controller_ur_demo_thumbnail.png)](https://youtu.be/SKz6LFvJmhQ)
59+
[![UR demo video](moprim_forward_controller_ur_demo_thumbnail.png)](https://youtu.be/SKz6LFvJmhQ)
6060

6161
# Demo-Video with KR3
62-
[![KUKA demo video](doc/moprim_forward_controller_kuka_demo_thumbnail.png)](https://youtu.be/_BWCO36j9bg)
62+
[![KUKA demo video](moprim_forward_controller_kuka_demo_thumbnail.png)](https://youtu.be/_BWCO36j9bg)

motion_primitives_controllers/userdoc.rst renamed to motion_primitives_controllers/doc/userdoc.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:github_url: https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/motion_primitives_controllers/userdoc.rst
1+
:github_url: https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/motion_primitives_controllers/doc/userdoc.rst
22

33
.. _motion_primitives_controllers_userdoc:
44

@@ -11,9 +11,9 @@ Parameters
1111

1212
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.
1313

14-
.. generate_parameter_library_details:: src/motion_primitives_forward_controller_parameter.yaml
14+
.. generate_parameter_library_details:: ../src/motion_primitives_forward_controller_parameter.yaml
1515

1616
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>`_:
1717

18-
.. literalinclude:: test/motion_primitives_forward_controller_params.yaml
18+
.. literalinclude:: ../test/motion_primitives_forward_controller_params.yaml
1919
:language: yaml

0 commit comments

Comments
 (0)