Skip to content

Commit 18b3df8

Browse files
committed
docs(readme): update architecture image (autowarefoundation#10)
* replace architecture image in README Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp> * update some images Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp> --------- Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>
1 parent 311e00f commit 18b3df8

6 files changed

+127
-115
lines changed

localization/yabloc/README.md

+38-26
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@ This has been developed as a new localization stack for [Autoware](https://githu
66

77
![thumbnail](docs/yabloc_thumbnail.jpg)
88

9-
## Submodule
9+
## Installation
10+
11+
### Prerequisites
12+
13+
**Supporting `Ubuntu 22.04` + `ROS2 humble` now.**
14+
15+
### Submodules
1016

1117
* [external/autoware_auto_msgs](https://github.com/tier4/autoware_auto_msgs)
1218
* [external/autoware_msgs](https://github.com/autowarefoundation/autoware_msgs.git)
@@ -16,12 +22,7 @@ This has been developed as a new localization stack for [Autoware](https://githu
1622
**NOTE:** Currently, this software is assumed to be built in a separate workspace in order not to contaminate the autoware workspace.
1723
Someday this will be located in the workspace where Autoware blongs. These submodules will be removed at the time.
1824

19-
## How to build
20-
21-
**Supporting `Ubuntu 22.04` + `ROS2 humble` now.
22-
Some branches might support `ROS2 galactic`.**
23-
24-
**NOTE:** Currently, this software is assumed to be built in a separate workspace in order not to contaminate the Autoware workspace.
25+
### How to build
2526

2627
```shell
2728
mkdir yabloc_ws/src -p
@@ -47,7 +48,7 @@ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DCMAKE_E
4748

4849
## Quick Start Demo
4950

50-
ROSBAG made by AWSIM: [Google drive link](https://drive.google.com/drive/folders/1XVWfkDoz-0fncYC-_I6cmv1gkB6EfJ2Y?usp=share_link)
51+
rosbag made by AWSIM: [Google drive link](https://drive.google.com/drive/folders/1XVWfkDoz-0fncYC-_I6cmv1gkB6EfJ2Y?usp=share_link)
5152

5253
![how_to_launch_with_rosbag](docs/how_to_launch_quick_start_demo.drawio.svg)
5354

@@ -61,11 +62,9 @@ ros2 bag play awsim_yabloc_rosbag_sample
6162

6263
**NOTE:** `use_sim_time` is TRUE as default.
6364

64-
### Run with standard ROSBAG
65+
### Run with rosbag
6566

66-
Sample data: [Google drive link](https://drive.google.com/drive/folders/1uNxQ2uPFEGbYXUODQMc7GRO5r9c3Fj6o?usp=share_link)
67-
68-
The link contains *rosbag* and *lanelet2* but *pointcloud*.
67+
<details><summary>click to open </summary><div>
6968

7069
![how_to_launch_with_rosbag](docs/how_to_launch_with_rosbag.drawio.svg)
7170

@@ -80,16 +79,20 @@ ros2 launch autoware_launch logging_simulator.launch.xml \
8079
planning:=false \
8180
control:=false \
8281
rviz:=false \
83-
vehicle_model:=jpntaxi \
84-
sensor_model:=aip_xx1 \
85-
vehicle_id:=5 \
82+
vehicle_model:=sample_vehicle \
83+
sensor_model:=sample_sensor_kit \
84+
vehicle_id:=default \
8685
map_path:=$HOME/Maps/odaiba
8786

88-
ros2 bag play sample_odaiba --clock 100
87+
ros2 bag play your_rosbag --clock 100
8988
```
9089

90+
</div></details>
91+
9192
### Run in real world
9293

94+
<details><summary>click to open </summary><div>
95+
9396
![how_to_launch_with_rosbag](docs/how_to_launch_in_real.drawio.svg)
9497

9598
```shell
@@ -99,7 +102,11 @@ ros2 launch autoware_launch autoware.launch.xml \
99102
rviz:=false
100103
```
101104

102-
### Run with AWSIM <ins>(UNDER CONSTRACTION)</ins>
105+
</div></details>
106+
107+
### Run with [AWSIM](https://github.com/tier4/AWSIM) <ins>(UNDER CONSTRACTION)</ins>
108+
109+
<details><summary>click to open </summary><div>
103110

104111
**You have to change autoware.universe branch.**
105112

@@ -109,11 +116,13 @@ ros2 launch pcdless_launch rviz.launch.xml
109116
ros2 launch autoware_launch e2e_simulator.launch.xml
110117
```
111118

112-
## How to set initialpose
119+
</div></details>
120+
121+
## How to set initial pose
113122

114123
### 1. When YabLoc works `standalone:=true`(default) (without Autoware's pose_initializer)
115124

116-
1. 2D Pose Estimate in Rviz
125+
1. `2D Pose Estimate` in Rviz
117126

118127
You can inidcate x, y and yaw manually in rviz.
119128

@@ -127,11 +136,11 @@ If doppler (`ublox_msgs/msg/navpvt`) is available and the vehicle moves enough f
127136

128137
## Architecture
129138

130-
![node_diagram](docs/node_diagram.png)
139+
![node_diagram](docs/yabloc_architecture.drawio.svg)
131140

132-
### Input topics from sesnors
141+
### Input topics
133142

134-
This localizer requires following topics to work.
143+
from sesnors
135144

136145
| topic name | msg type | description |
137146
| ---- | ---- | -- |
@@ -142,15 +151,16 @@ This localizer requires following topics to work.
142151
| `/sensing/gnss/septentrio/poscovgeodetic` | `septentrio_gnss_driver_msgs/msg/PosCovGeodetic` | If you use Septentrio |
143152
| `/vehicle/status/velocity_status` | `autoware_auto_vehicle_msgs/msg/VelocityReport` | |
144153

145-
### Input topics from autoware
146-
154+
from autoware
147155
| topic name | msg type | description |
148156
| ---- | ---- | -- |
149157
| `/tf_static` | `tf2_msgs/msg/TFMessage` | published from `sensor_kit` |
150158
| `/map/vector_map` | `autoware_auto_mapping_msgs/msg/HADMapBin` | published from `/map/lanelet2_map_loader` |
151159

152160
#### about tf_static
153161

162+
<details><summary>click to open</summary><div>
163+
154164
Some nodes requires `/tf_static` from `/base_link` to the frame_id of `/sensing/camera/traffic_light/image_raw/compressed` (e.g. `/traffic_light_left_camera/camera_optical_link`).
155165
You can verify that the tf_static is correct with the following command.
156166

@@ -171,7 +181,9 @@ ros2 run tf2_ros static_transform_publisher \
171181
--yaw -1.570
172182
```
173183

174-
### Output
184+
</div></details>
185+
186+
### Output topics
175187

176188
| topic name | msg type | description |
177189
| ---- | ---- | -- |
@@ -184,7 +196,7 @@ ros2 run tf2_ros static_transform_publisher \
184196

185197
## Visualization
186198

187-
(This project contains original rviz plugins.)
199+
This project contains original rviz plugins. [rviz2_overlay_plugins](./rviz2_plugins/rviz2_overlay_plugins/README.md)
188200

189201
![rviz](docs/rviz_description.png)
190202

0 commit comments

Comments
 (0)