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: update simulator specs about options and sensors #68

Merged
merged 1 commit into from
Jul 18, 2024
Merged
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
67 changes: 66 additions & 1 deletion docs/specifications/simulator.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,47 @@ This page describes the specifications of the simulator used in the AI Challenge

The simulator is based on the open-source autonomous driving simulator "[AWSIM](https://github.com/tier4/AWSIM)" developed for Autoware.

## Commandline Options

| Option | Type | Default | Description |
| ---------- | ----- | ---------- | -------------------------------------------- |
| --timeout | float | 420.0 | Set session timeout seconds. |
| --endless | bool | false | Enable/disable session timeout. |
| --pit-stop | bool | true | Enable/disable features related to pit-stop. |

## Keyboard Operation

| Operation | Key |
| ------------------ | ----------------- |
| Quit | Esc |
| Reset | Space |
| Switch camera | C |
| Accel | Arrow Up |
| Brake | Arrow Down |
| Steering | Arrow Left, Right |
| Gear (D) | D |
| Gear (R) | R |
| Gear (N) | N |
| Gear (P) | P |

## Topic Operation

| Topic | Type | Description |
| ------------------------------------ | ------------------------------ | ------------------------------------- |
| /aichallenge/awsim/status | std_msgs.msg.Float32MultiArray | Get status of the simulation. |
| /aichallenge/awsim/change_time_scale | std_msgs.msg.Float32 | Set the timescale for the simulation. |
| /aichallenge/awsim/reset | std_msgs.msg.Empty | Reset the simulation. |

The above `/aichallenge/awsim/status` has the following structure.

| Index | Value |
| ----- | --------------- |
| 0 | session timeout |
| 1 | lap count |
| 2 | lap time |
| 3 | section |
| 4 | timescale |

## Vehicle (Racing Kart)

The vehicle conforms to the specifications of the [EGO Vehicle](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/) in AWSIM and is designed with specifications close to an actual racing kart.
Expand Down Expand Up @@ -91,4 +132,28 @@ The Wheel Collider is set as follows. For more details on wheel colliders, pleas

### Sensor Configuration

TODO
#### GNSS

The GNSS is mounted at the following position relative to the vehicle base link.

| **Item** | **Value** |
| -------- | --------- |
| x | 0.0 m |
| y | 0.0 m |
| z | 0.0 m |
| roll | 0.0 rad |
| pitch | 0.0 rad |
| yaw | 0.0 rad |

#### IMU

The IMU is mounted at the following position relative to the vehicle base link.

| **Item** | **Value** |
| -------- | --------- |
| x | 0.0 m |
| y | 0.0 m |
| z | 0.0 m |
| roll | 0.0 rad |
| pitch | 0.0 rad |
| yaw | 0.0 rad |
67 changes: 66 additions & 1 deletion docs/specifications/simulator.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,47 @@

シミュレーターは、Autowareのためのオープンソース自動運転シミュレーター「[AWSIM](https://github.com/tier4/AWSIM)」をベースとして作成されています。

## 起動オプション

| オプション | 型 | デフォルト | 説明 |
| ---------- | ----- | ---------- | ------------------------------------------------- |
| --timeout | float | 420.0 | セッションのタイムアウトを設定します。 |
| --endless | bool | false | セッションのタイムアウトの有効/無効を設定します。 |
| --pit-stop | bool | true | ピットストップ関連の機能の有効/無効を設定します。 |

## キーボード操作

| 操作 | キー |
| ------------------ | ----------------- |
| 終了 | Esc |
| リセット | Space |
| カメラ切り替え | C |
| アクセル | Arrow Up |
| ブレーキ | Arrow Down |
| ステアリング | Arrow Left, Right |
| ギア (D) | D |
| ギア (R) | R |
| ギア (N) | N |
| ギア (P) | P |

## トピック操作

| トピック | 型 | 説明 |
| ------------------------------------ | ------------------------------ | ---------------------------------------------- |
| /aichallenge/awsim/status | std_msgs.msg.Float32MultiArray | シミュレーションの各種状態を取得します。 |
| /aichallenge/awsim/change_time_scale | std_msgs.msg.Float32 | シミュレーションのタイムスケールを設定します。 |
| /aichallenge/awsim/reset | std_msgs.msg.Empty | シミュレーションをリセットします。 |

上記の `/aichallenge/awsim/status` は以下の構造になっています。

| インデックス | 値 |
| ------------ | ------------------------ |
| 0 | セッションのタイムアウト |
| 1 | ラップ数 |
| 2 | ラップタイム |
| 3 | セクション |
| 4 | タイムスケール |

## 車両(レーシングカート)

車両はAWSIMにおける[EGO Vehicle](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/)の仕様に準拠しており、実際のレーシングカートに近いスペックで作成されています。
Expand Down Expand Up @@ -91,4 +132,28 @@ CoM(Center of Mass)は、車両Rigidbodyの質量中心です。CoM位置は、

### センサ構成

TODO
#### GNSS

GNSSは車両のベースリンクに対して以下の位置に取り付けられています。

| **項目** | **値** |
| -------- | ------- |
| x | 0.0 m |
| y | 0.0 m |
| z | 0.0 m |
| roll | 0.0 rad |
| pitch | 0.0 rad |
| yaw | 0.0 rad |

#### IMU

IMUは車両のベースリンクに対して以下の位置に取り付けられています。

| **項目** | **値** |
| -------- | ------- |
| x | 0.0 m |
| y | 0.0 m |
| z | 0.0 m |
| roll | 0.0 rad |
| pitch | 0.0 rad |
| yaw | 0.0 rad |
Loading