Skip to content

Commit 5fe0b08

Browse files
authored
docs: update launch autoware documentation (#466)
* init commit Signed-off-by: ismetatabay <[email protected]> * add launch perception page Signed-off-by: ismetatabay <[email protected]> * add launch localization page Signed-off-by: ismetatabay <[email protected]> * add launch sensing packages Signed-off-by: ismetatabay <[email protected]> * add launch sensing page Signed-off-by: ismetatabay <[email protected]> * add launch system page Signed-off-by: ismetatabay <[email protected]> * add launch map page Signed-off-by: ismetatabay <[email protected]> * add launch planning page Signed-off-by: ismetatabay <[email protected]> * add launch control page Signed-off-by: ismetatabay <[email protected]> * fix broken links Signed-off-by: ismetatabay <[email protected]> --------- Signed-off-by: ismetatabay <[email protected]>
1 parent 9832e6f commit 5fe0b08

30 files changed

+884
-142
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
nav:
22
- index.md
3-
- Localization methods: localization-methods
4-
- Perception mode: perception.md
3+
- Launch vehicle: vehicle
4+
- Launch system: system
5+
- Launch map: map
6+
- Launch sensing: sensing
7+
- Launch localization: localization
8+
- Launch perception: perception
9+
- Launch planning: planning
10+
- Launch control: control

docs/how-to-guides/integrating-autoware/launch-autoware/control/images/control_launch_flow.svg

+4
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Control Launch Files
2+
3+
## Overview
4+
5+
The Autoware control stacks start
6+
launching at `autoware_launch.xml` as mentioned on the [Launch Autoware](../index.md) page.
7+
The `autoware_launch` package includes `tier4_control_component.launch.xml`
8+
for initiating control launch files invocation from `autoware_launch.xml`.
9+
The diagram below illustrates the flow of Autoware control launch files within the autoware_launch and autoware.universe packages.
10+
11+
<figure markdown>
12+
![control-launch-flow](images/control_launch_flow.svg){ align=center }
13+
<figcaption>
14+
Autoware control launch flow diagram
15+
</figcaption>
16+
</figure>
17+
18+
!!! note
19+
20+
The Autoware project is a large project.
21+
Therefore, as we manage the Autoware project, we utilize specific
22+
arguments in the launch files.
23+
ROS 2 offers an argument-overriding feature for these launch files.
24+
Please refer to [the official ROS 2 launch documentation](https://docs.ros.org/en/humble/Tutorials/Intermediate/Launch/Using-ROS2-Launch-For-Large-Projects.html#parameter-overrides) for further information.
25+
For instance,
26+
if we define an argument at the top-level launch,
27+
it will override the value on lower-level launches.
28+
29+
## tier4_control_component.launch.xml
30+
31+
The tier4_control_component.launch.xml launch file is the main control component launch in the autoware_launch package.
32+
This launch file calls control.launch.xml from the [tier4_control_launch](https://github.com/autowarefoundation/autoware.universe/tree/main/launch/tier4_control_launch) package
33+
within the autoware.universe repository.
34+
We can modify control launch arguments in tier4_control_component.launch.xml.
35+
Additionally,
36+
we can add any other necessary arguments
37+
that need adjustment since tier4_control_component.launch.xml serves as the top-level launch file for other control launch files.
38+
Here are some predefined control launch arguments:
39+
40+
- **`lateral_controller_mode:`** This argument determines
41+
the lateral controller algorithm.
42+
The default value is `mpc`.
43+
To change it to pure pursuit,
44+
make the following update in your `tier4_control_component.launch.xml` file:
45+
46+
```diff
47+
- <arg name="lateral_controller_mode" default="mpc"/>
48+
+ <arg name="lateral_controller_mode" default="pure_pursuit"/>
49+
```
50+
51+
- **`enable_autonomous_emergency_braking:`** This argument enables autonomous emergency
52+
braking under specific conditions.
53+
Please refer to the [Autonomous emergency braking (AEB)](https://autowarefoundation.github.io/autoware.universe/main/control/autonomous_emergency_braking/) page for
54+
more information.
55+
To enable it, update the value in the `tier4_control_component.launch.xml` file:
56+
57+
```diff
58+
- <arg name="enable_autonomous_emergency_braking" default="false"/>
59+
+ <arg name="enable_autonomous_emergency_braking" default="true"/>
60+
```
61+
62+
- **`enable_predicted_path_checker:`** This argument enables the predicted path checker module.
63+
Please refer to the [Predicted Path Checker](https://autowarefoundation.github.io/autoware.universe/main/control/predicted_path_checker/) page for
64+
more information.
65+
To enable it, update the value in the `tier4_control_component.launch.xml` file:
66+
67+
```diff
68+
- <arg name="enable_predicted_path_checker" default="false"/>
69+
+ <arg name="enable_predicted_path_checker" default="true"/>
70+
```
71+
72+
!!! note
73+
74+
You can also use this arguments as command line arguments:
75+
```bash
76+
ros2 launch autoware_launch autoware.launch.xml ... enable_predicted_path_checker:=true lateral_controller_mode:=pure_pursuit ...
77+
```
78+
79+
The predefined arguments in tier4_control_component.launch.xml have been explained above.
80+
However, numerous control arguments are included in the autoware_launch control config parameters.
Loading

docs/how-to-guides/integrating-autoware/launch-autoware/images/autoware_launch_overview.svg

+4
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)