From 2401676e712cbc9e10fd4e885908951f7722659b Mon Sep 17 00:00:00 2001 From: AhmedEbrahim Date: Tue, 12 Mar 2024 05:52:04 +0200 Subject: [PATCH 1/7] docs(log-messages): adding hints for users about rosbag replay simulation log messages Signed-off-by: AhmedEbrahim --- docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md index 227ac067d69..33d2c675a8d 100644 --- a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md +++ b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md @@ -62,6 +62,8 @@ ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png) + > ⚠️ It might happen that you see in the terminal some error and warning messages before playing the rosbag (next step) unit you play the rosbag and proper initialization occurs + 2. Play the sample rosbag file. ```sh @@ -69,6 +71,8 @@ ros2 bag play ~/autoware_map/sample-rosbag/sample.db3 -r 0.2 -s sqlite3 ``` + > ⚠️ As the timestamp in the rosbag is different than the current timestamp in your system , Autoware will output in to the terminal some warning messages due to this timestamp mismatch + ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) 3. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`. From 2dd09823fe81dfae9de42a41421d59decbc268cb Mon Sep 17 00:00:00 2001 From: Ahmed Ebrahim Date: Tue, 12 Mar 2024 14:32:08 +0200 Subject: [PATCH 2/7] docs(log-messages): fixing review comments Signed-off-by: Ahmed Ebrahim --- .../ad-hoc-simulation/rosbag-replay-simulation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md index 33d2c675a8d..399ff87afdb 100644 --- a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md +++ b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md @@ -62,7 +62,9 @@ ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png) - > ⚠️ It might happen that you see in the terminal some error and warning messages before playing the rosbag (next step) unit you play the rosbag and proper initialization occurs +!!! warning + + You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place 2. Play the sample rosbag file. @@ -71,7 +73,9 @@ ros2 bag play ~/autoware_map/sample-rosbag/sample.db3 -r 0.2 -s sqlite3 ``` - > ⚠️ As the timestamp in the rosbag is different than the current timestamp in your system , Autoware will output in to the terminal some warning messages due to this timestamp mismatch +!!! warning + + Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) From dc5ad1db5a6cb56ea8587674cfa36a0bccadf4b7 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 12 Mar 2024 13:21:45 +0000 Subject: [PATCH 3/7] style(pre-commit): autofix --- .../tutorials/ad-hoc-simulation/rosbag-replay-simulation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md index 399ff87afdb..cc17a3f75e9 100644 --- a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md +++ b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md @@ -64,7 +64,7 @@ !!! warning - You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place +You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place 2. Play the sample rosbag file. @@ -75,9 +75,9 @@ !!! warning - Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. +Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. - ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) +![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) 3. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`. From 2297a4ad5c6919b00a741f305b7bf0d987646320 Mon Sep 17 00:00:00 2001 From: Ahmed Ebrahim Date: Tue, 12 Mar 2024 15:26:34 +0200 Subject: [PATCH 4/7] docs(log-messages): updating warning messages indentation. Signed-off-by: Ahmed Ebrahim --- .../ad-hoc-simulation/rosbag-replay-simulation.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md index cc17a3f75e9..c769c3ac3ee 100644 --- a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md +++ b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md @@ -62,9 +62,9 @@ ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png) -!!! warning + !!! warning -You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place + You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place 2. Play the sample rosbag file. @@ -73,11 +73,12 @@ You might encounter error and warning messages in the terminal before playing th ros2 bag play ~/autoware_map/sample-rosbag/sample.db3 -r 0.2 -s sqlite3 ``` -!!! warning + !!! warning -Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. - -![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) + Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. + + + ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) 3. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`. From a87867ec884bc02f03437768e8ddff3a5053a28f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 12 Mar 2024 13:27:19 +0000 Subject: [PATCH 5/7] style(pre-commit): autofix --- .../ad-hoc-simulation/rosbag-replay-simulation.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md index c769c3ac3ee..279a42fca87 100644 --- a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md +++ b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md @@ -64,7 +64,7 @@ !!! warning - You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place + You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place 2. Play the sample rosbag file. @@ -75,9 +75,8 @@ !!! warning - Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. - - + Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. + ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) 3. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`. From 98f248d650b8efbc36b3751dc5964e678ef09fcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=2E=20Fatih=20C=C4=B1r=C4=B1t?= Date: Tue, 12 Mar 2024 18:08:52 +0300 Subject: [PATCH 6/7] fix indent and ignore markdownlint rule MD030 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: M. Fatih Cırıt --- .markdownlint.yaml | 1 + .../rosbag-replay-simulation.md | 42 +++++++++---------- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index babaaa1f158..0f7c7b000a7 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -5,6 +5,7 @@ MD024: siblings_only: true MD029: style: ordered +MD030: false MD033: false MD041: false MD046: false diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md index 279a42fca87..0a743278916 100644 --- a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md +++ b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md @@ -51,41 +51,41 @@ If you prefer a graphical user interface (GUI) over the command line for launching and managing your simulations, refer to the `Using Autoware Launch GUI` section at the end of this document for a step-by-step guide. -1. Launch Autoware. +1. Launch Autoware. - ```sh - source ~/autoware/install/setup.bash - ros2 launch autoware_launch logging_simulator.launch.xml map_path:=$HOME/autoware_map/sample-map-rosbag vehicle_model:=sample_vehicle sensor_model:=sample_sensor_kit - ``` + ```sh + source ~/autoware/install/setup.bash + ros2 launch autoware_launch logging_simulator.launch.xml map_path:=$HOME/autoware_map/sample-map-rosbag vehicle_model:=sample_vehicle sensor_model:=sample_sensor_kit + ``` - Note that you cannot use `~` instead of `$HOME` here. + Note that you cannot use `~` instead of `$HOME` here. - ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png) + ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png) - !!! warning + !!! warning - You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place + You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place -2. Play the sample rosbag file. +2. Play the sample rosbag file. - ```sh - source ~/autoware/install/setup.bash - ros2 bag play ~/autoware_map/sample-rosbag/sample.db3 -r 0.2 -s sqlite3 - ``` + ```sh + source ~/autoware/install/setup.bash + ros2 bag play ~/autoware_map/sample-rosbag/sample.db3 -r 0.2 -s sqlite3 + ``` - !!! warning + !!! warning - Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. + Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. - ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) + ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png) -3. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`. +3. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`. - ![change-target-frame](images/rosbag-replay/change-target-frame.png) + ![change-target-frame](images/rosbag-replay/change-target-frame.png) -4. To switch the view to `Third Person Follower` etc, change the `Type` in the RViz Views panel. +4. To switch the view to `Third Person Follower` etc, change the `Type` in the RViz Views panel. - ![third-person-follower](images/rosbag-replay/third-person-follower.png) + ![third-person-follower](images/rosbag-replay/third-person-follower.png) [Reference video tutorials](https://drive.google.com/file/d/12D6aSC1Y3Kf7STtEPWG5RYynxKdVcPrc/view?usp=sharing) From 99f84d72ca6fcfe938d1b8f1c3940e0b43aef612 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=2E=20Fatih=20C=C4=B1r=C4=B1t?= Date: Tue, 12 Mar 2024 18:47:51 +0300 Subject: [PATCH 7/7] bring back old style MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: M. Fatih Cırıt --- .../ad-hoc-simulation/rosbag-replay-simulation.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md index 0a743278916..24f1c1aca4f 100644 --- a/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md +++ b/docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md @@ -62,9 +62,7 @@ ![after-autoware-launch](images/rosbag-replay/after-autoware-launch.png) - !!! warning - - You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place + > ⚠️ You might encounter error and warning messages in the terminal before playing the `rosbag`. This is normal behavior. These should cease once the `rosbag` is played and proper initialization takes place 2. Play the sample rosbag file. @@ -73,9 +71,7 @@ ros2 bag play ~/autoware_map/sample-rosbag/sample.db3 -r 0.2 -s sqlite3 ``` - !!! warning - - Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. + > ⚠️ Due to the discrepancy between the timestamp in the `rosbag` and the current system timestamp, Autoware may generate warning messages in the terminal alerting to this mismatch. This is normal behavior. ![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png)