Skip to content

Commit 992d48b

Browse files
committed
updated README.md
1 parent 93eb126 commit 992d48b

File tree

2 files changed

+34
-25
lines changed

2 files changed

+34
-25
lines changed

README.md

+33-24
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can find them [here](docker).
88
## Requirements
99

1010
- [ROS2 Bouncy](https://index.ros.org/doc/ros2/Installation/)
11-
11+
1212

1313
## Building the examples
1414

@@ -28,7 +28,7 @@ For more detailed build instructions look [here](build_ros2_packages.md)
2828

2929
For each of the following tests, run the each command in a separate terminal window (remember that ROS2 SDK has to be sourced in every terminal!)
3030

31-
#### Publisher/Subscriber test
31+
#### Publisher/Subscriber
3232
```
3333
$ ros2 run simple_publisher publisher_main
3434
```
@@ -38,7 +38,7 @@ For each of the following tests, run the each command in a separate terminal win
3838
One process publishes messages and the other subscribes to that topic.
3939

4040

41-
#### Service/Client test
41+
#### Service/Client
4242
```
4343
$ ros2 run simple_service service_main
4444
```
@@ -47,9 +47,18 @@ One process publishes messages and the other subscribes to that topic.
4747
```
4848

4949
One process provides a service and the other requests it.
50-
The executable `asynchronous_main` contains an alternative implementation for the ROS2 client.
5150

52-
#### Time Synchronization message filters test
51+
Running `simple_client/timer_main` contains an alternative implementation for the ROS2 client node.
52+
53+
#### Logger utils
54+
```
55+
$ ros2 run simple_logger logger_main
56+
```
57+
58+
Log some data. Change the logger verbosity level at run time. Log some other data.
59+
60+
61+
#### Time Synchronization message filters
5362
```
5463
$ ros2 run simple_time_sync publisher
5564
```
@@ -59,12 +68,6 @@ The executable `asynchronous_main` contains an alternative implementation for th
5968
One process publishes messages on multiple topics. Sometimes it publishes only on one topic, sometimes on all with the same timestamp and sometimes on all but with slightly different timestamps.
6069
The other process create an approximate and an exact time subscribers.
6170

62-
#### Logger utils
63-
```
64-
$ ros2 run simple_logger logger_main
65-
```
66-
67-
Log some data. Change the logger verbosity level at run time. Log some other data.
6871

6972
#### Parameter servers
7073
```
@@ -77,25 +80,31 @@ Log some data. Change the logger verbosity level at run time. Log some other dat
7780
One process sets its own parameters. The other reads them.
7881

7982

80-
#### Multiple nodes pub/sub
81-
```
82-
$ ros2 run simple_multithread simple_pub_sub_std 10 2 5
83-
```
84-
Several nodes are created within the same process.
85-
This command will create 10 nodes with subscribers, 2 nodes with publishers and will let them spin for 5 seconds before printing some statistics.
86-
8783
## ROS2 CLI (command line interface)
8884

8985
Note that these commands comes from a Python package. So if you have disabled them (i.e. when cross-compiling) they will not be available.
9086

91-
To see a list of available commands
87+
- See a list of available commands
88+
89+
$ ros2 --help
90+
91+
- Print a list of <package_name> <executable_name>
92+
93+
$ ros2 pkg executabels
94+
95+
- Run a ROS2 node
96+
97+
$ ros2 run <package_name> <executable_name>
98+
99+
- List visible topic names (a topic is visible if at least 1 node is publishing or subscribing to it)
100+
101+
$ ros2 topic list
92102

93-
$ ros2 --help
103+
- Echo what's published on a topic
94104

95-
Print a list of <package_name> <executable_name>
105+
$ ros2 topic echo <topic_name>
96106

97-
$ ros2 pkg executabels
107+
- Publish a message to a topic (message content written as valid YAML)
98108

99-
Run a ROS2 node
109+
$ ros2 topic pub <topic_name> <message_type> <message_content>
100110

101-
$ ros2 run <package_name> <executable_name>

build_ros2_packages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To use the executables and libraries with the command line interface you need to
5353
## Tips
5454

5555
- If you do not want to build a specific package place an empty file named `COLCON_IGNORE` in the directory and it will not be indexed.
56-
56+
5757
$ touch src/ros2/rviz/COLCON_IGNORE
5858

5959
- Colcon by default builds packages in parallel. This could cause unpredictable errors. To build sequentially add `--executor sequential` as parameter to `colcon build`.

0 commit comments

Comments
 (0)