From 7decad9da86dd333cd632d801ae62c594d857738 Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" <43976882+isamu-takagi@users.noreply.github.com> Date: Fri, 4 Mar 2022 17:02:27 +0900 Subject: [PATCH] feat: add rosbag logging api and fix document generator (#5) --- docs/design/.pages | 3 +- docs/design/ad-api/.pages | 3 -- docs/design/ad-api/index.md | 5 --- docs/design/autoware-interface/.pages | 2 + .../prototyping/.pages | 0 .../prototyping/api/.pages | 0 .../external/get/command/selected/control.md | 0 .../external/get/command/selected/vehicle.md | 0 .../api/external/get/diagnostics.md | 0 .../prototyping/api/external/get/door.md | 0 .../prototyping/api/external/get/emergency.md | 0 .../prototyping/api/external/get/engage.md | 0 .../api/external/get/map/info/hash.md | 0 .../api/external/get/map/lanelet/xml.md | 0 .../api/external/get/metadata/packages.md | 0 .../prototyping/api/external/get/observer.md | 0 .../prototyping/api/external/get/operator.md | 0 .../api/external/get/rosbag_logging_mode.md | 19 +++++++++ .../prototyping/api/external/get/route.md | 0 .../prototyping/api/external/get/service.md | 0 .../api/external/get/vehicle/status.md | 0 .../prototyping/api/external/get/version.md | 0 .../api/external/set/clear_route.md | 0 .../api/external/set/command/local/control.md | 0 .../external/set/command/local/gear_shift.md | 0 .../external/set/command/local/heartbeat.md | 0 .../api/external/set/command/local/shift.md | 0 .../external/set/command/local/turn_signal.md | 0 .../external/set/command/remote/control.md | 0 .../external/set/command/remote/gear_shift.md | 0 .../external/set/command/remote/heartbeat.md | 0 .../api/external/set/command/remote/shift.md | 0 .../set/command/remote/turn_signal.md | 0 .../prototyping/api/external/set/door.md | 0 .../prototyping/api/external/set/emergency.md | 0 .../prototyping/api/external/set/engage.md | 0 .../api/external/set/initialize_pose.md | 0 .../api/external/set/initialize_pose_auto.md | 0 .../prototyping/api/external/set/observer.md | 0 .../prototyping/api/external/set/operator.md | 0 .../api/external/set/pause_driving.md | 0 .../api/external/set/rosbag_logging_mode.md | 19 +++++++++ .../prototyping/api/external/set/route.md | 0 .../prototyping/api/external/set/service.md | 0 .../api/external/set/velocity_limit.md | 0 .../prototyping/api/list.md | 2 + .../prototyping/type/.pages | 0 .../srv/GetVersion.md | 0 .../msg/ClassifiedDiagnostics.md | 0 .../msg/ControlCommandStamped.md | 0 .../tier4_external_api_msgs/msg/DoorStatus.md | 0 .../tier4_external_api_msgs/msg/Emergency.md | 0 .../msg/EngageStatus.md | 0 .../msg/GearShiftStamped.md | 0 .../tier4_external_api_msgs/msg/Heartbeat.md | 0 .../tier4_external_api_msgs/msg/MapHash.md | 0 .../tier4_external_api_msgs/msg/Observer.md | 0 .../tier4_external_api_msgs/msg/Operator.md | 0 .../msg/RosbagLoggingMode.md | 6 +++ .../type/tier4_external_api_msgs/msg/Route.md | 0 .../tier4_external_api_msgs/msg/Service.md | 0 .../msg/TurnSignalStamped.md | 0 .../msg/VehicleStatusStamped.md | 0 .../tier4_external_api_msgs/srv/ClearRoute.md | 0 .../tier4_external_api_msgs/srv/Engage.md | 0 .../srv/GetMetadataPackages.md | 0 .../srv/GetTextFile.md | 0 .../srv/InitializePose.md | 0 .../srv/InitializePoseAuto.md | 0 .../srv/PauseDriving.md | 0 .../tier4_external_api_msgs/srv/SetDoor.md | 0 .../srv/SetEmergency.md | 0 .../srv/SetObserver.md | 0 .../srv/SetOperator.md | 0 .../srv/SetRosbagLoggingMode.md | 7 ++++ .../tier4_external_api_msgs/srv/SetRoute.md | 0 .../tier4_external_api_msgs/srv/SetService.md | 0 .../srv/SetVelocityLimit.md | 0 docs/design/component-interfaces/.pages | 2 - docs/design/component-interfaces/index.md | 5 --- docs/design/index.md | 4 +- tools/autoware_api_document/package.xml | 3 ++ .../autoware_api_document/python/__init__.py | 14 +++---- .../python/specification.py | 40 ++++--------------- .../external/get-command-selected-control.md | 7 ---- .../external/get-command-selected-vehicle.md | 7 ---- .../resource/page/external/get-diagnostics.md | 7 ---- .../resource/page/external/get-door.md | 7 ---- .../resource/page/external/get-emergency.md | 7 ---- .../resource/page/external/get-engage.md | 7 ---- .../page/external/get-map-info-hash.md | 7 ---- .../page/external/get-map-lanelet-xml.md | 7 ---- .../page/external/get-metadata-packages.md | 7 ---- .../resource/page/external/get-observer.md | 7 ---- .../resource/page/external/get-operator.md | 7 ---- .../resource/page/external/get-route.md | 7 ---- .../resource/page/external/get-service.md | 7 ---- .../page/external/get-vehicle-status.md | 7 ---- .../resource/page/external/get-version.md | 11 ----- .../resource/page/external/set-clear_route.md | 7 ---- .../external/set-command-local-control.md | 7 ---- .../external/set-command-local-heartbeat.md | 7 ---- .../page/external/set-command-local-shift.md | 7 ---- .../external/set-command-local-turn_signal.md | 7 ---- .../external/set-command-remote-control.md | 7 ---- .../external/set-command-remote-heartbeat.md | 7 ---- .../page/external/set-command-remote-shift.md | 7 ---- .../set-command-remote-turn_signal.md | 7 ---- .../resource/page/external/set-door.md | 7 ---- .../resource/page/external/set-emergency.md | 7 ---- .../resource/page/external/set-engage.md | 7 ---- .../page/external/set-initialize_pose.md | 7 ---- .../page/external/set-initialize_pose_auto.md | 7 ---- .../resource/page/external/set-observer.md | 7 ---- .../resource/page/external/set-operator.md | 7 ---- .../page/external/set-pause_driving.md | 7 ---- .../resource/page/external/set-route.md | 7 ---- .../resource/page/external/set-service.md | 7 ---- .../page/external/set-velocity_limit.md | 7 ---- .../autoware_api_document/resource/tier4.yaml | 6 +++ 120 files changed, 80 insertions(+), 309 deletions(-) delete mode 100644 docs/design/ad-api/.pages delete mode 100644 docs/design/ad-api/index.md create mode 100644 docs/design/autoware-interface/.pages rename docs/design/{ad-api => autoware-interface}/prototyping/.pages (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/.pages (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/command/selected/control.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/command/selected/vehicle.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/diagnostics.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/door.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/emergency.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/engage.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/map/info/hash.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/map/lanelet/xml.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/metadata/packages.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/observer.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/operator.md (100%) create mode 100644 docs/design/autoware-interface/prototyping/api/external/get/rosbag_logging_mode.md rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/route.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/service.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/vehicle/status.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/get/version.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/clear_route.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/local/control.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/local/gear_shift.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/local/heartbeat.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/local/shift.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/local/turn_signal.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/remote/control.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/remote/gear_shift.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/remote/heartbeat.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/remote/shift.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/command/remote/turn_signal.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/door.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/emergency.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/engage.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/initialize_pose.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/initialize_pose_auto.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/observer.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/operator.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/pause_driving.md (100%) create mode 100644 docs/design/autoware-interface/prototyping/api/external/set/rosbag_logging_mode.md rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/route.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/service.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/external/set/velocity_limit.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/api/list.md (94%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/.pages (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/autoware_external_api_msgs/srv/GetVersion.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/ClassifiedDiagnostics.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/ControlCommandStamped.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/DoorStatus.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/Emergency.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/EngageStatus.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/GearShiftStamped.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/Heartbeat.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/MapHash.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/Observer.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/Operator.md (100%) create mode 100644 docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/RosbagLoggingMode.md rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/Route.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/Service.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/TurnSignalStamped.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/msg/VehicleStatusStamped.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/ClearRoute.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/Engage.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/GetMetadataPackages.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/GetTextFile.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/InitializePose.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/InitializePoseAuto.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/PauseDriving.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/SetDoor.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/SetEmergency.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/SetObserver.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/SetOperator.md (100%) create mode 100644 docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetRosbagLoggingMode.md rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/SetRoute.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/SetService.md (100%) rename docs/design/{ad-api => autoware-interface}/prototyping/type/tier4_external_api_msgs/srv/SetVelocityLimit.md (100%) delete mode 100644 docs/design/component-interfaces/.pages delete mode 100644 docs/design/component-interfaces/index.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-command-selected-control.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-command-selected-vehicle.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-diagnostics.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-door.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-emergency.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-engage.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-map-info-hash.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-map-lanelet-xml.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-metadata-packages.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-observer.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-operator.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-route.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-service.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-vehicle-status.md delete mode 100644 tools/autoware_api_document/resource/page/external/get-version.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-clear_route.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-local-control.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-local-heartbeat.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-local-shift.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-local-turn_signal.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-remote-control.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-remote-heartbeat.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-remote-shift.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-command-remote-turn_signal.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-door.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-emergency.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-engage.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-initialize_pose.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-initialize_pose_auto.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-observer.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-operator.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-pause_driving.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-route.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-service.md delete mode 100644 tools/autoware_api_document/resource/page/external/set-velocity_limit.md diff --git a/docs/design/.pages b/docs/design/.pages index d49b239909c..9684822514f 100644 --- a/docs/design/.pages +++ b/docs/design/.pages @@ -1,5 +1,4 @@ nav: - index.md - - component-interfaces - - AD API: ad-api + - autoware-interface - configuration-management diff --git a/docs/design/ad-api/.pages b/docs/design/ad-api/.pages deleted file mode 100644 index dffbeb8be8b..00000000000 --- a/docs/design/ad-api/.pages +++ /dev/null @@ -1,3 +0,0 @@ -nav: - - index.md - - prototyping diff --git a/docs/design/ad-api/index.md b/docs/design/ad-api/index.md deleted file mode 100644 index 91e28c21d10..00000000000 --- a/docs/design/ad-api/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# AD API - -!!! warning - - Under Construction diff --git a/docs/design/autoware-interface/.pages b/docs/design/autoware-interface/.pages new file mode 100644 index 00000000000..19f1da14e51 --- /dev/null +++ b/docs/design/autoware-interface/.pages @@ -0,0 +1,2 @@ +nav: + - Prototyping: prototyping diff --git a/docs/design/ad-api/prototyping/.pages b/docs/design/autoware-interface/prototyping/.pages similarity index 100% rename from docs/design/ad-api/prototyping/.pages rename to docs/design/autoware-interface/prototyping/.pages diff --git a/docs/design/ad-api/prototyping/api/.pages b/docs/design/autoware-interface/prototyping/api/.pages similarity index 100% rename from docs/design/ad-api/prototyping/api/.pages rename to docs/design/autoware-interface/prototyping/api/.pages diff --git a/docs/design/ad-api/prototyping/api/external/get/command/selected/control.md b/docs/design/autoware-interface/prototyping/api/external/get/command/selected/control.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/command/selected/control.md rename to docs/design/autoware-interface/prototyping/api/external/get/command/selected/control.md diff --git a/docs/design/ad-api/prototyping/api/external/get/command/selected/vehicle.md b/docs/design/autoware-interface/prototyping/api/external/get/command/selected/vehicle.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/command/selected/vehicle.md rename to docs/design/autoware-interface/prototyping/api/external/get/command/selected/vehicle.md diff --git a/docs/design/ad-api/prototyping/api/external/get/diagnostics.md b/docs/design/autoware-interface/prototyping/api/external/get/diagnostics.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/diagnostics.md rename to docs/design/autoware-interface/prototyping/api/external/get/diagnostics.md diff --git a/docs/design/ad-api/prototyping/api/external/get/door.md b/docs/design/autoware-interface/prototyping/api/external/get/door.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/door.md rename to docs/design/autoware-interface/prototyping/api/external/get/door.md diff --git a/docs/design/ad-api/prototyping/api/external/get/emergency.md b/docs/design/autoware-interface/prototyping/api/external/get/emergency.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/emergency.md rename to docs/design/autoware-interface/prototyping/api/external/get/emergency.md diff --git a/docs/design/ad-api/prototyping/api/external/get/engage.md b/docs/design/autoware-interface/prototyping/api/external/get/engage.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/engage.md rename to docs/design/autoware-interface/prototyping/api/external/get/engage.md diff --git a/docs/design/ad-api/prototyping/api/external/get/map/info/hash.md b/docs/design/autoware-interface/prototyping/api/external/get/map/info/hash.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/map/info/hash.md rename to docs/design/autoware-interface/prototyping/api/external/get/map/info/hash.md diff --git a/docs/design/ad-api/prototyping/api/external/get/map/lanelet/xml.md b/docs/design/autoware-interface/prototyping/api/external/get/map/lanelet/xml.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/map/lanelet/xml.md rename to docs/design/autoware-interface/prototyping/api/external/get/map/lanelet/xml.md diff --git a/docs/design/ad-api/prototyping/api/external/get/metadata/packages.md b/docs/design/autoware-interface/prototyping/api/external/get/metadata/packages.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/metadata/packages.md rename to docs/design/autoware-interface/prototyping/api/external/get/metadata/packages.md diff --git a/docs/design/ad-api/prototyping/api/external/get/observer.md b/docs/design/autoware-interface/prototyping/api/external/get/observer.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/observer.md rename to docs/design/autoware-interface/prototyping/api/external/get/observer.md diff --git a/docs/design/ad-api/prototyping/api/external/get/operator.md b/docs/design/autoware-interface/prototyping/api/external/get/operator.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/operator.md rename to docs/design/autoware-interface/prototyping/api/external/get/operator.md diff --git a/docs/design/autoware-interface/prototyping/api/external/get/rosbag_logging_mode.md b/docs/design/autoware-interface/prototyping/api/external/get/rosbag_logging_mode.md new file mode 100644 index 00000000000..9931944d8b1 --- /dev/null +++ b/docs/design/autoware-interface/prototyping/api/external/get/rosbag_logging_mode.md @@ -0,0 +1,19 @@ +# /api/external/get/rosbag_logging_mode + +## Classification + +- Behavior: Topic +- DataType: tier4_external_api_msgs/msg/RosbagLoggingMode + +## Description + +rosbag 記録モードを取得する。 + +| Mode | is_operation_mode | +| ------------- | ----------------- | +| 常時記録 | false | +| EM 発生時記録 | true | + +## Requirement + +現在設定されている「常時記録」または「EM 発生時記録」いずれかの rosbag 記録モードを提供すること。 diff --git a/docs/design/ad-api/prototyping/api/external/get/route.md b/docs/design/autoware-interface/prototyping/api/external/get/route.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/route.md rename to docs/design/autoware-interface/prototyping/api/external/get/route.md diff --git a/docs/design/ad-api/prototyping/api/external/get/service.md b/docs/design/autoware-interface/prototyping/api/external/get/service.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/service.md rename to docs/design/autoware-interface/prototyping/api/external/get/service.md diff --git a/docs/design/ad-api/prototyping/api/external/get/vehicle/status.md b/docs/design/autoware-interface/prototyping/api/external/get/vehicle/status.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/vehicle/status.md rename to docs/design/autoware-interface/prototyping/api/external/get/vehicle/status.md diff --git a/docs/design/ad-api/prototyping/api/external/get/version.md b/docs/design/autoware-interface/prototyping/api/external/get/version.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/get/version.md rename to docs/design/autoware-interface/prototyping/api/external/get/version.md diff --git a/docs/design/ad-api/prototyping/api/external/set/clear_route.md b/docs/design/autoware-interface/prototyping/api/external/set/clear_route.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/clear_route.md rename to docs/design/autoware-interface/prototyping/api/external/set/clear_route.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/local/control.md b/docs/design/autoware-interface/prototyping/api/external/set/command/local/control.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/local/control.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/local/control.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/local/gear_shift.md b/docs/design/autoware-interface/prototyping/api/external/set/command/local/gear_shift.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/local/gear_shift.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/local/gear_shift.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/local/heartbeat.md b/docs/design/autoware-interface/prototyping/api/external/set/command/local/heartbeat.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/local/heartbeat.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/local/heartbeat.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/local/shift.md b/docs/design/autoware-interface/prototyping/api/external/set/command/local/shift.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/local/shift.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/local/shift.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/local/turn_signal.md b/docs/design/autoware-interface/prototyping/api/external/set/command/local/turn_signal.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/local/turn_signal.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/local/turn_signal.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/remote/control.md b/docs/design/autoware-interface/prototyping/api/external/set/command/remote/control.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/remote/control.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/remote/control.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/remote/gear_shift.md b/docs/design/autoware-interface/prototyping/api/external/set/command/remote/gear_shift.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/remote/gear_shift.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/remote/gear_shift.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/remote/heartbeat.md b/docs/design/autoware-interface/prototyping/api/external/set/command/remote/heartbeat.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/remote/heartbeat.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/remote/heartbeat.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/remote/shift.md b/docs/design/autoware-interface/prototyping/api/external/set/command/remote/shift.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/remote/shift.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/remote/shift.md diff --git a/docs/design/ad-api/prototyping/api/external/set/command/remote/turn_signal.md b/docs/design/autoware-interface/prototyping/api/external/set/command/remote/turn_signal.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/command/remote/turn_signal.md rename to docs/design/autoware-interface/prototyping/api/external/set/command/remote/turn_signal.md diff --git a/docs/design/ad-api/prototyping/api/external/set/door.md b/docs/design/autoware-interface/prototyping/api/external/set/door.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/door.md rename to docs/design/autoware-interface/prototyping/api/external/set/door.md diff --git a/docs/design/ad-api/prototyping/api/external/set/emergency.md b/docs/design/autoware-interface/prototyping/api/external/set/emergency.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/emergency.md rename to docs/design/autoware-interface/prototyping/api/external/set/emergency.md diff --git a/docs/design/ad-api/prototyping/api/external/set/engage.md b/docs/design/autoware-interface/prototyping/api/external/set/engage.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/engage.md rename to docs/design/autoware-interface/prototyping/api/external/set/engage.md diff --git a/docs/design/ad-api/prototyping/api/external/set/initialize_pose.md b/docs/design/autoware-interface/prototyping/api/external/set/initialize_pose.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/initialize_pose.md rename to docs/design/autoware-interface/prototyping/api/external/set/initialize_pose.md diff --git a/docs/design/ad-api/prototyping/api/external/set/initialize_pose_auto.md b/docs/design/autoware-interface/prototyping/api/external/set/initialize_pose_auto.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/initialize_pose_auto.md rename to docs/design/autoware-interface/prototyping/api/external/set/initialize_pose_auto.md diff --git a/docs/design/ad-api/prototyping/api/external/set/observer.md b/docs/design/autoware-interface/prototyping/api/external/set/observer.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/observer.md rename to docs/design/autoware-interface/prototyping/api/external/set/observer.md diff --git a/docs/design/ad-api/prototyping/api/external/set/operator.md b/docs/design/autoware-interface/prototyping/api/external/set/operator.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/operator.md rename to docs/design/autoware-interface/prototyping/api/external/set/operator.md diff --git a/docs/design/ad-api/prototyping/api/external/set/pause_driving.md b/docs/design/autoware-interface/prototyping/api/external/set/pause_driving.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/pause_driving.md rename to docs/design/autoware-interface/prototyping/api/external/set/pause_driving.md diff --git a/docs/design/autoware-interface/prototyping/api/external/set/rosbag_logging_mode.md b/docs/design/autoware-interface/prototyping/api/external/set/rosbag_logging_mode.md new file mode 100644 index 00000000000..fb371b5e710 --- /dev/null +++ b/docs/design/autoware-interface/prototyping/api/external/set/rosbag_logging_mode.md @@ -0,0 +1,19 @@ +# /api/external/set/rosbag_logging_mode + +## Classification + +- Behavior: Service +- DataType: tier4_external_api_msgs/srv/SetRosbagLoggingMode + +## Description + +rosbag 記録モードを設定する。 + +| Mode | is_operation_mode | +| ------------- | ----------------- | +| 常時記録 | false | +| EM 発生時記録 | true | + +## Requirement + +現在の rosbag 記録モードを「常時記録」または「EM 発生時記録」いずれかに設定し、rosbag 記録の保存先および保存対象の制御を行うこと。 diff --git a/docs/design/ad-api/prototyping/api/external/set/route.md b/docs/design/autoware-interface/prototyping/api/external/set/route.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/route.md rename to docs/design/autoware-interface/prototyping/api/external/set/route.md diff --git a/docs/design/ad-api/prototyping/api/external/set/service.md b/docs/design/autoware-interface/prototyping/api/external/set/service.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/service.md rename to docs/design/autoware-interface/prototyping/api/external/set/service.md diff --git a/docs/design/ad-api/prototyping/api/external/set/velocity_limit.md b/docs/design/autoware-interface/prototyping/api/external/set/velocity_limit.md similarity index 100% rename from docs/design/ad-api/prototyping/api/external/set/velocity_limit.md rename to docs/design/autoware-interface/prototyping/api/external/set/velocity_limit.md diff --git a/docs/design/ad-api/prototyping/api/list.md b/docs/design/autoware-interface/prototyping/api/list.md similarity index 94% rename from docs/design/ad-api/prototyping/api/list.md rename to docs/design/autoware-interface/prototyping/api/list.md index 3d5c256d55d..047909eec9d 100644 --- a/docs/design/ad-api/prototyping/api/list.md +++ b/docs/design/autoware-interface/prototyping/api/list.md @@ -39,3 +39,5 @@ | topic | [/api/external/set/command/remote/heartbeat](../../api/external/set/command/remote/heartbeat) | [tier4_external_api_msgs/msg/Heartbeat](../../type/tier4_external_api_msgs/msg/Heartbeat) | | topic | [/api/external/get/command/selected/control](../../api/external/get/command/selected/control) | [tier4_external_api_msgs/msg/ControlCommandStamped](../../type/tier4_external_api_msgs/msg/ControlCommandStamped) | | topic | [/api/external/get/command/selected/vehicle](../../api/external/get/command/selected/vehicle) | [tier4_external_api_msgs/msg/ControlCommandStamped](../../type/tier4_external_api_msgs/msg/ControlCommandStamped) | +| service | [/api/external/set/rosbag_logging_mode](../../api/external/set/rosbag_logging_mode) | [tier4_external_api_msgs/srv/SetRosbagLoggingMode](../../type/tier4_external_api_msgs/srv/SetRosbagLoggingMode) | +| topic | [/api/external/get/rosbag_logging_mode](../../api/external/get/rosbag_logging_mode) | [tier4_external_api_msgs/msg/RosbagLoggingMode](../../type/tier4_external_api_msgs/msg/RosbagLoggingMode) | diff --git a/docs/design/ad-api/prototyping/type/.pages b/docs/design/autoware-interface/prototyping/type/.pages similarity index 100% rename from docs/design/ad-api/prototyping/type/.pages rename to docs/design/autoware-interface/prototyping/type/.pages diff --git a/docs/design/ad-api/prototyping/type/autoware_external_api_msgs/srv/GetVersion.md b/docs/design/autoware-interface/prototyping/type/autoware_external_api_msgs/srv/GetVersion.md similarity index 100% rename from docs/design/ad-api/prototyping/type/autoware_external_api_msgs/srv/GetVersion.md rename to docs/design/autoware-interface/prototyping/type/autoware_external_api_msgs/srv/GetVersion.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/ClassifiedDiagnostics.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/ClassifiedDiagnostics.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/ClassifiedDiagnostics.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/ClassifiedDiagnostics.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/ControlCommandStamped.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/ControlCommandStamped.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/ControlCommandStamped.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/ControlCommandStamped.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/DoorStatus.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/DoorStatus.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/DoorStatus.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/DoorStatus.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Emergency.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Emergency.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Emergency.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Emergency.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/EngageStatus.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/EngageStatus.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/EngageStatus.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/EngageStatus.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/GearShiftStamped.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/GearShiftStamped.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/GearShiftStamped.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/GearShiftStamped.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Heartbeat.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Heartbeat.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Heartbeat.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Heartbeat.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/MapHash.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/MapHash.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/MapHash.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/MapHash.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Observer.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Observer.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Observer.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Observer.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Operator.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Operator.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Operator.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Operator.md diff --git a/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/RosbagLoggingMode.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/RosbagLoggingMode.md new file mode 100644 index 00000000000..e9ed09293a8 --- /dev/null +++ b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/RosbagLoggingMode.md @@ -0,0 +1,6 @@ +# RosbagLoggingMode + +```txt +# fields +bool is_operation_mode +``` diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Route.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Route.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Route.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Route.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Service.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Service.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/Service.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/Service.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/TurnSignalStamped.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/TurnSignalStamped.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/TurnSignalStamped.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/TurnSignalStamped.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/VehicleStatusStamped.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/VehicleStatusStamped.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/msg/VehicleStatusStamped.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/msg/VehicleStatusStamped.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/ClearRoute.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/ClearRoute.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/ClearRoute.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/ClearRoute.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/Engage.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/Engage.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/Engage.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/Engage.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/GetMetadataPackages.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/GetMetadataPackages.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/GetMetadataPackages.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/GetMetadataPackages.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/GetTextFile.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/GetTextFile.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/GetTextFile.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/GetTextFile.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/InitializePose.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/InitializePose.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/InitializePose.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/InitializePose.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/InitializePoseAuto.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/InitializePoseAuto.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/InitializePoseAuto.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/InitializePoseAuto.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/PauseDriving.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/PauseDriving.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/PauseDriving.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/PauseDriving.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetDoor.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetDoor.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetDoor.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetDoor.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetEmergency.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetEmergency.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetEmergency.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetEmergency.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetObserver.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetObserver.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetObserver.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetObserver.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetOperator.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetOperator.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetOperator.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetOperator.md diff --git a/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetRosbagLoggingMode.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetRosbagLoggingMode.md new file mode 100644 index 00000000000..769cdcd4fa5 --- /dev/null +++ b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetRosbagLoggingMode.md @@ -0,0 +1,7 @@ +# SetRosbagLoggingMode + +```txt +bool is_operation_mode +--- +tier4_external_api_msgs/ResponseStatus status +``` diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetRoute.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetRoute.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetRoute.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetRoute.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetService.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetService.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetService.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetService.md diff --git a/docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetVelocityLimit.md b/docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetVelocityLimit.md similarity index 100% rename from docs/design/ad-api/prototyping/type/tier4_external_api_msgs/srv/SetVelocityLimit.md rename to docs/design/autoware-interface/prototyping/type/tier4_external_api_msgs/srv/SetVelocityLimit.md diff --git a/docs/design/component-interfaces/.pages b/docs/design/component-interfaces/.pages deleted file mode 100644 index 35fd5a113be..00000000000 --- a/docs/design/component-interfaces/.pages +++ /dev/null @@ -1,2 +0,0 @@ -nav: - - index.md diff --git a/docs/design/component-interfaces/index.md b/docs/design/component-interfaces/index.md deleted file mode 100644 index d3170ab4fdc..00000000000 --- a/docs/design/component-interfaces/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Component interfaces - -!!! warning - - Under Construction diff --git a/docs/design/index.md b/docs/design/index.md index 27ee7d1cfe6..77a9964e33e 100644 --- a/docs/design/index.md +++ b/docs/design/index.md @@ -4,8 +4,6 @@ Under Construction -## Component interfaces - -## AD API +## Autoware interfaces ## Configuration management diff --git a/tools/autoware_api_document/package.xml b/tools/autoware_api_document/package.xml index 72ce87f65a6..71d4e895126 100644 --- a/tools/autoware_api_document/package.xml +++ b/tools/autoware_api_document/package.xml @@ -11,6 +11,9 @@ ament_cmake_auto ament_cmake_python + autoware_external_api_msgs + tier4_external_api_msgs + ament_lint_auto ament_lint_common diff --git a/tools/autoware_api_document/python/__init__.py b/tools/autoware_api_document/python/__init__.py index c77c8001c20..e2aca015d08 100644 --- a/tools/autoware_api_document/python/__init__.py +++ b/tools/autoware_api_document/python/__init__.py @@ -22,7 +22,7 @@ def generate(): parser = argparse.ArgumentParser() - parser.add_argument('path', default='docs/design/ad-api/prototyping', nargs='?') + parser.add_argument('path', default='docs/design/autoware-interface/prototyping', nargs='?') args = parser.parse_args() target = pathlib.Path(args.path) @@ -32,7 +32,7 @@ def generate(): groups = [ ('external', 'autoware_api_document', 'resource/tier4.yaml'), ] - groups = [(data[0], list(AutowareAPI.Load(*data[1:]))) for data in groups] + groups = [(data[0], list(AutowareAPI.Load(target, *data[1:]))) for data in groups] # create list generate_list(target, groups) @@ -77,7 +77,9 @@ def make_type_link(spec : AutowareAPI): def generate_page(target, spec): - lines = [ + text = spec.page.read_text().split('## Description') + text = text[0] if len(text) < 2 else text[1] + line = [ '# ' + spec.spec_name, '', '## Classification', @@ -85,11 +87,9 @@ def generate_page(target, spec): '- Behavior: ' + spec.behavior.capitalize(), '- DataType: ' + spec.data_type, '', - spec.page, + '## Description', ] - path = target.joinpath(spec.spec_name.strip('/')).with_suffix('.md') - path.parent.mkdir(parents=True, exist_ok=True) - path.write_text('\n'.join(lines) + '\n') + spec.page.write_text('\n'.join(line) + '\n\n' + text.strip() + '\n') def generate_type(target, definition): diff --git a/tools/autoware_api_document/python/specification.py b/tools/autoware_api_document/python/specification.py index 559bfd6c521..9eaa9b8b796 100644 --- a/tools/autoware_api_document/python/specification.py +++ b/tools/autoware_api_document/python/specification.py @@ -36,30 +36,6 @@ def __load_page(self, name): path = path.joinpath(*name[1:]).with_suffix('.' + name[1]) return path.read_text().strip() if path.exists() else None - """ - def __load_page(self, name): - name = name.split('/') - if name[0] not in self.my_packages: - return None - path = pathlib.Path(get_package_share_directory(name[0])) - path = path.joinpath(*name[1:]).with_suffix('.' + name[1]) - return self.__highlight(path.read_text().strip()) if path.exists() else None - - def __highlight(self, text): - code = '' - for line in text.split('\n'): - match = re.match(R'^([\w/]*)(.*)$', line) - names = match.group(1).split('/') - other = match.group(2) - if names[0] in self.my_packages: - data = names.copy() - data.insert(-1, 'msg') - data = TypeDefinition.Get('/'.join(data)) - line = '{}{}'.format(data.path, '/'.join(names), other) - code += line + '\n' - return code - """ - @property def name(self): return self._path.split('/')[-1] @@ -82,17 +58,15 @@ def Get(cls, name): class AutowareAPI(object): - def __init__(self, name, data): + def __init__(self, target, name, data): self._name = name.strip('/').split('/') self._data = data - self._page = self.__load_page(name) + self._page = self.__load_page(target, name) self._type = self.__load_type(data['type']) - def __load_page(self, name): - name = name.split('/') - path = pathlib.Path(get_package_share_directory('autoware_api_document')) - path = path.joinpath('resource/page', name[0], '-'.join(name[1:])).with_suffix('.md') - return path.read_text().strip() if path.exists() else None + def __load_page(self, target, name): + path = target.joinpath(self.spec_name.strip('/')).with_suffix('.md') + return path if path.exists() else None def __load_type(self, name): return TypeDefinition.Get(name) @@ -118,8 +92,8 @@ def typedef(self): return self._type @staticmethod - def Load(package: str, path : str): + def Load(target, package: str, path : str): package = get_package_share_directory(package) path = pathlib.Path(package, path) for name, data in yaml.safe_load(path.read_text()).items(): - yield AutowareAPI(name, data) + yield AutowareAPI(target, name, data) diff --git a/tools/autoware_api_document/resource/page/external/get-command-selected-control.md b/tools/autoware_api_document/resource/page/external/get-command-selected-control.md deleted file mode 100644 index 010df5e8abc..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-command-selected-control.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両にて受け付けた最新の制御コマンドを取得する。 - -## Requirement - -車両が受け付けた local/remote いずれかの制御コマンドを提供すること。 diff --git a/tools/autoware_api_document/resource/page/external/get-command-selected-vehicle.md b/tools/autoware_api_document/resource/page/external/get-command-selected-vehicle.md deleted file mode 100644 index 020c173be4f..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-command-selected-vehicle.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両に送信している最新の制御コマンドを取得する。 - -## Requirement - -車両に送信している各種処理を行った最終的な制御コマンドを提供すること。 diff --git a/tools/autoware_api_document/resource/page/external/get-diagnostics.md b/tools/autoware_api_document/resource/page/external/get-diagnostics.md deleted file mode 100644 index 1d481474041..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-diagnostics.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の各種診断情報を取得する。 - -## Requirement - -現在の車両の状態に応じて分類した各種診断情報を提供すること。 diff --git a/tools/autoware_api_document/resource/page/external/get-door.md b/tools/autoware_api_document/resource/page/external/get-door.md deleted file mode 100644 index 6e8f22120da..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-door.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両のドア状態を取得する。 - -## Requirement - -車両のドア状態を提供すること。 diff --git a/tools/autoware_api_document/resource/page/external/get-emergency.md b/tools/autoware_api_document/resource/page/external/get-emergency.md deleted file mode 100644 index 9004c7d287a..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-emergency.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両を外部指示緊急停止状態を取得する。 - -## Requirement - -車両の停止が完了しているかに関わらず、外部指示緊急停止状態が取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-engage.md b/tools/autoware_api_document/resource/page/external/get-engage.md deleted file mode 100644 index 1ad8d3f55a9..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-engage.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -エンゲージ状態を取得する。 - -## Requirement - -現在のエンゲージ状態が取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-map-info-hash.md b/tools/autoware_api_document/resource/page/external/get-map-info-hash.md deleted file mode 100644 index 5c4522fcb6b..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-map-info-hash.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -現在設定されている地図のハッシュを取得する。 - -## Requirement - -地図データを保持するファイルのハッシュ値(SHA-256)を取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-map-lanelet-xml.md b/tools/autoware_api_document/resource/page/external/get-map-lanelet-xml.md deleted file mode 100644 index af29b3d3957..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-map-lanelet-xml.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -地図情報を Lanelet の XML(OSM) 形式で取得する。 - -## Requirement - -必要に応じて地図フォーマットの変換を行い、地図情報が Lanelet の XML(OSM) 形式で取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-metadata-packages.md b/tools/autoware_api_document/resource/page/external/get-metadata-packages.md deleted file mode 100644 index dd70a96719b..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-metadata-packages.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -Autoware の実装バージョンを特定するための各種情報を取得する。 - -## Requirement - -Autoware を構成する各パッケージが本 API 向けの情報を提供している場合、パッケージ名をキーとする辞書形式で情報が取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-observer.md b/tools/autoware_api_document/resource/page/external/get-observer.md deleted file mode 100644 index 6e360513b56..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-observer.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の監視を行う対象を取得する。 - -## Requirement - -現在車両の監視を行っている対象を取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-operator.md b/tools/autoware_api_document/resource/page/external/get-operator.md deleted file mode 100644 index af45fd5cd00..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-operator.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の操作を行う対象を取得する。 - -## Requirement - -現在車両の操作を行っている対象を取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-route.md b/tools/autoware_api_document/resource/page/external/get-route.md deleted file mode 100644 index e2c416cbc85..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-route.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の運行ルートを取得する。 - -## Requirement - -[[/api/external/set/route]]により設定された運行ルートを取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-service.md b/tools/autoware_api_document/resource/page/external/get-service.md deleted file mode 100644 index 17cc50e2f75..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-service.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両のサービス提供状態を取得する。 - -## Requirement - -[[/api/external/set/engage]]により設定されたサービス状態を取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-vehicle-status.md b/tools/autoware_api_document/resource/page/external/get-vehicle-status.md deleted file mode 100644 index c3e1b6d356d..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-vehicle-status.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両制御に関する情報を取得する。 - -## Requirement - -車両の速度、ステア、ウィンカー、ギアに関する情報を取得できること。 diff --git a/tools/autoware_api_document/resource/page/external/get-version.md b/tools/autoware_api_document/resource/page/external/get-version.md deleted file mode 100644 index d5cf4a9fece..00000000000 --- a/tools/autoware_api_document/resource/page/external/get-version.md +++ /dev/null @@ -1,11 +0,0 @@ -## Description - -Autoware External API のバージョン情報を取得する。 - -## Requirement - -以下の規則に従ったバージョン文字列`major.minor.patch`が取得できること。 - -- major: 全体に関わる大規模な変更があったとき。 -- minor: 互換性の失われる変更があったとき。 -- patch: 互換性の維持される変更があったとき。 diff --git a/tools/autoware_api_document/resource/page/external/set-clear_route.md b/tools/autoware_api_document/resource/page/external/set-clear_route.md deleted file mode 100644 index dd28cb712dc..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-clear_route.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の運行ルートを取り消す。 - -## Requirement - -[[/api/external/set/route]]により設定された運行ルートを取り消すこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-local-control.md b/tools/autoware_api_document/resource/page/external/set-command-local-control.md deleted file mode 100644 index e9f37ea7e41..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-local-control.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両のアクセル・ブレーキ・ステアリングを制御するコマンドを送信する。 - -## Requirement - -現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-local-heartbeat.md b/tools/autoware_api_document/resource/page/external/set-command-local-heartbeat.md deleted file mode 100644 index ba3d1a3316b..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-local-heartbeat.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両との通信状態を確認するための信号を送信する。 - -## Requirement - -この信号が途切れた場合、車両は監視されていない状態になったとして適切な制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-local-shift.md b/tools/autoware_api_document/resource/page/external/set-command-local-shift.md deleted file mode 100644 index 8cbe8aeb3db..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-local-shift.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の変速機を制御するコマンドを送信する。 - -## Requirement - -現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-local-turn_signal.md b/tools/autoware_api_document/resource/page/external/set-command-local-turn_signal.md deleted file mode 100644 index 934345389cf..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-local-turn_signal.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の方向指示器を制御するコマンドを送信する。 - -## Requirement - -現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-remote-control.md b/tools/autoware_api_document/resource/page/external/set-command-remote-control.md deleted file mode 100644 index e9f37ea7e41..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-remote-control.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両のアクセル・ブレーキ・ステアリングを制御するコマンドを送信する。 - -## Requirement - -現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-remote-heartbeat.md b/tools/autoware_api_document/resource/page/external/set-command-remote-heartbeat.md deleted file mode 100644 index ba3d1a3316b..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-remote-heartbeat.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両との通信状態を確認するための信号を送信する。 - -## Requirement - -この信号が途切れた場合、車両は監視されていない状態になったとして適切な制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-remote-shift.md b/tools/autoware_api_document/resource/page/external/set-command-remote-shift.md deleted file mode 100644 index 8cbe8aeb3db..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-remote-shift.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の変速機を制御するコマンドを送信する。 - -## Requirement - -現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-command-remote-turn_signal.md b/tools/autoware_api_document/resource/page/external/set-command-remote-turn_signal.md deleted file mode 100644 index 934345389cf..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-command-remote-turn_signal.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の方向指示器を制御するコマンドを送信する。 - -## Requirement - -現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-door.md b/tools/autoware_api_document/resource/page/external/set-door.md deleted file mode 100644 index e3b435ee871..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-door.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両のドア開閉を行う。 - -## Requirement - -車両のドア操作を行うこと。車両にドアがない場合は常に失敗として応答すること。 diff --git a/tools/autoware_api_document/resource/page/external/set-emergency.md b/tools/autoware_api_document/resource/page/external/set-emergency.md deleted file mode 100644 index f4567d5392c..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-emergency.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両を外部指示緊急停止状態に設定する。 - -## Requirement - -現在の車両の状態を考慮した適切な緊急停止の制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-engage.md b/tools/autoware_api_document/resource/page/external/set-engage.md deleted file mode 100644 index 3ead9998ed7..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-engage.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の停止保持状態を設定・解除する。自律制御開始時、または、停留所や荷物の積み下ろし中など、何らかのユーザー操作が行われるまで車両の停止を継続させる。 - -## Requirement - -エンゲージ状態が true に設定されていない場合、車両が停止保持するように制御信号を出力すること。 diff --git a/tools/autoware_api_document/resource/page/external/set-initialize_pose.md b/tools/autoware_api_document/resource/page/external/set-initialize_pose.md deleted file mode 100644 index 6f04b35f23c..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-initialize_pose.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -指定した位置姿勢をもとに、車両の位置姿勢を初期化・再設定する。 - -## Requirement - -位置姿勢に関する事前状態を考慮せず、指定した位置姿勢のみを用いて車両の位置姿勢を初期化・再設定する。 diff --git a/tools/autoware_api_document/resource/page/external/set-initialize_pose_auto.md b/tools/autoware_api_document/resource/page/external/set-initialize_pose_auto.md deleted file mode 100644 index c3fbf7bd1a0..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-initialize_pose_auto.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -GNSS による位置姿勢をもとに、車両の位置姿勢を初期化・再設定する。 - -## Requirement - -位置姿勢に関する事前状態を考慮せず、GNSS による位置姿勢のみを用いて車両の位置姿勢を初期化・再設定する。 diff --git a/tools/autoware_api_document/resource/page/external/set-observer.md b/tools/autoware_api_document/resource/page/external/set-observer.md deleted file mode 100644 index 6ba45ab877e..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-observer.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の監視を行う対象を設定する。 - -## Requirement - -指定された対象が車両を監視できる状態か確認して切り替えを行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-operator.md b/tools/autoware_api_document/resource/page/external/set-operator.md deleted file mode 100644 index fb3c4658881..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-operator.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の操作を行う対象を設定する。 - -## Requirement - -指定された対象が車両を操作できる状態か確認して切り替えを行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-pause_driving.md b/tools/autoware_api_document/resource/page/external/set-pause_driving.md deleted file mode 100644 index 52d8da3d7bf..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-pause_driving.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両を停止状態に設定する。 - -## Requirement - -現在の車両の状態を考慮した適切な停止の制御を行うこと。 diff --git a/tools/autoware_api_document/resource/page/external/set-route.md b/tools/autoware_api_document/resource/page/external/set-route.md deleted file mode 100644 index 554bda27120..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-route.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の運行ルートを設定する。 - -## Requirement - -指定された運行ルートを用いて車両の走行経路を設定すること。 diff --git a/tools/autoware_api_document/resource/page/external/set-service.md b/tools/autoware_api_document/resource/page/external/set-service.md deleted file mode 100644 index 60959f1fc5e..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-service.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両のサービス提供状態を設定する。 - -## Requirement - -指定されたサービス状態を保持すること。 diff --git a/tools/autoware_api_document/resource/page/external/set-velocity_limit.md b/tools/autoware_api_document/resource/page/external/set-velocity_limit.md deleted file mode 100644 index fbebe073e5b..00000000000 --- a/tools/autoware_api_document/resource/page/external/set-velocity_limit.md +++ /dev/null @@ -1,7 +0,0 @@ -## Description - -車両の制限速度を設定する。 - -## Requirement - -指定された制限速度以下になるように車両の制御を行うこと。現在の速度が制限速度を超えている場合、車両の状態を考慮して適切に制限速度以下になるような制御を行うこと。 diff --git a/tools/autoware_api_document/resource/tier4.yaml b/tools/autoware_api_document/resource/tier4.yaml index e241f9b5efa..9d5cd70fc8d 100644 --- a/tools/autoware_api_document/resource/tier4.yaml +++ b/tools/autoware_api_document/resource/tier4.yaml @@ -103,3 +103,9 @@ external/get/command/selected/control: external/get/command/selected/vehicle: behavior: topic type: tier4_external_api_msgs/msg/ControlCommandStamped +external/set/rosbag_logging_mode: + behavior: service + type: tier4_external_api_msgs/srv/SetRosbagLoggingMode +external/get/rosbag_logging_mode: + behavior: topic + type: tier4_external_api_msgs/msg/RosbagLoggingMode