Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Ryanf55 opened this issue Apr 23, 2024 · 3 comments · May be fixed by #2383
Open

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

Ryanf55 opened this issue Apr 23, 2024 · 3 comments · May be fixed by #2383
Assignees
Labels
enhancement New feature or request

Comments

@Ryanf55
Copy link

Ryanf55 commented Apr 23, 2024

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 Ryanf55 added the enhancement New feature or request label Apr 23, 2024
@Ryanf55
Copy link
Author

Ryanf55 commented Apr 24, 2024

I would like to create a gif like the other tutorial. Can the maintainers recommend a process to do that? Or, is it OK to do the tutorial without a gif. Otherwise, I have the content ready.

@Ryanf55 Ryanf55 linked a pull request Apr 25, 2024 that will close this issue
8 tasks
@mjcarroll
Copy link
Contributor

I would like to create a gif like the other tutorial. Can the maintainers recommend a process to do that? Or, is it OK to do the tutorial without a gif. Otherwise, I have the content ready.

I don't know that we have a guide, but we have historically used https://en.wikipedia.org/wiki/Peek_(software) to record gifs on Linux.

@Ryanf55
Copy link
Author

Ryanf55 commented Apr 30, 2024

Thanks. Which world is shown in other tutorial?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: In progress
Development

Successfully merging a pull request may close this issue.

2 participants