Skip to content

Commit 07c62c1

Browse files
authored
docs(simple_pure_pursuit): add README (#2)
* add parameter description Signed-off-by: mitukou1109 <mitukou1109@gmail.com> * add README Signed-off-by: mitukou1109 <mitukou1109@gmail.com> --------- Signed-off-by: mitukou1109 <mitukou1109@gmail.com>
1 parent 67e3793 commit 07c62c1

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Simple Pure Pursuit
2+
3+
The `simple_pure_pursuit` node receives a reference trajectory from `motion_velocity_smoother` and calculates the control command using the pure pursuit algorithm.
4+
5+
## Flowchart
6+
7+
![Flowchart](https://www.plantuml.com/plantuml/png/LOuxSWCn28PxJa5fNy5Rn4NkiKCaB3D1Q4T2XMyVeZZEH8q6_iV7TJXrdrN1nPMnsUvIkSFQ0roSFlcTd3QG6vvaO8u1ErD-l9tHxsnuUl0u0-jWG1pU3c3BSWCelSq3KvYTzzJCUzFuQoNBOVqk32tTEMDffF_xCDxbc1yguxvQyPdSbhGuY3-aS2RIj6kp8Zwp6EalS7kfmvcxMDd9Yl86aSLr8i0Bz0pziM21hk6TLRy0)
8+
9+
## Input topics
10+
11+
| Name | Type | Description |
12+
| :------------------- | :------------------------------------------ | :------------------------------- |
13+
| `~/input/odometry` | `nav_msgs::msg::Odometry` | ego odometry |
14+
| `~/input/trajectory` | `autoware_planning_msgs::msg::Trajectory` | reference trajectory |
15+
16+
## Output topics
17+
18+
| Name | Type | Description | QoS Durability |
19+
| :------------------------- | :------------------------------------ | :-------------- | :------------- |
20+
| `~/output/control_command` | `autoware_control_msgs::msg::Control` | control command | `volatile` |
21+
22+
## Parameters
23+
24+
{{ json_to_markdown("control/autoware_simple_pure_pursuit/schema/simple_pure_pursuit.schema.json") }}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"title": "Parameters for Simple Pure Pursuit Node",
4+
"type": "object",
5+
"definitions": {
6+
"autoware_simple_pure_pursuit": {
7+
"type": "object",
8+
"properties": {
9+
"lookahead_gain": {
10+
"type": "number",
11+
"description": "Gain for lookahead distance calculation: {lookahead distance} = lookahead_gain * {target velocity} + lookahead_min_distance",
12+
"minimum": 0.0
13+
},
14+
"lookahead_min_distance": {
15+
"type": "number",
16+
"description": "Minimum lookahead distance [m]",
17+
"minimum": 0.0
18+
},
19+
"speed_proportional_gain": {
20+
"type": "number",
21+
"description": "Gain for longitudinal acceleration calculation: {longitudinal acceleration} = speed_proportional_gain * ({target velocity} - {current velocity})",
22+
"minimum": 0.0
23+
},
24+
"use_external_target_vel": {
25+
"type": "boolean",
26+
"description": "Whether to use external target velocity"
27+
},
28+
"external_target_vel": {
29+
"type": "number",
30+
"description": "External target velocity [m/s]",
31+
"minimum": 0.0
32+
}
33+
},
34+
"required": [
35+
"lookahead_gain",
36+
"lookahead_min_distance",
37+
"speed_proportional_gain",
38+
"use_external_target_vel",
39+
"external_target_vel"
40+
],
41+
"additionalProperties": false
42+
}
43+
}
44+
}

0 commit comments

Comments
 (0)