-
Notifications
You must be signed in to change notification settings - Fork 145
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
isamu-takagi
wants to merge
6
commits into
autowarefoundation:main
Choose a base branch
from
tier4:feat/component-interface-list
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d00a8d6
feat(component-interface): add component interface list
isamu-takagi be5d7f2
feat: split future design and current implementation
isamu-takagi 83ad3b6
WIP
isamu-takagi 66a525b
Merge branch 'main' into feat/component-interface-list
isamu-takagi 28573b7
merge pages
isamu-takagi 587c7a4
update interfaces
isamu-takagi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
38 changes: 38 additions & 0 deletions
38
docs/design/autoware-interfaces/components/interfaces-current.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,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
66
docs/design/autoware-interfaces/components/interfaces-future.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,66 @@ | ||
--- | ||
components: | ||
- adapi | ||
- control | ||
- localization | ||
- map | ||
- perception | ||
- planning | ||
- sensing | ||
- simulator | ||
- system | ||
- vehicle | ||
|
||
interfaces: | ||
- name: /localization/initialization_state | ||
type: autoware_adapi_v1_msgs/msg/LocalizationInitializationState | ||
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 %} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?