forked from autowarefoundation/autoware.universe
-
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.
docs(default_ad_api): add readme (autowarefoundation#2491)
* docs(default_ad_api): add readme Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * feat: update table Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com>
- Loading branch information
1 parent
93bbcc2
commit ae085a0
Showing
17 changed files
with
3,213 additions
and
3 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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# default_ad_api | ||
|
||
This package is a default implementation AD API. | ||
|
||
- [autoware state (backward compatibility)](document/autoware-state.md) | ||
- [fail-safe](document/fail-safe.md) | ||
- [interface](document/interface.md) | ||
- [localization](document/localization.md) | ||
- [motion](document/motion.md) | ||
- [operation mode](document/operation-mode.md) | ||
- [routing](document/routing.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,16 @@ | ||
# Autoware state compatibility | ||
|
||
## Overview | ||
|
||
Since `/autoware/state` was so widely used, default_ad_api creates it from the states of AD API for backwards compatibility. | ||
The diagnostic checks that ad_service_state_monitor used to perform have been replaced by component_state_monitor. | ||
The service `/autoware/shutdown` to change autoware state to finalizing is also supported for compatibility. | ||
|
||
![autoware-state-architecture](images/autoware-state-architecture.drawio.svg) | ||
|
||
## Conversion | ||
|
||
This is the correspondence between AD API states and autoware states. | ||
The launch state is the data that default_ad_api node holds internally. | ||
|
||
![autoware-state-table](images/autoware-state-table.drawio.svg) |
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,5 @@ | ||
# Fail-safe API | ||
|
||
## Overview | ||
|
||
The fail-safe API simply relays the MRM state. See the [autoware-documentation](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/ad-api/list/api/fail_safe/) for AD API specifications. |
332 changes: 332 additions & 0 deletions
332
system/default_ad_api/document/images/autoware-state-architecture.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
457 changes: 457 additions & 0 deletions
457
system/default_ad_api/document/images/autoware-state-table.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
553 changes: 553 additions & 0 deletions
553
system/default_ad_api/document/images/localization.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
255 changes: 255 additions & 0 deletions
255
system/default_ad_api/document/images/motion-architecture.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.