Skip to content

Commit e3e1b3f

Browse files
Update docs and maintainers (#65)
1 parent 9ca705d commit e3e1b3f

File tree

6 files changed

+9
-5
lines changed

6 files changed

+9
-5
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ If you are new to the project, please read the [contributing guide](https://cont
1212
## Content
1313

1414
- [JointState Topic Hardware Interface](joint_state_topic_hardware_interface/README.md)
15+
- [Controller Manager Topic Hardware Interface](doc/index.rst#cm_topic_hardware_component)
1516

1617
## Build status
1718

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# cm_topic_hardware_component
2+
A ros2_control hardware component using pal_statistics messages from controller_manager introspection
23

34
See doc/index.rst

cm_topic_hardware_component/cm_topic_hardware_component_plugin_description.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
base_class_type="hardware_interface::SystemInterface"
66
>
77
<description>
8-
ros2_control hardware interface for CM topic based control.
8+
A ros2_control hardware component that uses pal_statistics messages published by the controller_manager for introspection.
99
</description>
1010
</class>
1111
</library>

cm_topic_hardware_component/package.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
<package format="3">
33
<name>cm_topic_hardware_component</name>
44
<version>0.2.0</version>
5-
<description>ros2_control hardware interface using pal_statistics messages</description>
5+
<description>ros2_control hardware component using pal_statistics messages from controller_manager introspection</description>
66

77
<maintainer email="marq.razz@gmail.com">Marq Rasmussen</maintainer>
88
<maintainer email="jafar.uruc@gmail.com">Jafar Uruc</maintainer>
99
<maintainer email="bence.magyar.robotics@gmail.com">Bence Magyar</maintainer>
10+
<maintainer email="christoph.froehlich@ait.ac.at">Christoph Froehlich</maintainer>
1011

1112
<author email="christoph.froehlich@ait.ac.at">Christoph Froehlich</author>
1213

doc/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
topic_based_hardware_interfaces
44
###############################
5-
The Joint State Topic Based System implements a ros2_control ``hardware_interface::SystemInterface`` supporting command and state interfaces through the ROS topic communication layer.
65

76
.. include:: ../joint_state_topic_hardware_interface/README.md
87
:parser: myst_parser.sphinx_
98

109
cm_topic_hardware_component
1110
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12-
The CM Topic System implements a ros2_control ``hardware_interface::SystemInterface`` subscribing to
13-
topics of type ``pal_statistics_msgs::msg::StatisticsNames`` and ``pal_statistics_msgs::msg::StatisticsValues``,
11+
The controller_manager topic System implements a ros2_control ``hardware_interface::SystemInterface`` that subscribes
12+
to topics of type ``pal_statistics_msgs::msg::StatisticsNames`` and ``pal_statistics_msgs::msg::StatisticsValues``,
1413
and sets its state interface to the received values (if present).
1514

1615
Per default, the ros2_control controller manager publishes these topics to ``/controller_manager/introspection_data/names``

joint_state_topic_hardware_interface/package.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
<maintainer email="marq.razz@gmail.com">Marq Rasmussen</maintainer>
1010
<maintainer email="jafar.uruc@gmail.com">Jafar Uruc</maintainer>
1111
<maintainer email="bence.magyar.robotics@gmail.com">Bence Magyar</maintainer>
12+
<maintainer email="christoph.froehlich@ait.ac.at">Christoph Froehlich</maintainer>
13+
1214
<author email="jafar.uruc@gmail.com">Jafar Uruc</author>
1315
<author email="marq.razz@gmail.com">Marq Rasmussen</author>
1416

0 commit comments

Comments
 (0)