Skip to content

Commit 7f9a322

Browse files
docs(tier4_simulated_clock_rviz_plugin): update how to use (#6914)
* docs(tier4_simulated_clock_rviz_plugin): update how to use Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * fixed tabbed warning Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * fix warning not working Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * Fix bullet list Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> --------- Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
1 parent 38ab80e commit 7f9a322

File tree

1 file changed

+29
-10
lines changed
  • common/tier4_simulated_clock_rviz_plugin

1 file changed

+29
-10
lines changed

common/tier4_simulated_clock_rviz_plugin/README.md

+29-10
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,37 @@ This plugin allows publishing and controlling the simulated ROS time.
1010
| -------- | --------------------------- | -------------------------- |
1111
| `/clock` | `rosgraph_msgs::msg::Clock` | the current simulated time |
1212

13-
## HowToUse
13+
## How to use the plugin
14+
15+
1. Launch [planning simulator](https://autowarefoundation.github.io/autoware-documentation/main/tutorials/ad-hoc-simulation/planning-simulation/#1-launch-autoware) with `use_sim_time:=true`.
16+
17+
```shell
18+
ros2 launch autoware_launch planning_simulator.launch.xml map_path:=$HOME/autoware_map/sample-map-planning vehicle_model:=sample_vehicle sensor_model:=sample_sensor_kit use_sim_time:=true
19+
```
20+
21+
> <span style="color: orange; font-weight: bold;">Warning</span>
22+
> If you launch the planning simulator without adding the `tier4_simulated_clock_rviz_plugin`, your simulation will not be running. You'll not even be able to place the initial and the goal poses.
23+
24+
2. Start rviz and select panels/Add new panel.
1425

15-
1. Start rviz and select panels/Add new panel.
1626
![select_panel](./images/select_panels.png)
17-
2. Select tier4_clock_rviz_plugin/SimulatedClock and press OK.
27+
28+
3. Select tier4_clock_rviz_plugin/SimulatedClock and press OK.
29+
1830
![select_clock_plugin](./images/select_clock_plugin.png)
19-
3. Use the added panel to control how the simulated clock is published.
31+
32+
4. Use the added panel to control how the simulated clock is published.
33+
2034
![use_clock_plugin](./images/use_clock_plugin.png)
2135

22-
- Pause button: pause/resume the clock.
23-
- Speed: speed of the clock relative to the system clock.
24-
- Rate: publishing rate of the clock.
25-
- Step button: advance the clock by the specified time step.
26-
- Time step: value used to advance the clock when pressing the step button d).
27-
- Time unit: time unit associated with the value from e).
36+
<ol type="a">
37+
<li>Pause button: pause/resume the clock.</li>
38+
<li>Speed: speed of the clock relative to the system clock.</li>
39+
<li>Rate: publishing rate of the clock.</li>
40+
<li>Step button: advance the clock by the specified time step.</li>
41+
<li>Time step: value used to advance the clock when pressing the step button d).</li>
42+
<li>Time unit: time unit associated with the value from e).</li>
43+
</ol>
44+
45+
> <span style="color: orange; font-weight: bold;">Warning</span>
46+
> If you set the time step too large, your simulation will go haywire.

0 commit comments

Comments
 (0)