Skip to content

Commit 40f046f

Browse files
committed
Refs #3476. Cleans wording and spelling checks.
1 parent 7143a7b commit 40f046f

1 file changed

Lines changed: 29 additions & 29 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
<a href="http://www.eprosima.com"><img src="http://www.eprosima.com/images/logos/eprosima/logo.png" align="center" hspace="8" vspace="2" width="850" height="200" ></a>
1+
# Micro ROS Demo
22

3-
# Overview
3+
## Overview
44

55
The main porpuse for this repo is to organize all packages for the [Micro-ROS Poject]() functionalities demostrations.
66
All packages contained in this repo are a part of the Micro-ROS poject stack.
77
For more information about Micro-ROS project click [here]().
88

9-
# Package clusters
9+
## Package clusters
1010

1111
The repository contains the belows packages clusters:
1212

1313

14-
## Simple message demostration
14+
### Simple message demostration
1515

16-
### Packages
16+
#### Packages
1717

18-
#### Int32_publisher
18+
##### Int32_publisher
1919

2020
The porpuse of the package is to publicate a one of the simplest ROS2 message and demostrate how Micro-ROS down layers (rcl, typesupport and rmw) handle it.
2121
For each publication, the message value will be increased in one unit order to see in the subcriber side the menssage variations.
2222

2323

24-
#### Int32_subscriber
24+
##### Int32_subscriber
2525

2626
The porpuse of the package is to subcribe to one of the simplest ROS2 message and demostrate how Micro-ROS down layers (rcl, typesupport and rmw) handle it.
2727

2828

29-
### Run demostration
29+
#### Run demostration
3030

3131
To run the demostration you have first to build all required packages in a Micro-ROS workspace.
3232
To read farther about how to build the Micro-ROS workspace click [here]().
@@ -48,7 +48,7 @@ Run the Micro-xrce agent
4848

4949
```bash
5050
cd ~/ros2_ws/install/micrortps_agent/bin
51-
./MicroRTPSAgent udp 8888
51+
./MicroXRCEDDSAgent udp 8888
5252
```
5353

5454
You may prefer to run the Agent in background and discard all outputs in order still using the terminal for the next step.
@@ -77,22 +77,22 @@ Run the subcriber.
7777
~/ros2_ws/install/int32_subscriber/lib/int32_subscriber/./int32_subscriber
7878
```
7979

80-
## String message demostration
80+
### String message demostration
8181

82-
### Packages
82+
#### Packages
8383

84-
#### string_publisher
84+
##### string_publisher
8585

8686
The porpuse of the package is to publicate a simple string ROS2 message and demostrate how Micro-ROS down layers (rcl, typesupport and rmw) handle it.
8787
For each publication, the message string number will be increased in one unit order to see in the subcriber side the menssage variations.
8888

8989

90-
#### String_subscriber
90+
##### String_subscriber
9191

9292
The porpuse of the package is to subcribe to a simple string ROS2 message and demostrate how Micro-ROS down layers (rcl, typesupport and rmw) handle it.
9393

9494

95-
### Run demostration
95+
#### Run demostration
9696

9797
To run the demostration you have first to build all required packages in a Micro-ROS workspace.
9898
To read farther about how to build the Micro-ROS workspace click [here]().
@@ -143,11 +143,11 @@ Run the subcriber.
143143
```
144144

145145

146-
## Complex message demostration
146+
### Complex message demostration
147147

148-
### Packages
148+
#### Packages
149149

150-
#### complex_msg
150+
##### complex_msg
151151

152152
One of the porpuses of the package is to demostrate how typesupport code is generated for a complex message.
153153
Also, the generation of a complex ROS2 structure message will be used to demostrate how down layers (rcl, typesupport and rmw) handle it.
@@ -157,18 +157,18 @@ The message structure content the following types:
157157
- Unbonded string data.
158158

159159

160-
#### Complex_msg_publisher
160+
##### Complex_msg_publisher
161161

162162
The porpuse of the package is to publicate a complex ROS2 message and demostrate how Micro-ROS down layers (rcl, typesupport and rmw) handle it.
163163
For each publication, the message values will be increased in one unit order to see in the subcriber side the menssage variations.
164164

165165

166-
#### Complex_msg_subscriber
166+
##### Complex_msg_subscriber
167167

168168
The porpuse of the package is to subcribe a complex ROS2 message and demostrate how Micro-ROS down layers (rcl, typesupport and rmw) handle it.
169169

170170

171-
### Run demostration
171+
#### Run demostration
172172

173173
To run the demostration you have first to build all required packages in a Micro-ROS workspace.
174174
To read farther about how to build the Micro-ROS workspace click [here]().
@@ -219,7 +219,7 @@ Run the subcriber.
219219
```
220220

221221

222-
## Real aplication demostration
222+
### Real aplication demostration
223223

224224
This purpuse of the packages is to demostrate Micro-Ros stack can be used in a real aplication scenario.
225225
In this demostration an altitude control system will be simulated.
@@ -228,9 +228,9 @@ The main purpuse of this is to see how Micro-Ros comunicates with Ros2 nodes.
228228
For farther information about this demostration click [here]()
229229

230230

231-
### Packages
231+
#### Packages
232232

233-
#### RAD0_actuator
233+
##### RAD0_actuator
234234

235235
The mission of this node is to simulate a dummy altitude engine power actuator.
236236
It will receive power increments and publicate the total power amount as a DDS topic.
@@ -241,7 +241,7 @@ It is meant to be running in on a microcontroller processor but for this demostr
241241
The node will be conected to the DDS world throw a micro-xrce-agent.
242242

243243

244-
#### RAD0_altitude_sensor
244+
##### RAD0_altitude_sensor
245245

246246
The mission of this node is to simulate a dummy altitude sensor.
247247
It will publicate the altitude variations as a DDS topic.
@@ -252,7 +252,7 @@ It is meant to be running in on a microcontroller processor but for this demostr
252252
The node will be conected to the DDS world throw a micro-xrce-agent.
253253

254254

255-
#### RAD0_control
255+
##### RAD0_control
256256

257257
The mission of this node is to read altitude values and send to the actuator engine variations.
258258
It also will publicate the status (OK, WARNING or FAILURE) as a DDS topic.
@@ -262,7 +262,7 @@ The node will be built using the ROS2 middleware packages (rmw_fastrtps and rosi
262262

263263
It is meant to be running in on a microcontroler processor and will be directly conected to de dds wold.
264264

265-
#### RAD0_display
265+
##### RAD0_display
266266

267267
The mission of this node is to simulate one LCD screen that will print the important parameters.
268268
It will subcribe to the altitude, power and status messages availables as a DDS topic.
@@ -273,11 +273,11 @@ It is meant to be running in on a microcontroller processor but for this demostr
273273
The node will be conected to the DDS world throw a micro-xrce-agent.
274274

275275

276-
### Run demostration
276+
#### Run demostration
277277

278278
Note: For this demostraton you need at least two open termninals, one for the Micro-ROS workspace and the other for the ROS2 workspace.
279279

280-
#### Micro-ROS nodes
280+
##### Micro-ROS nodes
281281

282282
To run the demostration you have first to build all required packages in a Micro-ROS workspace.
283283
To read farther about how to build the Micro-ROS workspace click [here]().
@@ -339,7 +339,7 @@ Run the display node.
339339
~/ros2_ws/install/rad0_display/lib/rad0_display/./rad0_display
340340
```
341341

342-
#### ROS2 nodes
342+
##### ROS2 nodes
343343

344344
To run the demostration you have first to build all required packages in a ROS2 workspace.
345345
To read farther about how to build the ROS2 workspace click [here]().

0 commit comments

Comments
 (0)