Skip to content

Commit 7c88682

Browse files
authored
Fixed some typos and deprecations in tutorials (gazebosim#317)
* fixed some typos and deprecations in tutorials * changed "libgz" to "gz" in plugin filenames
1 parent fcde78b commit 7c88682

File tree

8 files changed

+162
-166
lines changed

8 files changed

+162
-166
lines changed

garden/building_robot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ We will start by building a simple world and then build our robot in it. Open a
2121
<real_time_factor>1.0</real_time_factor>
2222
</physics>
2323
<plugin
24-
filename="libgz-sim-physics-system.so"
24+
filename="gz-sim-physics-system"
2525
name="gz::sim::systems::Physics">
2626
</plugin>
2727
<plugin
28-
filename="libgz-sim-user-commands-system.so"
28+
filename="gz-sim-user-commands-system"
2929
name="gz::sim::systems::UserCommands">
3030
</plugin>
3131
<plugin
32-
filename="libgz-sim-scene-broadcaster-system.so"
32+
filename="gz-sim-scene-broadcaster-system"
3333
name="gz::sim::systems::SceneBroadcaster">
3434
</plugin>
3535

garden/moving_robot.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ model tags.
1818

1919
```xml
2020
<plugin
21-
filename="libgz-sim-diff-drive-system.so"
21+
filename="gz-sim-diff-drive-system"
2222
name="gz::sim::systems::DiffDrive">
2323
<left_joint>left_wheel_joint</left_joint>
2424
<right_joint>right_wheel_joint</right_joint>
@@ -100,7 +100,7 @@ Let's add the following code under the `<world>` tag:
100100

101101
```xml
102102
<!-- Moving Forward-->
103-
<plugin filename="libgz-sim-triggered-publisher-system.so"
103+
<plugin filename="gz-sim-triggered-publisher-system"
104104
name="gz::sim::systems::TriggeredPublisher">
105105
<input type="gz.msgs.Int32" topic="/keyboard/keypress">
106106
<match field="data">16777235</match>
@@ -144,7 +144,7 @@ For example, the Down arrow:
144144

145145
```xml
146146
<!-- Moving Backward-->
147-
<plugin filename="libgz-sim-triggered-publisher-system.so"
147+
<plugin filename="gz-sim-triggered-publisher-system"
148148
name="gz::sim::systems::TriggeredPublisher">
149149
<input type="gz.msgs.Int32" topic="/keyboard/keypress">
150150
<match field="data">16777237</match>
@@ -160,7 +160,7 @@ Map each arrow (key stroke) with the desired message (movement) as we did with t
160160
* Left &#10142; 16777234 &#10142; linear: {x: 0.0}, angular: {z: 0.5}
161161
* Up &#10142; 16777235 &#10142; linear: {x: 0.5}, angular: {z: 0.0}
162162
* Right &#10142; 16777236 &#10142; linear: {x: 0.0}, angular: {z: -0.5}
163-
* Down &#10142; 16777237 &#10142; linear: {x: 0.5}, angular: {z: 0.0}
163+
* Down &#10142; 16777237 &#10142; linear: {x: -0.5}, angular: {z: 0.0}
164164

165165
Now it's your turn try to make the robot move using different keys.
166166

garden/sdf_worlds.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Plugins are a dynamically loaded chunk of code. For example:
3838

3939
```xml
4040
<plugin
41-
filename="libgz-sim-physics-system.so"
41+
filename="gz-sim-physics-system"
4242
name="gz::sim::systems::Physics">
4343
</plugin>
4444
```
@@ -47,7 +47,7 @@ The `Physics` plugin is very important for simulating the dynamics of the world.
4747

4848
```xml
4949
<plugin
50-
filename="libgz-sim-user-commands-system.so"
50+
filename="gz-sim-user-commands-system"
5151
name="gz::sim::systems::UserCommands">
5252
</plugin>
5353
```
@@ -56,7 +56,7 @@ The `UserCommands` plugin is responsible for creating models, moving models, del
5656

5757
```xml
5858
<plugin
59-
filename="libgz-sim-scene-broadcaster-system.so"
59+
filename="gz-sim-scene-broadcaster-system"
6060
name="gz::sim::systems::SceneBroadcaster">
6161
</plugin>
6262
```

garden/sensors.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and the `linear_acceleration` in the three axes. Let's use our
2020
To define the `IMU` sensor add this code under the `<world>` tag:
2121

2222
```xml
23-
<plugin filename="libgz-sim-imu-system.so"
23+
<plugin filename="gz-sim-imu-system"
2424
name="gz::sim::systems::Imu">
2525
</plugin>
2626
```
@@ -80,7 +80,6 @@ obstacle as follows:
8080
<static>true</static>
8181
<pose>5 0 0 0 0 0</pose><!--pose relative to the world-->
8282
<link name='box'>
83-
<pose/>
8483
<visual name='visual'>
8584
<geometry>
8685
<box>
@@ -114,7 +113,7 @@ Now run the world and make sure that the wall appears in the simulation like thi
114113
Let's add the contact sensor to the wall. As with the `IMU` sensor, we should first define the `Contact` sensor by adding the following code:
115114

116115
```xml
117-
<plugin filename="libgz-sim-contact-system.so"
116+
<plugin filename="gz-sim-contact-system"
118117
name="gz::sim::systems::Contact">
119118
</plugin>
120119
```
@@ -134,7 +133,7 @@ The definition of the `<sensor>` is straight forward, we just define the `name`
134133
We need also to add the `TouchPlugin` under the `wall` model as follows:
135134

136135
```xml
137-
<plugin filename="libgz-sim-touchplugin-system.so"
136+
<plugin filename="gz-sim-touchplugin-system"
138137
name="gz::sim::systems::TouchPlugin">
139138
<target>vehicle_blue</target>
140139
<namespace>wall</namespace>
@@ -164,7 +163,7 @@ When you hit the bump you should see a message `data: true` on the terminal wher
164163
Now we can use the `TriggeredPublisher` plugin to make our robot stop when hits the wall as follows:
165164

166165
```xml
167-
<plugin filename="libgz-sim-triggered-publisher-system.so"
166+
<plugin filename="gz-sim-triggered-publisher-system"
168167
name="gz::sim::systems::TriggeredPublisher">
169168
<input type="gz.msgs.Boolean" topic="/wall/touched">
170169
<match>data: true</match>
@@ -196,7 +195,7 @@ Then add this plugin under the `<world>` tag, to be able to use the `lidar` sens
196195

197196
```xml
198197
<plugin
199-
filename="libgz-sim-sensors-system.so"
198+
filename="gz-sim-sensors-system"
200199
name="gz::sim::systems::Sensors">
201200
<render_engine>ogre2</render_engine>
202201
</plugin>

garden/tutorials/building_robot/building_robot.sdf

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
<real_time_factor>1.0</real_time_factor>
77
</physics>
88
<plugin
9-
filename="ignition-gazebo-physics-system"
10-
name="ignition::gazebo::systems::Physics">
9+
filename="gz-sim-physics-system"
10+
name="gz::sim::systems::Physics">
1111
</plugin>
1212
<plugin
13-
filename="ignition-gazebo-user-commands-system"
14-
name="ignition::gazebo::systems::UserCommands">
13+
filename="gz-sim-user-commands-system"
14+
name="gz::sim::systems::UserCommands">
1515
</plugin>
1616
<plugin
17-
filename="ignition-gazebo-scene-broadcaster-system"
18-
name="ignition::gazebo::systems::SceneBroadcaster">
17+
filename="gz-sim-scene-broadcaster-system"
18+
name="gz::sim::systems::SceneBroadcaster">
1919
</plugin>
2020

2121
<light type="directional" name="sun">

garden/tutorials/moving_robot/moving_robot.sdf

Lines changed: 34 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
<real_time_factor>1.0</real_time_factor>
77
</physics>
88
<plugin
9-
filename="libignition-gazebo-physics-system.so"
10-
name="ignition::gazebo::systems::Physics">
9+
filename="gz-sim-physics-system"
10+
name="gz::sim::systems::Physics">
1111
</plugin>
1212
<plugin
13-
filename="libignition-gazebo-user-commands-system.so"
14-
name="ignition::gazebo::systems::UserCommands">
13+
filename="gz-sim-user-commands-system"
14+
name="gz::sim::systems::UserCommands">
1515
</plugin>
1616
<plugin
17-
filename="libignition-gazebo-scene-broadcaster-system.so"
18-
name="ignition::gazebo::systems::SceneBroadcaster">
17+
filename="gz-sim-scene-broadcaster-system"
18+
name="gz::sim::systems::SceneBroadcaster">
1919
</plugin>
2020

2121
<light type="directional" name="sun">
@@ -245,8 +245,8 @@
245245

246246
<!--diff drive plugin-->
247247
<plugin
248-
filename="libignition-gazebo-diff-drive-system.so"
249-
name="ignition::gazebo::systems::DiffDrive">
248+
filename="gz-sim-diff-drive-system"
249+
name="gz::sim::systems::DiffDrive">
250250
<left_joint>left_wheel_joint</left_joint>
251251
<right_joint>right_wheel_joint</right_joint>
252252
<wheel_separation>1.2</wheel_separation>
@@ -256,47 +256,44 @@
256256
</plugin>
257257
</model>
258258

259-
<!-- Moving Forward-->
260-
<plugin filename="libignition-gazebo-triggered-publisher-system.so"
261-
name="ignition::gazebo::systems::TriggeredPublisher">
262-
<input type="ignition.msgs.Int32" topic="/keyboard/keypress">
263-
<match field="data">16777235</match>
259+
<!-- Moving Left-->
260+
<plugin filename="gz-sim-triggered-publisher-system"
261+
name="gz::sim::systems::TriggeredPublisher">
262+
<input type="gz.msgs.Int32" topic="/keyboard/keypress">
263+
<match field="data">16777234</match>
264264
</input>
265-
<output type="ignition.msgs.Twist" topic="/cmd_vel">
266-
linear: {x: 0.5}, angular: {z: 0.0}
265+
<output type="gz.msgs.Twist" topic="/cmd_vel">
266+
linear: {x: 0.0}, angular: {z: 0.5}
267267
</output>
268268
</plugin>
269-
270-
<!-- Moving Backward-->
271-
<plugin filename="libignition-gazebo-triggered-publisher-system.so"
272-
name="ignition::gazebo::systems::TriggeredPublisher">
273-
<input type="ignition.msgs.Int32" topic="/keyboard/keypress">
274-
<match field="data">16777237</match>
269+
<!-- Moving Forward-->
270+
<plugin filename="gz-sim-triggered-publisher-system"
271+
name="gz::sim::systems::TriggeredPublisher">
272+
<input type="gz.msgs.Int32" topic="/keyboard/keypress">
273+
<match field="data">16777235</match>
275274
</input>
276-
<output type="ignition.msgs.Twist" topic="/cmd_vel">
277-
linear: {x: -0.5}, angular: {z: 0.0}
275+
<output type="gz.msgs.Twist" topic="/cmd_vel">
276+
linear: {x: 0.5}, angular: {z: 0.0}
278277
</output>
279278
</plugin>
280-
281-
<!-- Rotating right-->
282-
<plugin filename="libignition-gazebo-triggered-publisher-system.so"
283-
name="ignition::gazebo::systems::TriggeredPublisher">
284-
<input type="ignition.msgs.Int32" topic="/keyboard/keypress">
279+
<!-- Moving Right-->
280+
<plugin filename="gz-sim-triggered-publisher-system"
281+
name="gz::sim::systems::TriggeredPublisher">
282+
<input type="gz.msgs.Int32" topic="/keyboard/keypress">
285283
<match field="data">16777236</match>
286284
</input>
287-
<output type="ignition.msgs.Twist" topic="/cmd_vel">
285+
<output type="gz.msgs.Twist" topic="/cmd_vel">
288286
linear: {x: 0.0}, angular: {z: -0.5}
289287
</output>
290288
</plugin>
291-
292-
<!--Rotating left-->
293-
<plugin filename="libignition-gazebo-triggered-publisher-system.so"
294-
name="ignition::gazebo::systems::TriggeredPublisher">
295-
<input type="ignition.msgs.Int32" topic="/keyboard/keypress">
296-
<match field="data">16777234</match>
289+
<!-- Moving Backward-->
290+
<plugin filename="gz-sim-triggered-publisher-system"
291+
name="gz::sim::systems::TriggeredPublisher">
292+
<input type="gz.msgs.Int32" topic="/keyboard/keypress">
293+
<match field="data">16777237</match>
297294
</input>
298-
<output type="ignition.msgs.Twist" topic="/cmd_vel">
299-
linear: {x: 0.0}, angular: {z: 0.5}
295+
<output type="gz.msgs.Twist" topic="/cmd_vel">
296+
linear: {x: -0.5}, angular: {z: 0.0}
300297
</output>
301298
</plugin>
302299
</world>

garden/tutorials/sdf_worlds/world_demo.sdf

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,27 @@
66
<real_time_factor>1.0</real_time_factor>
77
</physics>
88
<plugin
9-
filename="libignition-gazebo-physics-system.so"
10-
name="ignition::gazebo::systems::Physics">
9+
filename="gz-sim-physics-system"
10+
name="gz::sim::systems::Physics">
1111
</plugin>
1212
<plugin
13-
filename="libignition-gazebo-user-commands-system.so"
14-
name="ignition::gazebo::systems::UserCommands">
13+
filename="gz-sim-user-commands-system"
14+
name="gz::sim::systems::UserCommands">
1515
</plugin>
1616
<plugin
17-
filename="libignition-gazebo-scene-broadcaster-system.so"
18-
name="ignition::gazebo::systems::SceneBroadcaster">
17+
filename="gz-sim-scene-broadcaster-system"
18+
name="gz::sim::systems::SceneBroadcaster">
1919
</plugin>
2020

2121
<gui fullscreen="0">
2222

2323
<!-- 3D scene -->
2424
<plugin filename="GzScene3D" name="3D View">
25-
<ignition-gui>
25+
<gz-gui>
2626
<title>3D View</title>
2727
<property type="bool" key="showTitleBar">false</property>
2828
<property type="string" key="state">docked</property>
29-
</ignition-gui>
29+
</gz-gui>
3030

3131
<engine>ogre2</engine>
3232
<scene>scene</scene>
@@ -37,7 +37,7 @@
3737

3838
<!-- World control -->
3939
<plugin filename="WorldControl" name="World control">
40-
<ignition-gui>
40+
<gz-gui>
4141
<title>World control</title>
4242
<property type="bool" key="showTitleBar">false</property>
4343
<property type="bool" key="resizable">false</property>
@@ -50,7 +50,7 @@
5050
<line own="left" target="left"/>
5151
<line own="bottom" target="bottom"/>
5252
</anchors>
53-
</ignition-gui>
53+
</gz-gui>
5454

5555
<play_pause>true</play_pause>
5656
<step>true</step>
@@ -62,7 +62,7 @@
6262

6363
<!-- World statistics -->
6464
<plugin filename="WorldStats" name="World stats">
65-
<ignition-gui>
65+
<gz-gui>
6666
<title>World stats</title>
6767
<property type="bool" key="showTitleBar">false</property>
6868
<property type="bool" key="resizable">false</property>
@@ -75,7 +75,7 @@
7575
<line own="right" target="right"/>
7676
<line own="bottom" target="bottom"/>
7777
</anchors>
78-
</ignition-gui>
78+
</gz-gui>
7979

8080
<sim_time>true</sim_time>
8181
<real_time>true</real_time>

0 commit comments

Comments
 (0)