Skip to content

Commit

Permalink
Update tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
nkoenig committed Apr 29, 2019
1 parent 556bc2e commit 3d00ebd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions tutorials/distributed_simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## High-Level design

Each ign-gazebo instance has the ability to run with the `--network-role` flag.
Each `ign gazebo` instance has the ability to run with the `--network-role` flag.
When the flag is present, the instance attempts to join a distributed simulation
environment by utilizing `ign-transport`. Ign-transport is used to register and
track available peers, as well as synchronize clock and state among multiple
Expand All @@ -34,7 +34,7 @@ active than instances, multiple levels will be allocated to each secondary.

## Assumptions

* When executing in a distributed environment, each `ign-gazebo` instance only
* When executing in a distributed environment, each `ign gazebo` instance only
has one `SimulationRunner` instance, which means that instance is incapable
of simulating multiple worlds.

Expand All @@ -50,7 +50,7 @@ active than instances, multiple levels will be allocated to each secondary.

### Configuration and launch

Multiple `ign-gazebo` executables are started on the same local area network,
Multiple `ign gazebo` executables are started on the same local area network,
each with the `--distributed` flag set.

#### Command line options
Expand Down Expand Up @@ -89,7 +89,7 @@ The secondary instances will only read the role environment variable

### Discovery

Once the `ign-gazebo` instance is started, it will begin a process of
Once the `ign gazebo` instance is started, it will begin a process of
discovering peers in the network. Each peer will send an announcement in
the `/announce` topic when it joins or leaves the network, and also
periodically sends a heartbeat on `/heartbeat`.
Expand Down
2 changes: 1 addition & 1 deletion tutorials/levels.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Gazebo ships with an example world that demos the levels feature. Try it as foll

1. Run the example world with the `--levels` flag:

`ign-gazebo -f levels.sdf --levels`
`ign gazebo -f levels.sdf --levels`

Gazebo will open with a world that has 2 vehicles, one red and one blue.

Expand Down
8 changes: 4 additions & 4 deletions tutorials/log.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ state information will be supported.

Run the example world with `--record` flag. This records data to a default path, i.e. `~/.ignition/gazebo/log/<timestamp>`:

`ign-gazebo -v 4 -r -f pose_publisher.sdf --record`
`ign gazebo -v 4 -r -f pose_publisher.sdf --record`

A custom path can be specified for recorded files through the `--record-path` flag. When `--record-path` is specified, `--record` does not need to be separately specified:

`ign-gazebo -v 4 -r -f pose_publisher.sdf --record-path ./foo`
`ign gazebo -v 4 -r -f pose_publisher.sdf --record-path ./foo`


## Record by specifying plugin in SDF
Expand All @@ -39,14 +39,14 @@ path (`~/.ignition/gazebo/log/<timestamp>`).
Currently, it is enforced that only one recording instance is allowed to
start during a Gazebo run.

\note If both a record plugin and a record command line flag are specified, e.g. `ign-gazebo -v 4 -r -f log_record_shapes.sdf --record`, the command line flag will be ignored, and recorded files will be placed in the path specified in the plugin SDF (or default if none specified).
\note If both a record plugin and a record command line flag are specified, e.g. `ign gazebo -v 4 -r -f log_record_shapes.sdf --record`, the command line flag will be ignored, and recorded files will be placed in the path specified in the plugin SDF (or default if none specified).

## Playback from command line

Playback can be triggered by `--playback` command line flag. `<path>` is the
directory specified to record:

`ign-gazebo -r -v 4 --playback <path>`
`ign gazebo -r -v 4 --playback <path>`


## Playback by specifying plugin in SDF
Expand Down

0 comments on commit 3d00ebd

Please sign in to comment.