Skip to content

Commit 539fce7

Browse files
docs(lane_change): use json schema
Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
1 parent bb66275 commit 539fce7

File tree

2 files changed

+97
-10
lines changed

2 files changed

+97
-10
lines changed

planning/behavior_path_planner/autoware_behavior_path_lane_change_module/README.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -1044,16 +1044,7 @@ The following parameters are used to configure terminal lane change path feature
10441044

10451045
The following parameters are configurable in `lane_change.param.yaml`.
10461046

1047-
| Name | Unit | Type | Description | Default value |
1048-
| :------------------------------------- | ------- | ------- | ---------------------------------------------------------------------------------------------------------------- | ------------- |
1049-
| `cancel.enable_on_prepare_phase` | [-] | boolean | Enable cancel lane change | true |
1050-
| `cancel.enable_on_lane_changing_phase` | [-] | boolean | Enable abort lane change. | false |
1051-
| `cancel.delta_time` | [s] | double | The time taken to start steering to return to the center line. | 3.0 |
1052-
| `cancel.duration` | [s] | double | The time taken to complete returning to the center line. | 3.0 |
1053-
| `cancel.max_lateral_jerk` | [m/sss] | double | The maximum lateral jerk for abort path | 1000.0 |
1054-
| `cancel.overhang_tolerance` | [m] | double | Lane change cancel is prohibited if the vehicle head exceeds the lane boundary more than this tolerance distance | 0.0 |
1055-
| `cancel.unsafe_hysteresis_threshold` | [-] | int | threshold that helps prevent frequent switching between safe and unsafe decisions | 10 |
1056-
| `cancel.deceleration_sampling_num` | [-] | int | Number of deceleration patterns to check safety to cancel lane change | 5 |
1047+
{{ json_to_markdown("planning/behavior_path_planner/autoware_behavior_path_lane_change_module/schema/lane_change_abort.schema.json") }}
10571048

10581049
### Debug
10591050

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"title": "lane_change_abort",
4+
"type": "object",
5+
"definitions": {
6+
"behavior_path_lane_change_module": {
7+
"type": "object",
8+
"properties": {
9+
"cancel": {
10+
"type": "object",
11+
"properties": {
12+
"enable_on_prepare_phase": {
13+
"type": "boolean",
14+
"description": "Enable cancel lane change.",
15+
"units": "/",
16+
"default": "true",
17+
},
18+
"enable_on_lane_changing_phase": {
19+
"type": "boolean",
20+
"description": "Enable abort lane change.",
21+
"units": "/",
22+
"default": "true",
23+
},
24+
"overhang_tolerance": {
25+
"type": "number",
26+
"description": "threshold to determine ego vehicle diverges from current lane.",
27+
"units": "s",
28+
"default": 0.0,
29+
"minimum": 0.0
30+
},
31+
"delta_time": {
32+
"type": "number",
33+
"description": "The time taken to start steering to return to the center line.",
34+
"units": "s",
35+
"default": 2.0,
36+
"minimum": 1.0,
37+
"maximum": 3.0
38+
},
39+
"duration": {
40+
"type": "number",
41+
"description": "The time taken to complete returning to the center line.",
42+
"units": "s",
43+
"default": 2.0,
44+
"minimum": 1.0,
45+
"maximum": 3.0
46+
},
47+
"max_lateral_jerk": {
48+
"type": "number",
49+
"description": "The maximum lateral jerk for abort path.",
50+
"units": "m/s3",
51+
"default": 1000.0
52+
},
53+
"unsafe_hysteresis_threshold": {
54+
"type": "integer",
55+
"description": "threshold to determine ego vehicle diverges from current lane.",
56+
"units": "/",
57+
"default": 5,
58+
"minimum": 1
59+
},
60+
"deceleration_sampling_num": {
61+
"type": "integer",
62+
"description": "threshold to determine ego vehicle diverges from current lane.",
63+
"units": "/",
64+
"default": 5,
65+
"minimum": 1
66+
},
67+
},
68+
"required": ["enable_on_prepare_phase", "enable_on_lane_changing_phase", "overhang_tolerance", "delta_time", "duration", "max_lateral_jerk", "unsafe_hysteresis_threshold", "deceleration_sampling_num"],
69+
"additionalProperties": false
70+
},
71+
},
72+
"required": ["cancel"],
73+
"additionalProperties": false
74+
}
75+
},
76+
"properties": {
77+
"/**": {
78+
"properties": {
79+
"ros__parameters": {
80+
"type": "object",
81+
"properties": {
82+
"avoidance": {
83+
"$ref": "#/definitions/behavior_path_lane_change_module"
84+
}
85+
},
86+
"required": ["lane_change"],
87+
"additionalProperties": false
88+
}
89+
},
90+
"required": ["ros__parameters"],
91+
"additionalProperties": false
92+
}
93+
},
94+
"required": ["/**"],
95+
"additionalProperties": false
96+
}

0 commit comments

Comments
 (0)