gz-sim icon indicating copy to clipboard operation
gz-sim copied to clipboard

Docs: Add tutorial on how to start/pause simulator from CLI

Open Ryanf55 opened this issue 2 months ago • 3 comments

Desired behavior

Add a new tutorial similar to reset that shows how to start/stop. Context: https://discord.com/channels/1077825543698927656/1080763334384697430/1232059825634934875

Alternatives considered

N/A

Implementation suggestion

  • Show start/pause button in GUI and what it does
  • Explain how sim time stops and how to check sim time and iterations in CLI
  • Explain how to start/pause with the gz CLI through transport
  • Add a demo video
gz sim -s shapes.sdf
gz service -s /world/shapes/control --reqtype gz.msgs.WorldControl --reptype gz.msgs.Boolean --timeout 3000 --req 'pause: false'
gz topic -e -t /stats -n 1
sim_time {
  sec: 2
  nsec: 807000000
}
real_time {
  sec: 2
  nsec: 824597858
}
iterations: 2807
real_time_factor: 0.99667211181863757
step_size {
  nsec: 1000000
}

Additional context

Please assign this to me. I'll write the tutorial.

Ryanf55 avatar Apr 23 '24 20:04 Ryanf55