Skip to content

Commit 30473a5

Browse files
Fix docs for motion_primitive_controllers (#1877)
1 parent bca1a99 commit 30473a5

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

motion_primitives_controllers/README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,6 @@ These interfaces are used to communicate the internal status of the hardware int
4646
- `STOPPED`: The robot was stopped using the `STOP_MOTION` command and must be reset with the `RESET_STOP` command before executing new commands.
4747
- `ready_for_new_primitive`: Boolean flag indicating whether the interface is ready to receive a new motion primitive
4848

49-
50-
## Parameters
51-
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/master/motion_primitives_controllers/src/motion_primitives_forward_controller_parameter.yaml) contains descriptions for all the parameters used by the controller.
52-
An example parameter file for this controller can be found in [the test directory](https://github.com/ros-controls/ros2_controllers/blob/master/motion_primitives_controllers/test/motion_primitives_forward_controller_params.yaml).
53-
54-
5549
# Architecture Overview
5650
Architecture for a UR robot with [`Universal_Robots_ROS2_Driver` in motion primitives mode](https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver).
5751

motion_primitives_controllers/src/motion_primitives_forward_controller_parameter.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ motion_primitives_forward_controller:
22
tf_prefix: {
33
type: string,
44
default_value: "",
5-
description: "tf_prefix",
5+
description: "All interfaces use the naming scheme `tf_prefix_ + motion_primitive/<interface name>`",
66
read_only: true,
77
}

motion_primitives_controllers/userdoc.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,17 @@
33
.. _motion_primitives_controllers_userdoc:
44

55

6-
.. include:: ../README.md
6+
.. include:: README.md
77
:parser: myst_parser.sphinx_
8+
9+
Parameters
10+
,,,,,,,,,,,
11+
12+
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.
13+
14+
.. generate_parameter_library_details:: src/motion_primitives_forward_controller_parameter.yaml
15+
16+
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>`_:
17+
18+
.. literalinclude:: test/motion_primitives_forward_controller_params.yaml
19+
:language: yaml

0 commit comments

Comments
 (0)