Skip to content

Commit

Permalink
docs(default_ad_api): add readme (autowarefoundation#2491)
Browse files Browse the repository at this point in the history
* 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
isamu-takagi authored and HansRobo committed Dec 16, 2022
1 parent 93bbcc2 commit ae085a0
Show file tree
Hide file tree
Showing 17 changed files with 3,213 additions and 3 deletions.
11 changes: 11 additions & 0 deletions system/default_ad_api/README.md
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)
16 changes: 16 additions & 0 deletions system/default_ad_api/document/autoware-state.md
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)
5 changes: 5 additions & 0 deletions system/default_ad_api/document/fail-safe.md
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.
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 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 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 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.
Loading

0 comments on commit ae085a0

Please sign in to comment.