Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add readme for interface packages #4235

Merged
merged 1 commit into from
Jul 11, 2023
Merged

docs: add readme for interface packages #4235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions common/autoware_ad_api_specs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# autoware_adapi_specs

This package is a specification of Autoware AD API.
3 changes: 3 additions & 0 deletions common/component_interface_specs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# component_interface_specs

This package is a specification of component interfaces.
7 changes: 7 additions & 0 deletions common/component_interface_tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# component_interface_tools

This package provides the following tools for component interface.

## service_log_checker

Monitor the service log of component_interface_utils and display if the response status is an error.
4 changes: 4 additions & 0 deletions common/tier4_api_utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# tier4_api_utils

This is an old implementation of a class that logs when calling a service.
Please use [component_interface_utils](../component_interface_utils/README.md) instead.
5 changes: 5 additions & 0 deletions system/component_state_monitor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# component_state_monitor

The component state monitor checks the state of each component using topic state monitor.
This is an implementation for backward compatibility with the AD service state monitor.
It will be replaced in the future using a diagnostics tree.