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

docs: add rosbag api #44

Open
wants to merge 5 commits into
base: tier4/main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# /api/autoware/get/rosbag_record

## Classification

- Behavior: Topic
- DataType: tier4_external_api_msgs/msg/RosbagRecordStatus

## Description

rosbag 記録状態を取得する。

| Mode | status |
| ------------------------------- | ----------------------- |
| 初期化中 | 0: INITIALIZING |
| 車両情報受信待ち | 1: WAITING_VEHICLE_INFO |
| rosbag record開始条件の成立待ち | 2: READY |
| rosbag record動作中 | 3: RECORDING |
| エラー発生中 | 4: ERROR |

## Requirement

現在のrosbag 記録状態を提供すること。

## Remarks

エラー発生中(4: ERROR)となる条件

- 設定が不正の時
- disk容量が足りない
- rosbag record中にディスクが接続されてない状態になった時(書き込み先のフォルダが存在しない)
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# /api/autoware/set/rosbag_record

## Classification

- Behavior: Service
- DataType: tier4_external_api_msgs/srv/SetRosbagRecord

## Description

rosbag 記録の開始/停止を行う。

| Mode | record |
| -------- | ------ |
| 記録開始 | false |
| 記録停止 | true |

## Requirement

現在の rosbag record 動作モード(`recording_type`)が「手動記録」(`manual`)の時で、本サービスリスエクストを受信した時は、rosbag 記録の開始または停止を行うこと。

## Remarks

`recording_type`の変更方法

`/etc/autoware_logging_suite/logpacker/logpacker_config.yaml`<br>
`recording_type`の部分を変更する。設定可能な値は、`manual`, `auto`である。

```yaml
rosbag:
# If you use another file for rosbag configuration, define its file path. When not defined, this file will be used.
# params_file: "{{ logpacker_config_dir }}/rosbag_params.yaml"
recording_type: "manual"
```
2 changes: 2 additions & 0 deletions docs/design/autoware-interfaces/prototyping/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@
| topic | [/api/external/get/command/selected/vehicle](./api/external/get/command/selected/vehicle.md) | [tier4_external_api_msgs/msg/ControlCommandStamped](./type/tier4_external_api_msgs/msg/ControlCommandStamped.md) |
| service | [/api/external/set/rosbag_logging_mode](./api/external/set/rosbag_logging_mode.md) | [tier4_external_api_msgs/srv/SetRosbagLoggingMode](./type/tier4_external_api_msgs/srv/SetRosbagLoggingMode.md) |
| topic | [/api/external/get/rosbag_logging_mode](./api/external/get/rosbag_logging_mode.md) | [tier4_external_api_msgs/msg/RosbagLoggingMode](./type/tier4_external_api_msgs/msg/RosbagLoggingMode.md) |
| service | [/api/autoware/set/rosbag_record](./api/external/set/rosbag_record.md) | [tier4_external_api_msgs/srv/SetRosbagRecord](./type/tier4_external_api_msgs/srv/SetRosbagRecord.md) |
| topic | [/api/autoware/get/rosbag_record](./api/external/get/rosbag_record.md) | [tier4_external_api_msgs/msg/RosbagRecordStatus](./type/tier4_external_api_msgs/msg/RosbagRecordStatus.md) |
| topic | [/api/external/get/calibration_status](./api/external/get/calibration_status.md) | [tier4_external_api_msgs/msg/CalibrationStatusArray](./type/tier4_external_api_msgs/msg/CalibrationStatusArray.md) |
| service | [/api/external/get/accel_brake_map_calibrator/data](./api/external/get/accel_brake_map_calibrator/data.md) | [tier4_external_api_msgs/srv/GetAccelBrakeMapCalibrationData](./type/tier4_external_api_msgs/srv/GetAccelBrakeMapCalibrationData.md) |
| topic | [/api/iv_msgs/autoware/state](./api/iv_msgs/autoware/state.md) | [tier4_system_msgs/msg/AutowareState](./type/tier4_system_msgs/msg/AutowareState.md) |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# RosbagRecordStatus

```txt
# fields
uint8 status
string message
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# SetRosbagRecord

```txt
bool record
---
tier4_external_api_msgs/ResponseStatus status
```
Loading