diff --git a/hardware_interface/doc/asynchronous_components.rst b/hardware_interface/doc/asynchronous_components.rst index c73281c3fe..d0a8f1ed2c 100644 --- a/hardware_interface/doc/asynchronous_components.rst +++ b/hardware_interface/doc/asynchronous_components.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/ros-controls/ros2_control/blob/{REPOS_FILE_BRANCH}/hardware_interface/doc/different_update_rates_userdoc.rst +:github_url: https://github.com/ros-controls/ros2_control/blob/{REPOS_FILE_BRANCH}/hardware_interface/doc/asynchronous_components.rst .. _asynchronous_components: diff --git a/hardware_interface/doc/hardware_components_userdoc.rst b/hardware_interface/doc/hardware_components_userdoc.rst index 3870433ef0..6b6d40914b 100644 --- a/hardware_interface/doc/hardware_components_userdoc.rst +++ b/hardware_interface/doc/hardware_components_userdoc.rst @@ -18,6 +18,7 @@ Guidelines and Best Practices Writing a Hardware Component Different Update Rates Asynchronous Execution + Semantic Components Handling of errors that happen during read() and write() calls diff --git a/hardware_interface/doc/hardware_interface_types_userdoc.rst b/hardware_interface/doc/hardware_interface_types_userdoc.rst index 45141e5479..f0b7ce36ae 100644 --- a/hardware_interface/doc/hardware_interface_types_userdoc.rst +++ b/hardware_interface/doc/hardware_interface_types_userdoc.rst @@ -54,10 +54,7 @@ Sensors ***************************** ````-tag groups multiple state interfaces describing, e.g., internal states of hardware. -Depending on the type of sensor, there exist a couple of specific semantic components with broadcasters shipped with ros2_controllers, e.g. - -- :ref:`Imu Sensor Broadcaster ` -- :ref:`Force Torque Sensor Broadcaster ` +Depending on the type of sensor, there exist a couple of specific semantic components with broadcasters shipped with ros2_controllers, see details in the :ref:`semantic_components `. GPIOs ***************************** diff --git a/hardware_interface/doc/semantic_components.rst b/hardware_interface/doc/semantic_components.rst new file mode 100644 index 0000000000..1991270170 --- /dev/null +++ b/hardware_interface/doc/semantic_components.rst @@ -0,0 +1,20 @@ +:github_url: https://github.com/ros-controls/ros2_control/blob/{REPOS_FILE_BRANCH}/hardware_interface/doc/semantic_components.rst + +.. _semantic_components: + +Semantic Components +--------------------------------------------------------- + +In order to streamline the configuration of commonly used hardware interface, so-called semantic components can be used to wrap mechanisms to claim / release the interfaces. The base components ``semantic_components::SemanticComponentInterface`` and ``semantic_components::SemanticComponentCommandInterface`` are used to define semantic components for read-only and write-only devices, respectively. + +List of existing ``SemanticComponentInterface`` `(link to header file) `__ and associated broadcaster, if any: + + * `IMUSensor `__, used by :ref:`IMU Sensor Broadcaster ` + * `ForceTorqueSensor `__, used by :ref:`Force Torque Sensor Broadcaster ` + * `GPSSensor `__ + * `PoseSensor `__, used by :ref:`Pose Broadcaster ` + * `RangeSensor `__, used by :ref:`Range Sensor Broadcaster ` + +List of existing ``SemanticComponentCommandInterface`` `(link to header file) `__ and associated controller, if any: + + * `LedRgbDevice `__