Skip to content

Commit 9623e09

Browse files
Updates missing links. (#3)
* Refs #3788. Updates missing links. * Refs #3788. Updates wrong names. * Refs #3788. Removes not needed background execution.
1 parent fce5d1a commit 9623e09

1 file changed

Lines changed: 41 additions & 51 deletions

File tree

‎README.md‎

Lines changed: 41 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ The purpose of the package is to subscribe to one of the most basic ROS 2 messag
2525

2626
#### Run demonstration
2727

28-
To run the demonstration, as a first step, you have to build all the required packages in a Micro-ROS workspace.
29-
To read further about how to build the Micro-ROS workspace click [here]().
28+
To run the demonstration, as a first step, you have to build all the required packages in a ROS 2 workspace.
29+
To read further about how to build the ROS 2 workspace click [here](https://index.ros.org/doc/ros2/Linux-Development-Setup/).
3030

3131
```bash
3232
cd ~/ros2_ws
33-
colcon build --cmake-args -DBUILD_SHARED_LIBS=ON --packages-up-to int32_publisher int32_subscriber uros_agent
33+
colcon build --cmake-args -DBUILD_SHARED_LIBS=ON --packages-up-to int32_publisher_c int32_subscriber_c uros_agent
3434
```
3535

3636
Configure the environment
@@ -42,40 +42,38 @@ Configure the environment
4242
Run the Micro XRCE-DDS Agent
4343

4444
```bash
45-
cd ~/ros2_ws/install/microxrcedds_agent/bin
46-
./MicroXRCEAgent udp 8888
45+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888
4746
```
4847

4948
You may prefer to run the Agent in the background and discard all outputs to keep using the same terminal for the next step.
5049

5150
```bash
52-
cd ~/ros2_ws/install/microxrcedds_agent/bin
53-
./MicroXRCEAgent udp 8888 > /dev/null &
51+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888 > /dev/null &
5452
```
5553

5654
Run the publisher.
5755

5856
```bash
59-
~/ros2_ws/install/int32_publisher/lib/int32_publisher/./int32_publisher
57+
~/ros2_ws/install/int32_publisher_c/lib/int32_publisher_c/./int32_publisher_c
6058
```
6159

6260
You may prefer to run the publisher in the background and discard all outputs to keep using the terminal for the next step.
6361

6462
```bash
65-
~/ros2_ws/install/int32_publisher/lib/int32_publisher/./int32_publisher > /dev/null &
63+
~/ros2_ws/install/int32_publisher_c/lib/int32_publisher_c/./int32_publisher_c > /dev/null &
6664
```
6765

6866
Run the subscriber.
6967

7068
```bash
71-
~/ros2_ws/install/int32_subscriber/lib/int32_subscriber/./int32_subscriber
69+
~/ros2_ws/install/int32_subscriber_c/lib/int32_subscriber_c/./int32_subscriber_c
7270
```
7371

7472
### String message demonstration
7573

76-
#### Packages
74+
#### String packages
7775

78-
##### string_publisher
76+
##### String_publisher
7977

8078
The purpose of the package is to publish a simple string ROS 2 message and demonstrate how Micro-ROS layers (rcl, typesupport and rmw) handle it.
8179
For each publication, the message string number increases in one unit order to see in the subscriber side the message variations.
@@ -84,14 +82,14 @@ For each publication, the message string number increases in one unit order to s
8482

8583
The purpose of the package is to subscribe to a simple string ROS 2 message and demonstrate how Micro-ROS layers (rcl, typesupport and rmw) handle it.
8684

87-
#### Run demonstration
85+
#### Run string demonstration
8886

89-
To run the demonstration, as a first step, you have to build all the required packages in a Micro-ROS workspace.
90-
To read further about how to build the Micro-ROS workspace click [here]().
87+
To run the demonstration, as a first step, you have to build all the required packages in a ROS 2 workspace.
88+
To read further about how to build the ROS 2 workspace click [here](https://index.ros.org/doc/ros2/Linux-Development-Setup/).
9189

9290
```bash
9391
cd ~/ros2_ws
94-
colcon build --cmake-args -DBUILD_SHARED_LIBS=ON --packages-up-to string_publisher string_subscriber uros_agent
92+
colcon build --cmake-args -DBUILD_SHARED_LIBS=ON --packages-up-to string_publisher_c string_subscriber_c uros_agent
9593
```
9694

9795
Configure the environment
@@ -103,38 +101,36 @@ Configure the environment
103101
Run the Micro XRCE-DDS Agent
104102

105103
```bash
106-
cd ~/ros2_ws/install/microxrcedds_agent/bin
107-
./MicroXRCEAgent udp 8888
104+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888
108105
```
109106

110107
You may prefer to run the Agent in the background and discard all outputs to keep using the same terminal for the next step.
111108

112109
```bash
113-
cd ~/ros2_ws/install/microxrcedds_agent/bin
114-
./MicroXRCEAgent udp 8888 > /dev/null &
110+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888 > /dev/null &
115111
```
116112

117113
Run the publisher.
118114

119115
```bash
120-
~/ros2_ws/install/string_publisher/lib/string_publisher/./string_publisher
116+
~/ros2_ws/install/string_publisher_c/lib/string_publisher_c/./string_publisher_c
121117
```
122118

123119
You may prefer to run the publisher in the background and discard all outputs in order still using the terminal for the next step.
124120

125121
```bash
126-
~/ros2_ws/install/string_publisher/lib/string_publisher/./string_publisher > /dev/null &
122+
~/ros2_ws/install/string_publisher_c/lib/string_publisher_c/./string_publisher_c > /dev/null &
127123
```
128124

129125
Run the subscriber.
130126

131127
```bash
132-
~/ros2_ws/install/string_subscriber/lib/string_subscriber/./string_subscriber
128+
~/ros2_ws/install/string_subscriber_c/lib/string_subscriber_c/./string_subscriber_c
133129
```
134130

135131
### Complex message demonstration
136132

137-
#### Packages
133+
#### Complex packages
138134

139135
##### complex_msg
140136

@@ -155,10 +151,10 @@ For each publication, the message values increases in one unit order to see in t
155151

156152
The purpose of the package is to subscribe to a complex ROS 2 message and demonstrate how Micro-ROS layers (rcl, typesupport and rmw) handle it.
157153

158-
#### Run demonstration
154+
#### Run complex demonstration
159155

160-
To run the demonstration, as a first step, you have to build all the required packages in a Micro-ROS workspace.
161-
To read further about how to build the Micro-ROS workspace click [here]().
156+
To run the demonstration, as a first step, you have to build all the required packages in a ROS 2 workspace.
157+
To read further about how to build the ROS 2 workspace click [here](https://index.ros.org/doc/ros2/Linux-Development-Setup/).
162158

163159
```bash
164160
cd ~/ros2_ws
@@ -174,15 +170,13 @@ Configure the environment
174170
Run the Micro XRCE-DDS Agent
175171

176172
```bash
177-
cd ~/ros2_ws/install/microxrcedds_agent/bin
178-
./MicroXRCEAgent udp 8888
173+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888
179174
```
180175

181176
You may prefer to run the Agent in the background and discard all outputs to keep using the same terminal for the next step.
182177

183178
```bash
184-
cd ~/ros2_ws/install/microxrcedds_agent/bin
185-
./MicroXRCEAgent udp 8888 > /dev/null &
179+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888 > /dev/null &
186180
```
187181

188182
Run the publisher.
@@ -209,9 +203,7 @@ This purpose of the packages is to demonstrate Micro-ROS stack can be used in a
209203
In this demonstration, an altitude control system is simulated.
210204
The primary purpose of this is to see how Micro-ROS communicates with ROS 2 nodes.
211205

212-
For further information about this demonstration click [here]()
213-
214-
#### Packages
206+
#### Real application packages
215207

216208
##### rad0_actuator
217209

@@ -253,18 +245,18 @@ The node is built using the Micro-ROS middleware packages (rmw_micro_xrcedds and
253245
It is meant to be running in a microcontroller processor, but for this demonstration, the node runs on the host PC.
254246
The node is connected to the DDS world through a Micro XRCE-DDS Agent.
255247

256-
#### Run demonstration
248+
#### Run real application demonstration
257249

258-
Note: For this demonstration, you need at least two open terminals, one for the Micro-ROS workspace and the other for the ROS 2 workspace.
250+
Note: For this demonstration, you need at least two open terminals, one for the ROS 2 workspace and the other for the ROS 2 workspace.
259251

260252
##### Micro-ROS nodes
261253

262-
To run the demonstration, as a first step, you have to build all the required packages in a Micro-ROS workspace.
263-
To read further about how to build the Micro-ROS workspace click [here]().
254+
To run the demonstration, as a first step, you have to build all the required packages in a ROS 2 workspace.
255+
To read further about how to build the ROS 2 workspace click [here](https://index.ros.org/doc/ros2/Linux-Development-Setup/).
264256

265257
```bash
266258
cd ~/ros2_ws
267-
colcon build --cmake-args -DBUILD_SHARED_LIBS=ON --packages-up-to rad0_actuator rad0_display rad0_altitude_sensor uros_agent
259+
colcon build --cmake-args -DBUILD_SHARED_LIBS=ON --packages-up-to rad0_actuator_c rad0_display_c rad0_altitude_sensor_c uros_agent
268260
```
269261

270262
Configure the environment
@@ -276,55 +268,53 @@ Configure the environment
276268
Run the Micro XRCE-DDS Agent
277269

278270
```bash
279-
cd ~/ros2_ws/install/microxrcedds_agent/bin
280-
./MicroXRCEAgent udp 8888
271+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888
281272
```
282273

283274
You may prefer to run the Agent in the background and discard all outputs to keep using the same terminal for the next steps.
284275

285276
```bash
286-
cd ~/ros2_ws/install/microxrcedds_agent/bin
287-
./MicroXRCEAgent udp 8888 > /dev/null &
277+
~/ros2_ws/install/uros_agent/lib/uros_agent/./uros_agent udp 8888 > /dev/null &
288278
```
289279

290280
Run the altitude_sensor node.
291281

292282
```bash
293-
~/ros2_ws/install/rad0_altitude_sensor/lib/rad0_altitude_sensor/./rad0_altitude_sensor
283+
~/ros2_ws/install/rad0_altitude_sensor_c/lib/rad0_altitude_sensor_c/./rad0_altitude_sensor_c
294284
```
295285

296286
You may prefer to run the publisher in the background and discard all outputs to keep using the terminal for the next steps.
297287

298288
```bash
299-
~/ros2_ws/install/rad0_altitude_sensor/lib/rad0_altitude_sensor/./rad0_altitude_sensor > /dev/null &
289+
~/ros2_ws/install/rad0_altitude_sensor_c/lib/rad0_altitude_sensor_c/./rad0_altitude_sensor_c > /dev/null &
300290
```
301291

302292
Run the actuator node.
303293

304294
```bash
305-
~/ros2_ws/install/rad0_actuator/lib/rad0_actuator/./rad0_actuator
295+
~/ros2_ws/install/rad0_actuator_c/lib/rad0_actuator_c/./rad0_actuator_c
306296
```
307297

308298
You may prefer to run the publisher in the background and discard all outputs to keep using the terminal for the next steps.
309299

310300
```bash
311-
~/ros2_ws/install/rad0_actuator/lib/rad0_actuator/./rad0_actuator > /dev/null &
301+
~/ros2_ws/install/rad0_actuator_c/lib/rad0_actuator_c/./rad0_actuator_c > /dev/null &
312302
```
313303

314304
Run the display node.
315305

316306
```bash
317-
~/ros2_ws/install/rad0_display/lib/rad0_display/./rad0_display
307+
~/ros2_ws/install/rad0_display_c/lib/rad0_display_c/./rad0_display_c
318308
```
319309

320310
##### ROS 2 nodes
321311

322312
To run the demonstration, you have first to build all required packages in a ROS 2 workspace.
323-
To read further about how to build the ROS 2 workspace click [here]().
313+
To read further about how to build the ROS 2 workspace click [here](https://index.ros.org/doc/ros2/Linux-Development-Setup/).
324314

325315
```bash
326316
cd ~/ros2_ws
327-
colcon build --packages-up-to rad0_control
317+
colcon build --packages-up-to rad0_control_cpp
328318
```
329319

330320
Configure the environment
@@ -336,5 +326,5 @@ Configure the environment
336326
Run the display node.
337327

338328
```bash
339-
ros2 run control control &
329+
ros2 run rad0_control_cpp rad0_control_cpp
340330
```

0 commit comments

Comments
 (0)