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.

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

feat(component-interface): add component interface list #279

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 2 additions & 0 deletions docs/design/autoware-interfaces/components/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
nav:
- index.md
- Interfaces (current): interfaces-current.md
- Interfaces (future): interfaces-future.md
- planning.md
- control.md
- vehicle-interface.md
Expand Down
38 changes: 38 additions & 0 deletions docs/design/autoware-interfaces/components/interfaces-current.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
components:
- adapi
- control
- localization
- map
- perception
- planning
- sensing
- simulator
- system
- vehicle

interfaces:
- name: /vehicle/status/control_mode
type: autoware_auto_vehicle_msgs/msg/ControlModeReport
used: { vehicle: pub, control: sub, simulation: sub }

- name: /control/control_mode_request
type: autoware_auto_vehicle_msgs/srv/ControlModeCommand
used: { vehicle: srv, control: cli }
---

# List of component interfaces (future design)

{%- for component in components %}

## {{ component }}

| interface type | interface name | data type |
| -------------- | -------------- | --------- |

{%- for interface in interfaces %}
{%- if component in interface.used %}
| {{ interface.used[component] }} | {{ interface.name }} | {{ interface.type }} |
{%- endif %}
{%- endfor %}
{%- endfor %}
66 changes: 66 additions & 0 deletions docs/design/autoware-interfaces/components/interfaces-future.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
components:
- adapi
- control
- localization
- map
- perception
- planning
- sensing
- simulator
- system
- vehicle

interfaces:
- name: /localization/initialization_state
type: autoware_adapi_v1_msgs/msg/LocalizationInitializationState
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@isamu-takagi isamu-takagi Jan 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

used: { localization: pub, adapi: sub }

- name: /localization/initialize
type: autoware_adapi_v1_msgs/srv/InitializeLocalization
used: { localization: srv, adapi: cli }

- name: /planning/mission_planning/set_route_points
type: autoware_adapi_v1_msgs/srv/SetRoutePoints
used: { planning: srv, adapi: cli }

- name: /planning/mission_planning/set_route
type: autoware_planning_msgs/srv/SetRoute
used: { planning: srv, adapi: cli }

- name: /planning/mission_planning/clear_route
type: autoware_adapi_v1_msgs/msg/ClearRoute
used: { planning: srv, adapi: cli }

- name: /planning/mission_planning/route
type: autoware_planning_msgs/msg/LaneletRoute
used: { planning: pub, adapi: sub }

- name: /planning/mission_planning/route_state
type: autoware_adapi_v1_msgs/msg/RouteState
used: { planning: pub, adapi: sub }

- name: /vehicle/control_mode_report
type: autoware_auto_vehicle_msgs/msg/ControlModeReport
used: { vehicle: pub, control: sub, simulation: sub }

- name: /vehicle/control_mode_request
type: autoware_auto_vehicle_msgs/srv/ControlModeCommand
used: { vehicle: srv, control: cli }
---

# List of component interfaces (future design)

{%- for component in components %}

## {{ component }}

| interface type | interface name | data type |
| -------------- | -------------- | --------- |

{%- for interface in interfaces %}
{%- if component in interface.used %}
| {{ interface.used[component] }} | {{ interface.name }} | {{ interface.type }} |
{%- endif %}
{%- endfor %}
{%- endfor %}