Skip to content

Commit 2ab5c92

Browse files
committed
modify documentation for parameter_bridge
Signed-off-by: Daisuke Sato <[email protected]>
1 parent 4da850c commit 2ab5c92

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Note that before `rostopic echo` would work with bridged topics, a subscriber mu
1414
You can use the `--bridge-all-2to1-topics` option to bridge all ROS 2 topics to ROS 1 so that tools such as `rostopic list` and `rqt` will see the topics even if there are no matching ROS 1 subscribers.
1515
Run `ros2 run ros1_bridge dynamic_bridge -- --help` for more options.
1616

17-
If you want to specify topics you want to bridge, run `ros2 run ros1_bridge parameter_bridge`. See [here](doc/parameter_bridge.rst) for more information.
17+
If you want to specify messages/services you want to bridge, run `ros2 run ros1_bridge parameter_bridge`. See [here](doc/parameter_bridge.rst) for more information.
1818

1919
## Prerequisites
2020

doc/parameter_bridge.rst

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1+
12
parameter_bridge configuration
23
==============================
34

45
You can launch parameter_bridge with the following command::
56
6-
ros2 run ros1_bridge parameter_bridge
7+
ros2 run ros1_bridge parameter_bridge [<topics_name> [<services_1_to_2_name> [<services_2_to_1_name>]]]
78

8-
Parameter bridge reads ``/topics`` parameter on ROS1 to make your bridge. Here is an example of configuration::
9+
Parameter bridge reads ``topics``, ``services_1_to_2``, and ``services_2_to_1`` parameters on ROS1 as default to make your bridge. You can specify the names of those parameters as arguments of the command. Here is an example of configuration::
910

1011
<rosparam>
1112
topics:
@@ -45,6 +46,16 @@ Parameter bridge reads ``/topics`` parameter on ROS1 to make your bridge. Here i
4546
transient_local: true
4647
reliable: true
4748
latch: true
49+
50+
services_1_to_2:
51+
-
52+
service: /gazebo/pause_physics
53+
type: std_srvs/srv/Empty
54+
55+
services_2_to_1:
56+
-
57+
service: /reinitialize_global_localization
58+
type: std_srvs/srv/Empty
4859
</rosparam>
4960

5061
Configuration Syntax
@@ -58,10 +69,19 @@ Configuration Syntax
5869
:widths: 20, 10, 10, 50
5970

6071
**topic**, YES, N/A, Name of the topic to bridge which is used in both ROS1/2
61-
**type**, YES, N/A, message type in ROS2 (see `here <./index.rst>`_ how to map ROS1 and ROS2 messages)
62-
**queue_size**, NO, 100, queue size used in both ROS1/2
72+
**type**, YES, N/A, Message type in ROS2 (see `here <./index.rst>`_ how to map ROS1 and ROS2 messages)
73+
**queue_size**, NO, 100, Queue size used in both ROS1/2
6374
**direction**, NO, bidirectionl, ``bidirectional`` or ``1to2`` or ``2to1``
64-
**transient_local**, NO, false, set ROS2 QoS durability profile transient_local (used both for 1to2 and 2to1)
65-
**reliable**, NO, false, set ROS2 QoS durability profile reliable (used both for 1to2 and 2to1)
66-
**latch**, NO, false, publish ROS1 message with latch option (used only for 2to1)
67-
75+
**transient_local**, NO, false, Set ROS2 QoS durability profile transient_local (used both for 1to2 and 2to1)
76+
**reliable**, NO, false, Set ROS2 QoS durability profile reliable (used both for 1to2 and 2to1)
77+
**latch**, NO, false, Publish ROS1 message with latch option (used only for 2to1)
78+
- **services_1_to_2**: <array of **service**>, ROS1 services will be available in ROS2
79+
- **services_2_to_1**: <array of **service**>, ROS2 services will be available in ROS1
80+
- **service**: <dict>
81+
82+
.. csv-table::
83+
:header: "key", "required", "description"
84+
:widths: 20, 10, 60
85+
86+
**service**, YES, Name of the service to bridge which is used in both ROS1/2
87+
**type**, YES, Service type in ROS2 (see `here <./index.rst>`_ how to map ROS1 and ROS2 messages)

0 commit comments

Comments
 (0)