forked from autowarefoundation/autoware-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add interface list page Signed-off-by: Takagi, Isamu <[email protected]> * Update docs/design/autoware-interfaces/components/interfaces.md Co-authored-by: kminoda <[email protected]> * style(pre-commit): autofix --------- Signed-off-by: Takagi, Isamu <[email protected]> Co-authored-by: kminoda <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
- Loading branch information
1 parent
bfed35d
commit 9a828e7
Showing
2 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
nav: | ||
- index.md | ||
- interfaces.md | ||
- planning.md | ||
- control.md | ||
- localization.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Interfaces | ||
|
||
## Overview | ||
|
||
インターフェース変更により意図せずAutowareや周辺ツールが動かなくなってしまうのを防ぐため、下記の条件に該当するインターフェースを更新する際は slack にて通知を行い、関係者と対応方針を相談してください。 | ||
|
||
- [autoware_msgs](https://github.com/autowarefoundation/autoware_msgs) や [autoware_auto_msgs](https://github.com/tier4/autoware_auto_msgs) に依存するインターフェース | ||
- このページに記載されたインターフェース | ||
|
||
内部で使用される [tier4_autoware_msgs](https://github.com/tier4/tier4_autoware_msgs) などのインターフェースに依存がある場合、通知の必要性を明示するため、このページにインターフェースを追加する PR を作成してください。インターフェースの提供者はレビューを行い、そのインターフェースを外部から使用して問題ないか判断してください。 | ||
|
||
- 公開インターフェースは [autoware_msgs](https://github.com/autowarefoundation/autoware_msgs) に配置するのが望ましいため、適宜移行してください。 | ||
- 逆に非公開のインターフェースは [autoware_msgs](https://github.com/autowarefoundation/autoware_msgs) や [autoware_auto_msgs](https://github.com/tier4/autoware_auto_msgs) に配置しないでください。 | ||
|
||
## Topics and services | ||
|
||
| Name | Description | | ||
| ---- | ----------- | | ||
|
||
## System files | ||
|
||
| Path | Description | | ||
| ---------------------------- | -------------------- | | ||
| lanelet2_map.osm | レーンレット | | ||
| pointcloud_map.pcd | 点群地図 | | ||
| pointcloud_map_metadata.yaml | 点群地図のメタデータ | | ||
| map_projector_info.yaml | 地図の射影情報 | | ||
|
||
## Parameter files | ||
|
||
| Path | Description | | ||
| ---- | ----------- | |