Skip to content

Commit fc270b0

Browse files
isamu-takagikarishma1911
authored andcommitted
docs(mission_planner): update readme for route selector (autowarefoundation#6576)
Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
1 parent 67744c7 commit fc270b0

File tree

3 files changed

+759
-468
lines changed

3 files changed

+759
-468
lines changed

planning/mission_planner/README.md

+34-33
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,13 @@ The route is made of a sequence of lanes on a static map.
77
Dynamic objects (e.g. pedestrians and other vehicles) and dynamic map information (e.g. road construction which blocks some lanes) are not considered during route planning.
88
Therefore, the output topic is only published when the goal pose or check points are given and will be latched until the new goal pose or check points are given.
99

10-
The core implementation does not depend on a map format.
11-
In current Autoware.universe, only Lanelet2 map format is supported.
10+
The core implementation does not depend on a map format. Any planning algorithms can be added as plugin modules.
11+
In current Autoware.universe, only the plugin for Lanelet2 map format is supported.
12+
13+
This package also manages routes for MRM. The `route_selector` node duplicates the `mission_planner` interface and provides it for normal and MRM respectively.
14+
It distributes route requests and planning results according to current MRM operation state.
15+
16+
![architecture](./media/architecture.drawio.svg)
1217

1318
## Interfaces
1419

@@ -28,31 +33,37 @@ In current Autoware.universe, only Lanelet2 map format is supported.
2833

2934
### Services
3035

31-
| Name | Type | Description |
32-
| ------------------------------------------------ | ----------------------------------------- | ------------------------------------------------------------------------------------------- |
33-
| `/planning/mission_planning/clear_route` | autoware_adapi_v1_msgs/srv/ClearRoute | route clear request |
34-
| `/planning/mission_planning/set_route_points` | autoware_adapi_v1_msgs/srv/SetRoutePoints | route request with pose waypoints. Assumed the vehicle is stopped. |
35-
| `/planning/mission_planning/set_route` | autoware_adapi_v1_msgs/srv/SetRoute | route request with lanelet waypoints. Assumed the vehicle is stopped. |
36-
| `/planning/mission_planning/change_route_points` | autoware_adapi_v1_msgs/srv/SetRoutePoints | route change request with pose waypoints. This can be called when the vehicle is moving. |
37-
| `/planning/mission_planning/change_route` | autoware_adapi_v1_msgs/srv/SetRoute | route change request with lanelet waypoints. This can be called when the vehicle is moving. |
38-
| `~/srv/set_mrm_route` | autoware_adapi_v1_msgs/srv/SetRoutePoints | set emergency route. This can be called when the vehicle is moving. |
39-
| `~/srv/clear_mrm_route` | std_srvs/srv/Trigger | clear emergency route. |
36+
| Name | Type | Description |
37+
| ------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------ |
38+
| `/planning/mission_planning/mission_planner/clear_route` | tier4_planning_msgs/srv/ClearRoute | route clear request |
39+
| `/planning/mission_planning/mission_planner/set_waypoint_route` | tier4_planning_msgs/srv/SetWaypointRoute | route request with lanelet waypoints. |
40+
| `/planning/mission_planning/mission_planner/set_lanelet_route` | tier4_planning_msgs/srv/SetLaneletRoute | route request with pose waypoints. |
41+
| `/planning/mission_planning/route_selector/main/clear_route` | tier4_planning_msgs/srv/ClearRoute | main route clear request |
42+
| `/planning/mission_planning/route_selector/main/set_waypoint_route` | tier4_planning_msgs/srv/SetWaypointRoute | main route request with lanelet waypoints. |
43+
| `/planning/mission_planning/route_selector/main/set_lanelet_route` | tier4_planning_msgs/srv/SetLaneletRoute | main route request with pose waypoints. |
44+
| `/planning/mission_planning/route_selector/mrm/clear_route` | tier4_planning_msgs/srv/ClearRoute | mrm route clear request |
45+
| `/planning/mission_planning/route_selector/mrm/set_waypoint_route` | tier4_planning_msgs/srv/SetWaypointRoute | mrm route request with lanelet waypoints. |
46+
| `/planning/mission_planning/route_selector/mrm/set_lanelet_route` | tier4_planning_msgs/srv/SetLaneletRoute | mrm route request with pose waypoints. |
4047

4148
### Subscriptions
4249

43-
| Name | Type | Description |
44-
| --------------------- | ------------------------------------ | ---------------------- |
45-
| `input/vector_map` | autoware_auto_mapping_msgs/HADMapBin | vector map of Lanelet2 |
46-
| `input/modified_goal` | geometry_msgs/PoseWithUuidStamped | modified goal pose |
50+
| Name | Type | Description |
51+
| ----------------------- | ------------------------------------ | ---------------------- |
52+
| `~/input/vector_map` | autoware_auto_mapping_msgs/HADMapBin | vector map of Lanelet2 |
53+
| `~/input/modified_goal` | geometry_msgs/PoseWithUuidStamped | modified goal pose |
4754

4855
### Publications
4956

50-
| Name | Type | Description |
51-
| ---------------------------------------- | ------------------------------------- | ------------------------ |
52-
| `/planning/mission_planning/route_state` | autoware_adapi_v1_msgs/msg/RouteState | route state |
53-
| `/planning/mission_planning/route` | autoware_planning_msgs/LaneletRoute | route |
54-
| `debug/route_marker` | visualization_msgs/msg/MarkerArray | route marker for debug |
55-
| `debug/goal_footprint` | visualization_msgs/msg/MarkerArray | goal footprint for debug |
57+
| Name | Type | Description |
58+
| ------------------------------------------------------ | ----------------------------------- | ------------------------ |
59+
| `/planning/mission_planning/state` | tier4_planning_msgs/msg/RouteState | route state |
60+
| `/planning/mission_planning/route` | autoware_planning_msgs/LaneletRoute | route |
61+
| `/planning/mission_planning/route_selector/main/state` | tier4_planning_msgs/msg/RouteState | main route state |
62+
| `/planning/mission_planning/route_selector/main/route` | autoware_planning_msgs/LaneletRoute | main route |
63+
| `/planning/mission_planning/route_selector/mrm/state` | tier4_planning_msgs/msg/RouteState | mrm route state |
64+
| `/planning/mission_planning/route_selector/mrm/route` | autoware_planning_msgs/LaneletRoute | mrm route |
65+
| `~/debug/route_marker` | visualization_msgs/msg/MarkerArray | route marker for debug |
66+
| `~/debug/goal_footprint` | visualization_msgs/msg/MarkerArray | goal footprint for debug |
5667

5768
## Route section
5869

@@ -168,26 +179,16 @@ And there are three use cases that require reroute.
168179
- Emergency route
169180
- Goal modification
170181

171-
![rerouting_interface](./media/rerouting_interface.svg)
172-
173182
#### Route change API
174183

175-
- `change_route_points`
176-
- `change_route`
177-
178-
This is route change that the application makes using the API. It is used when changing the destination while driving or when driving a divided loop route. When the vehicle is driving on a MRM route, normal rerouting by this interface is not allowed.
184+
It is used when changing the destination while driving or when driving a divided loop route. When the vehicle is driving on a MRM route, normal rerouting by this interface is not allowed.
179185

180186
#### Emergency route
181187

182-
- `set_mrm_route`
183-
- `clear_mrm_route`
184-
185-
This interface for the MRM that pulls over the road shoulder. It has to be stopped as soon as possible, so a reroute is required. The MRM route has priority over the normal route. And if MRM route is cleared, try to return to the normal route also with a rerouting safety check.
188+
The interface for the MRM that pulls over the road shoulder. It has to be stopped as soon as possible, so a reroute is required. The MRM route has priority over the normal route. And if MRM route is cleared, try to return to the normal route also with a rerouting safety check.
186189

187190
##### Goal modification
188191

189-
- `modified_goal`
190-
191192
This is a goal change to pull over, avoid parked vehicles, and so on by a planning component. If the modified goal is outside the calculated route, a reroute is required. This goal modification is executed by checking the local environment and path safety as the vehicle actually approaches the destination. And this modification is allowed for both normal_route and mrm_route.
192193
The new route generated here is sent to the AD API so that it can also be referenced by the application. Note, however, that the specifications here are subject to change in the future.
193194

0 commit comments

Comments
 (0)