Skip to content

Commit c4b72eb

Browse files
authored
refactor(stop_filter): rework parameters (#5696)
Signed-off-by: PhoebeWu21 <wwcphoebe@gmail.com>
1 parent 68125d6 commit c4b72eb

File tree

2 files changed

+41
-4
lines changed

2 files changed

+41
-4
lines changed

localization/stop_filter/README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,4 @@ This node aims to:
2525

2626
## Parameters
2727

28-
| Name | Type | Description |
29-
| -------------- | ------ | --------------------------------------------------------------------------------------------- |
30-
| `vx_threshold` | double | longitudinal velocity threshold to determine if the vehicle is stopping [m/s] (default: 0.01) |
31-
| `wz_threshold` | double | yaw velocity threshold to determine if the vehicle is stopping [rad/s] (default: 0.01) |
28+
{{ json_to_markdown("localization/stop_filter/schema/stop_filter.schema.json") }}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"title": "Parameters for Stop Filter Node",
4+
"type": "object",
5+
"definitions": {
6+
"stop_filter": {
7+
"type": "object",
8+
"properties": {
9+
"vx_threshold": {
10+
"type": "number",
11+
"description": "Longitudinal velocity threshold to determine if the vehicle is stopping. [m/s]",
12+
"default": "0.01",
13+
"minimum": 0.0
14+
},
15+
"wz_threshold": {
16+
"type": "number",
17+
"description": "Yaw velocity threshold to determine if the vehicle is stopping. [rad/s]",
18+
"default": "0.01",
19+
"minimum": 0.0
20+
}
21+
},
22+
"required": ["vx_threshold", "wz_threshold"],
23+
"additionalProperties": false
24+
}
25+
},
26+
"properties": {
27+
"/**": {
28+
"type": "object",
29+
"properties": {
30+
"ros__parameters": {
31+
"$ref": "#/definitions/stop_filter"
32+
}
33+
},
34+
"required": ["ros__parameters"],
35+
"additionalProperties": false
36+
}
37+
},
38+
"required": ["/**"],
39+
"additionalProperties": false
40+
}

0 commit comments

Comments
 (0)