diff --git a/hardware_interface/doc/mock_components_userdoc.rst b/hardware_interface/doc/mock_components_userdoc.rst index 312d789712..9c9e30dd8b 100644 --- a/hardware_interface/doc/mock_components_userdoc.rst +++ b/hardware_interface/doc/mock_components_userdoc.rst @@ -27,26 +27,71 @@ Features: Parameters ,,,,,,,,,, +A full example including all optional parameters (with default values): + +.. code-block:: xml + + + + mock_components/GenericSystem + false + + false + false + false + 0.0 + + + + + + 3.45 + + + + + + + + + 2.78 + + + + + + + + + + + +See :ref:`example_2 ` for an example using ``calculate_dynamics`` or :ref:`example_10 ` for using in combination with GPIO interfaces. + +Component Parameters +#################### + +calculate_dynamics (optional; boolean; default: false) + Calculation of states from commands by using Euler-forward integration or finite differences. + +custom_interface_with_following_offset (optional; string; default: "") + Mapping of offsetted commands to a custom interface. + disable_commands (optional; boolean; default: false) Disables mirroring commands to states. This option is helpful to simulate an erroneous connection to the hardware when nothing breaks, but suddenly there is no feedback from a hardware interface. Or it can help you to test your setup when the hardware is running without feedback, i.e., in open loop configuration. +mock_gpio_commands (optional; boolean; default: false) + Creates fake command interfaces for faking GPIO states with an external command. + Those interfaces are usually used by a :ref:`forward controller ` to provide access from ROS-world. + mock_sensor_commands (optional; boolean; default: false) Creates fake command interfaces for faking sensor measurements with an external command. Those interfaces are usually used by a :ref:`forward controller ` to provide access from ROS-world. -disable_commands (optional; boolean; default: false) - Disables mirroring commands to states. - This option is helpful to simulate an erroneous connection to the hardware when nothing breaks, but suddenly there is no feedback from a hardware interface. - Or it can help you to test your setup when the hardware is running without feedback, i.e., in open loop configuration. - position_state_following_offset (optional; double; default: 0.0) - Following offset added to the commanded values when mirrored to states. - - -custom_interface_with_following_offset (optional; string; default: "") - Mapping of offsetted commands to a custom interface. + Following offset added to the commanded values when mirrored to states. Only applied, if ``custom_interface_with_following_offset`` is false. Per-joint Parameters