Skip to content

Commit 587470b

Browse files
committed
update readme
Signed-off-by: Barış Zeren <bzeren1819@gmail.com>
1 parent aafd37e commit 587470b

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# autoware_dynamic_lanelet_provider
2+
3+
## Purpose
4+
5+
This package aim to provide dynamic Lanelet2 map to the other Autoware nodes.
6+
The dynamic Lanelet2 map is a Lanelet2 map that is updated in real-time based
7+
on the current odometry position of the vehicle.
8+
9+
To use this package, you need to provide a divided Lanelet2 maps and a metadata file.
10+
You should check
11+
the [lanelet2_map_loader documentation](https://autowarefoundation.github.io/autoware.universe/main/map/map_loader/#lanelet2_map_loader)
12+
for more information about the divided lanelet map and the metadata file.
13+
14+
## Inputs / Outputs
15+
16+
### Input
17+
18+
| Name | Type | Description |
19+
|------------------------------|--------------------------------------------|---------------------------------|
20+
| `~/input/odometry` | `nav_msgs::msg::Odometry` | ego vehicle odometry |
21+
| `/map/lanelet_map_meta_data` | autoware_map_msgs::msg::LaneletMapMetaData | metadata info for lanelet2 maps |
22+
23+
### Output
24+
25+
| Name | Type | Description |
26+
|-----------------------|----------------------------------------------|----------------------------|
27+
| `output/lanelet2_map` | `autoware_auto_mapping_msgs::msg::HADMapBin` | dynamic Lanelet2 map topic |
28+
29+
### Service
30+
31+
| Name | Type | Description |
32+
|----------------------------------------|------------------------------------------------------|-------------------------------------------|
33+
| `service/get_differential_lanelet_map` | `autoware_map_msgs::srv::GetDifferentialLanelet2Map` | service to load diferantial Lanelet2 maps |
34+
35+
## Parameters
36+
37+
{{ json_to_markdown("map/autoware_dynamic_lanelet_provider/schema/dynamic_lanelet_provider.schema.json") }}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"title": "Parameters for autoware_dynamic_lanelet_provider",
4+
"type": "object",
5+
"definitions": {
6+
"autoware_dynamic_lanelet_provider": {
7+
"type": "object",
8+
"properties": {
9+
"dynamic_map_loading_grid_size": {
10+
"type": "number",
11+
"description": "The grid size for divided lanelet2 map",
12+
"default": "50.0"
13+
},
14+
"dynamic_map_loading_update_distance": {
15+
"type": "number",
16+
"description": "The distance to update the map",
17+
"default": "100.0"
18+
},
19+
"dynamic_map_loading_map_radius": {
20+
"type": "number",
21+
"description": "The radius for the map to be loaded",
22+
"default": "200.0"
23+
}
24+
},
25+
"required": ["dynamic_map_loading_grid_size", "dynamic_map_loading_update_distance", "dynamic_map_loading_map_radius"],
26+
"additionalProperties": false
27+
}
28+
},
29+
"properties": {
30+
"/**": {
31+
"type": "object",
32+
"properties": {
33+
"ros__parameters": {
34+
"$ref": "#/definitions/autoware_dynamic_lanelet_provider"
35+
}
36+
},
37+
"required": ["ros__parameters"],
38+
"additionalProperties": false
39+
}
40+
},
41+
"required": ["/**"],
42+
"additionalProperties": false
43+
}

0 commit comments

Comments
 (0)