feat(component-interface): add component interface list

[isamu-takagi]

Signed-off-by: Takagi, Isamu [email protected]

Description

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

• I've confirmed the contribution guidelines.
• The PR follows the pull request guidelines.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

• The PR follows the pull request guidelines.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

• There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

[github-actions]

Documentation URL: https://autowarefoundation.github.io/autoware-documentation/pr-279/
Modified URLs:

• https://autowarefoundation.github.io/autoware-documentation/pr-279/design/autoware-interfaces/components/interfaces/

[yukkysaito]

What about making it independent of autoware_adapi_v1_msgs?
I think it would be better to close the interaction between components to component interface msgs only.

[isamu-takagi]

Either is fine. We can separate it now for consistency, or copy and edit it later when we need. Is it better to separate now?

[stale]

This pull request has been automatically marked as stale because it has not had recent activity.

[xmfcx]

I've just seen this list, thanks for working on this.

I have some long-term ideas about this topic.

Having a documentation for these interfaces is great. But keeping this document up-to-date or have it reflect the latest changes it challenging.

Maybe we can create a tool to dynamically analyze the Autoware to ensure:

• Each component uses the correct message types to communicate
  • To achieve this,
    • when the Autoware is running (with awsim for example),
    • go through each topic,
    • check the publisher node type,
    • check the subscriber node types,
    • check if the nodes belong to the correct component group
    • list the topics that don't belong to any component
    • list the topics that don't use the listed(acceptable) types

This would require a lot of work and needs to be thought thoroughly. @isamu-takagi what do you think?

[stale]

This pull request has been automatically marked as stale because it has not had recent activity.