Skip to content

Commit

Permalink
deploy: 566c54d
Browse files Browse the repository at this point in the history
  • Loading branch information
bmagyar committed Feb 2, 2024
1 parent c1b3bea commit 10cb638
Show file tree
Hide file tree
Showing 526 changed files with 3,129 additions and 8,222 deletions.
2 changes: 1 addition & 1 deletion foxy/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f1626b4ff27a3e5d30b6ca35f1ff1155
config: cd774d18d31bffe6f74bb80e980f4a22
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified foxy/.doctrees/doc/acknowledgements/acknowledgements.doctree
Binary file not shown.
Binary file modified foxy/.doctrees/doc/contributing/contributing.doctree
Binary file not shown.
Binary file not shown.
Binary file modified foxy/.doctrees/doc/getting_started/getting_started.doctree
Binary file not shown.
Binary file modified foxy/.doctrees/doc/project_ideas.doctree
Binary file not shown.
Binary file modified foxy/.doctrees/doc/resources/resources.doctree
Binary file not shown.
Binary file not shown.
Binary file modified foxy/.doctrees/doc/ros2_control/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified foxy/.doctrees/doc/ros2_control_demos/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified foxy/.doctrees/environment.pickle
Binary file not shown.
Binary file modified foxy/.doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion foxy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h2>Development Organisation and Communication<a class="headerlink" href="#devel
</dd>
</dl>
<hr class="docutils" />
<p>Built on 2024-02-01 at 05:31 GMT</p>
<p>Built on 2024-02-02 at 05:31 GMT</p>
</section>
</section>

Expand Down
2 changes: 1 addition & 1 deletion foxy/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion galactic/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 72d4582e4394b317fc22f88eb431cf85
config: 40a4f8d163df5f107573ae09595d6ddc
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified galactic/.doctrees/doc/acknowledgements/acknowledgements.doctree
Binary file not shown.
Binary file modified galactic/.doctrees/doc/contributing/contributing.doctree
Binary file not shown.
Binary file not shown.
Binary file modified galactic/.doctrees/doc/getting_started/getting_started.doctree
Binary file not shown.
Binary file modified galactic/.doctrees/doc/project_ideas.doctree
Binary file not shown.
Binary file modified galactic/.doctrees/doc/resources/resources.doctree
Binary file not shown.
Binary file not shown.
Binary file modified galactic/.doctrees/doc/ros2_control/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified galactic/.doctrees/doc/ros2_control_demos/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified galactic/.doctrees/environment.pickle
Binary file not shown.
Binary file modified galactic/.doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion galactic/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h2>Development Organisation and Communication<a class="headerlink" href="#devel
</dd>
</dl>
<hr class="docutils" />
<p>Built on 2024-02-01 at 05:31 GMT</p>
<p>Built on 2024-02-02 at 05:31 GMT</p>
</section>
</section>

Expand Down
2 changes: 1 addition & 1 deletion galactic/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion humble/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: c84497aa9f05080d4c38a18d8959b9e3
config: b6948b2b4a70019a0dd983ba20379872
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified humble/.doctrees/doc/acknowledgements/acknowledgements.doctree
Binary file not shown.
Binary file modified humble/.doctrees/doc/contributing/contributing.doctree
Binary file not shown.
Binary file not shown.
Binary file modified humble/.doctrees/doc/gazebo_ros2_control/doc/index.doctree
Binary file not shown.
Binary file modified humble/.doctrees/doc/getting_started/getting_started.doctree
Binary file not shown.
Binary file modified humble/.doctrees/doc/gz_ros2_control/doc/index.doctree
Binary file not shown.
Binary file modified humble/.doctrees/doc/project_ideas.doctree
Binary file not shown.
Binary file modified humble/.doctrees/doc/resources/resources.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified humble/.doctrees/doc/ros2_control/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified humble/.doctrees/doc/ros2_control_demos/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified humble/.doctrees/doc/simulators/simulators.doctree
Binary file not shown.
Binary file modified humble/.doctrees/doc/supported_robots/supported_robots.doctree
Binary file not shown.
Binary file modified humble/.doctrees/environment.pickle
Binary file not shown.
Binary file modified humble/.doctrees/index.doctree
Binary file not shown.
500 changes: 250 additions & 250 deletions humble/doc/acknowledgements/acknowledgements.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion humble/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ <h2>Development Organisation and Communication<a class="headerlink" href="#devel
</dd>
</dl>
<hr class="docutils" />
<p>Built on 2024-02-01 at 05:31 GMT</p>
<p>Built on 2024-02-02 at 05:31 GMT</p>
</section>
</section>

Expand Down
2 changes: 1 addition & 1 deletion humble/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion iron/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: eca82b042e799c4f53bbefe159a6f341
config: 62b9a6bef6f3668aed0829cef4f4bd59
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified iron/.doctrees/doc/acknowledgements/acknowledgements.doctree
Binary file not shown.
Binary file modified iron/.doctrees/doc/contributing/contributing.doctree
Binary file not shown.
Binary file not shown.
Binary file modified iron/.doctrees/doc/gazebo_ros2_control/doc/index.doctree
Binary file not shown.
Binary file modified iron/.doctrees/doc/getting_started/getting_started.doctree
Binary file not shown.
Binary file modified iron/.doctrees/doc/gz_ros2_control/doc/index.doctree
Binary file not shown.
Binary file modified iron/.doctrees/doc/project_ideas.doctree
Binary file not shown.
Binary file modified iron/.doctrees/doc/resources/resources.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified iron/.doctrees/doc/ros2_control/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified iron/.doctrees/doc/ros2_control_demos/doc/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified iron/.doctrees/doc/simulators/simulators.doctree
Binary file not shown.
Binary file modified iron/.doctrees/doc/supported_robots/supported_robots.doctree
Binary file not shown.
Binary file modified iron/.doctrees/environment.pickle
Binary file not shown.
Binary file modified iron/.doctrees/index.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ ROS 2 interface of the controller
Parameters
^^^^^^^^^^^

The admittance controller's 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}/admittance_controller/src/admittance_controller_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.
An example parameter file can be found in the `test folder of the controller <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/admittance_controller/test/test_params.yaml>`_
The admittance 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}/admittance_controller/src/admittance_controller_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.

.. generate_parameter_library_details:: ../src/admittance_controller_parameters.yaml

An example parameter file for this controller can be found in `the test folder <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/admittance_controller/test/test_params.yaml>`_:

.. literalinclude:: ../test/test_params.yaml
:language: yaml

Topics
^^^^^^^
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,12 @@ Publishers
Parameters
,,,,,,,,,,,,

Check `parameter definition file for details <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/diff_drive_controller/src/diff_drive_controller_parameter.yaml>`_.
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}/diff_drive_controller/src/diff_drive_controller_parameter.yaml>`_ contains descriptions for all the parameters used by the controller.

Note that the documentation on parameters for joint limits can be found in `their header file <https://github.com/ros-controls/ros2_control/blob/{REPOS_FILE_BRANCH}/joint_limits/include/joint_limits/joint_limits_rosparam.hpp#L56-L75>`_.
Those parameters are:
.. generate_parameter_library_details:: ../src/diff_drive_controller_parameter.yaml
parameters_context.yaml

linear.x [JointLimits structure]
Joint limits structure for the linear X-axis.
The limiter ignores position limits.
For details see ``joint_limits`` package from ros2_control repository.
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}/diff_drive_controller/test/config/test_diff_drive_controller.yaml>`_:

angular.z [JointLimits structure]
Joint limits structure for the rotation about Z-axis.
The limiter ignores position limits.
For details see ``joint_limits`` package from ros2_control repository.
.. literalinclude:: ../test/config/test_diff_drive_controller.yaml
:language: yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,17 @@ The controller is a wrapper around ``ForceTorqueSensor`` semantic component (see

Parameters
^^^^^^^^^^^
The interfaces can be defined in two ways, using ``sensor_name`` or ``interface_names`` parameter.
Those two parameters can not be defined at the same time
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}/force_torque_sensor_broadcaster/src/force_torque_sensor_broadcaster_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.

frame_id (mandatory)
Frame in which the output message will be published.
The interfaces can be defined in two ways, using the ``sensor_name`` or the ``interface_names`` parameter:
Those two parameters cannot be defined at the same time.

sensor_name (optional)
Defines sensor name used as prefix for its interfaces.
If used standard interface names for a 6D FTS will be used: <sensor_name>/force.x, ..., <sensor_name>/torque.z.
Full list of parameters:

interface_names.[force|torque].[x|y|z] (optional)
Defines custom, per axis interface names.
This is used if different prefixes, i.e., sensor name, or non-standard interface names are used.
It is sufficient that only one ``interface_name`` is defined.
This enables broadcaster use for force sensing cells with less then six measuring axes.
Example definition is:
.. generate_parameter_library_details:: ../src/force_torque_sensor_broadcaster_parameters.yaml
parameters_context.yaml

.. code-block:: yaml
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}/force_torque_sensor_broadcaster/test/force_torque_sensor_broadcaster_params.yaml>`_:

interface_names:
force:
x: example_name/example_interface
.. literalinclude:: ../test/force_torque_sensor_broadcaster_params.yaml
:language: yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,23 @@
Gripper Action Controller
--------------------------------

Controller for executing a gripper command action for simple single-dof grippers.
Controllers for executing a gripper command action for simple single-dof grippers:

- ``position_controllers/GripperActionController``
- ``effort_controllers/GripperActionController``

Parameters
^^^^^^^^^^^
This controller uses the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle its parameters.
These controllers use 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}/gripper_controllers/src/gripper_action_controller_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.

List of parameters
=========================

.. generate_parameter_library_details:: ../src/gripper_action_controller_parameters.yaml


An example parameter file
=========================

.. generate_parameter_library_default::
../src/gripper_action_controller_parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ The controller is a wrapper around ``IMUSensor`` semantic component (see ``contr

Parameters
^^^^^^^^^^^
This controller uses the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle its parameters.
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}/imu_sensor_broadcaster/src/imu_sensor_broadcaster_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.

List of parameters
=========================
.. generate_parameter_library_details:: ../src/imu_sensor_broadcaster_parameters.yaml


An example parameter file
=========================

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}/imu_sensor_broadcaster/test/imu_sensor_broadcaster_params.yaml>`_:

.. literalinclude:: ../test/imu_sensor_broadcaster_params.yaml
:language: yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,70 +22,19 @@ If none of the requested interface are not defined, the controller returns error

Parameters
----------
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}/joint_state_broadcaster/src/joint_state_broadcaster_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.

use_local_topics
Optional parameter (boolean; default: ``False``) defining if ``joint_states`` and ``dynamic_joint_states`` messages should be published into local namespace, e.g., ``/my_state_broadcaster/joint_states``.

List of parameters
,,,,,,,,,,,,,,,,,,

joints
Optional parameter (string array) to support broadcasting of only specific joints and interfaces.
It has to be used in combination with the ``interfaces`` parameter.
Joint state broadcaster asks for access to all defined interfaces on all defined joints.
.. generate_parameter_library_details::
../src/joint_state_broadcaster_parameters.yaml
joint_state_broadcaster_parameter_context.yml


interfaces
Optional parameter (string array) to support broadcasting of only specific joints and interfaces.
It has to be used in combination with the ``joints`` parameter.
An example parameter file
,,,,,,,,,,,,,,,,,,,,,,,,,


extra_joints
Optional parameter (string array) with names of extra joints to be added to ``joint_states`` and ``dynamic_joint_states`` with state set to 0.


map_interface_to_joint_state
Optional parameter (map) providing mapping between custom interface names to standard fields in ``joint_states`` message.
Usecases:

1. Hydraulics robots where feedback and commanded values often have an offset and reliance on open-loop control is common.
Typically one would map both values in separate interfaces in the framework.
To visualize those data multiple joint_state_broadcaster instances and robot_state_publishers would be used to visualize both values in RViz.

1. A robot provides multiple measuring techniques for its joint values which results in slightly different values.
Typically one would use separate interface for providing those values in the framework.
Using multiple joint_state_broadcaster instances we could publish and show both in RViz.

Format (each line is optional):

.. code-block:: yaml
map_interface_to_joint_state:
position: <custom_interface>
velocity: <custom_interface>
effort: <custom_interface>
Examples:

.. code-block:: yaml
map_interface_to_joint_state:
position: kf_estimated_position
.. code-block:: yaml
map_interface_to_joint_state:
velocity: derived_velocity
effort: derived_effort
.. code-block:: yaml
map_interface_to_joint_state:
effort: torque_sensor
.. code-block:: yaml
map_interface_to_joint_state:
effort: current_sensor
.. generate_parameter_library_default::
../src/joint_state_broadcaster_parameters.yaml
Loading

0 comments on commit 10cb638

Please sign in to comment.