docs: update sim vehicle specifications (#15)

* Add Vehicle Specifications and CoM Position * Change configuration * fix Wheel script and Wheel Collider Config script * chore: remove .DS_Store files * docs: Replace component images with table and add simulation model description * fix: revise vehicle specification document --------- Co-authored-by: syn_ReiTomita <[email protected]>
AutomotiveAIChallenge · Jun 10, 2024 · 6662371 · 6662371
1 parent 79b5b1b
commit 6662371
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 52 deletions.
diff --git a/docs/specifications/images/mesh-collider-component.png b/docs/specifications/images/mesh-collider-component.png
diff --git a/docs/specifications/images/rigidbody-component.png b/docs/specifications/images/rigidbody-component.png
diff --git a/docs/specifications/images/vehicle-component.png b/docs/specifications/images/vehicle-component.png
diff --git a/docs/specifications/images/wheel-collider-component.png b/docs/specifications/images/wheel-collider-component.png
diff --git a/docs/specifications/images/wheel-collider.png b/docs/specifications/images/wheel-collider.png
diff --git a/docs/specifications/simulator.en.md b/docs/specifications/simulator.en.md
@@ -11,12 +11,9 @@ The vehicle conforms to the specifications of the [EGO Vehicle](https://tier4.gi
 ![vehicle-appearance](./images/vehicle-appearance.png)
 
 ### Parameters
+The following table summarizes the vehicle parameters.
 
-![vehicle-component](./images/vehicle-component.png)
-
-![rigidbody-component](./images/rigidbody-component.png)
-
-| Item                  | Value      |
+| **Item**                  | **Value**      |
 | --------------------- | ---------- |
 | Vehicle Weight        | 160 kg     |
 | Length                | 200 cm     |
@@ -30,40 +27,59 @@ The vehicle conforms to the specifications of the [EGO Vehicle](https://tier4.gi
 | Maximum Steering Angle| 80°        |
 | Maximum Acceleration  | 3.2 m/s^2  |
 
+#### Vehicle Component
+The following table summarizes the settings of the Vehicle component. For detailed information of the setting items, see [this manual](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/#vehicle-script).
+
+| **Item**                  | **Value**      |
+| ------------------------------- | ------------------------- |
+| **Vehicle Settings**            |                           |
+| Use Inertia                     | Off                         |
+| **Physics Settings (experimental)** |                      |
+| Sleep Velocity Threshold        | 0.02                      |
+| Sleep Time Threshold            | 0                         |
+| Skidding Cancel Rate            | 0.236                     |
+| **Input Settings**              |                           |
+| Max Steer Angle Input           | 80                        |
+| Max Acceleration Input          | 3.2                       |
+
+#### Rigidbody Component
+The following table summarizes the settings of the Rigidbody component. For more information, see [this manual](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/#rigidbody).
+
+| **Item**                  | **Value**      |
+|-------------------------|-----------------|
+| Mass                | 160             |
+| Drag                | 0               |
+| Angular Drag        | 0               |
+
 ### CoM Position
 CoM (Center of Mass) is the mass center of the vehicle Rigidbody. The CoM position is set at the center of the vehicle and at the height of the wheel axles.
 
 ![side-view-of-com](./images/side-view-of-com.png)
 
 ![top-view-of-com](./images/top-view-of-com.png)
 
-### Colliders
-The configuration of the Colliders object is as follows.
-
-![colliders-object](./images/colliders-object.png)
-
-Colliders ensure that the vehicle can make contact with other objects. The MeshCollider component takes the mesh of the vehicle object and constructs a collider based on it.
-
-![mesh-collider-component](./images/mesh-collider-component.png)
+### Vehicle Collider
+Vehicle collider is used to detect collision between the vehicle and other objects or checkpoints. The vehicle collider is created based on the mesh of the vehicle object.
 
 ![body-collider](./images/body-collider.png)
 
 ### Wheel Colliders
-The vehicle has a total of four wheel colliders, one for each wheel, in addition to the visual objects related to the wheels. Wheel colliders are the only parts that make contact with the road.
-
-The Wheel (script) provides a reference to the collider and visual object for the particular wheel. This allows the Vehicle (script) to perform certain actions on each of the wheels, such as:
-
-- Update the steering angle in the WheelCollider.
-- Update the visual part of the wheel depending on the speed and angle of the turn.
-- Update the wheel contact information stored in the WheelHit object.
-- Update the force exerted by the tire forward and sideways depending on the acceleration (including cancellation of skidding).
-- Ensure setting the tire sleep (it is impossible to put Rigidbody to sleep, but putting all wheels to sleep allows to get closer to this effect).
-
-The Wheel Collider Config script is designed to prevent inspector input for wheel colliders, set friction to zero, and only enable wheel suspension and collisions. For more details on wheel colliders, please refer to [this manual](https://docs.unity3d.com/Manual/class-WheelCollider.html).
-
-![wheel-collider-component](./images/wheel-collider-component.png)
+The vehicle has a total of four wheel colliders - one for each wheel, simulating the vehicle on a four-wheel model, rather than a kinematic bicycle model.
 
 ![wheel-collider](./images/wheel-collider.png)
 
+The Wheel Collider is set as follows. For more details on wheel colliders, please refer to [this manual](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/#wheels-colliders).
+
+| **Item**                  | **Value**      |
+| -------------------------- | ------------------------------ |
+| Mass                       | 1                              |
+| Radius                     | 0.12                           |
+| Wheel Damping Rate         | 0.25                           |
+| Suspension Distance        | 0.001                          |
+| **Suspension Spring**      |                                |
+| Spring (N/m)               | 35000                          |
+| Damper (N*s/m)             | 3500                           |
+| Target Position            | 0.01                           |
+
 ### Sensor Configuration
 TODO
diff --git a/docs/specifications/simulator.ja.md b/docs/specifications/simulator.ja.md
@@ -11,12 +11,9 @@
 ![vehicle-appearance](./images/vehicle-appearance.png)
 
 ### パラメータ
+車両のパラメータを以下の表にまとめています。
 
-![vehicle-component](./images/vehicle-component.png)
-
-![rigidbody-component](./images/rigidbody-component.png)
-
-| 項目                | 値        |
+| **項目**                        | **値**                     |
 | ------------------ | --------- |
 | 車両重量             | 160 kg    |
 | 全長                | 200 cm    |
@@ -30,40 +27,58 @@
 | 最大ステアリング転舵角 | 80 °      |
 | 駆動時最大加速度      | 3.2 m/s^2 |
 
+#### Vehicleコンポーネント
+Vehicleコンポーネントの設定内容を以下の表にまとめています。各項目の詳細については[こちらのマニュアル](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/#vehicle-script)をご覧ください。
+
+| **項目**                        | **値**                     |
+| ------------------------------- | ------------------------- |
+| Use Inertia                     | Off                         |
+| **Physics Settings (experimental)** |                      |
+| Sleep Velocity Threshold        | 0.02                      |
+| Sleep Time Threshold            | 0                         |
+| Skidding Cancel Rate            | 0.236                     |
+| **Input Settings**              |                           |
+| Max Steer Angle Input           | 80                        |
+| Max Acceleration Input          | 3.2                       |
+
+#### Rigidbodyコンポーネント
+Rigidbodyコンポーネントの設定内容を以下の表にまとめています。詳細については[こちらのマニュアル](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/#rigidbody)をご覧ください。
+
+| **項目**                | **値**          |
+|-------------------------|-----------------|
+| Mass                | 160             |
+| Drag                | 0               |
+| Angular Drag        | 0               |
+
 ### CoM位置
 CoM(Center of Mass)は、車両Rigidbodyの質量中心です。CoM位置は、車両の中心かつ車輪軸の高さに設定されています。
 
 ![side-view-of-com](./images/side-view-of-com.png)
 
 ![top-view-of-com](./images/top-view-of-com.png)
 
-### コライダー
-Collidersオブジェクトの構成は以下の通りです。
-
-![colliders-object](./images/colliders-object.png)
-
-コライダーは、車両が他のオブジェクトと接触できるように設定します。MeshColliderコンポーネントは車両オブジェクトのメッシュを取得し、それに基づいてコライダーを構築します。
-
-![mesh-collider-component](./images/mesh-collider-component.png)
+### 車両コライダー
+車両コライダーは、車両と他オブジェクトやチェックポイントとの接触判定に利用されます。車両コライダーは車両オブジェクトのメッシュをベースとして作成されています。
 
 ![body-collider](./images/body-collider.png)
 
 ### ホイールコライダー
-車両は、車輪に関連する視覚オブジェクトとともに、各車輪に1つずつ、合計4つのホイールコライダーを持ちます。ホイールコライダーが、道路と接触する唯一の部分です。
-
-Wheelスクリプトは特定の車輪のコライダーと視覚オブジェクトへの参照を提供します。これにより、Vehicleスクリプトは各車輪に対して以下のようなアクションを実行できるようになります：
-
-- ホイールコライダーのステアリング角を更新する
-- 速度とターンの角度に応じて車輪の視覚部分を更新する
-- WheelHitオブジェクトに保存された車輪の接触情報を更新する
-- 加速（スキッドのキャンセルを含む）に応じてタイヤが前方および側方に及ぼす力を更新する
-- タイヤのスリープ設定を保証する（Rigidbodyをスリープ状態にすることは不可能ですが、すべての車輪をスリープ状態にすることで、この効果に近づけます）。
-
-Wheel Collider Configスクリプトは、ホイールコライダーに対するインスペクター入力を防ぎ、摩擦を0に設定し、車輪のサスペンションと衝突のみを有効にするために設定されています。ホイールコライダーの詳細については[こちらのマニュアル](https://docs.unity3d.com/Manual/class-WheelCollider.html)をご覧ください。
-
-![wheel-collider-component](./images/wheel-collider-component.png)
+車両には各車輪に1つずつ、合計4つのホイールコライダーが設定されており、等価二輪モデルではなく四輪モデルでの車両シミュレーションが行われています。
 
 ![wheel-collider](./images/wheel-collider.png)
 
+ホイールコライダーは以下のように設定されています。ホイールコライダーの詳細については[こちらのマニュアル](https://tier4.github.io/AWSIM/Components/Vehicle/EgoVehicle/#wheels-colliders)をご覧ください。
+
+| **項目**                        | **値**                              |
+| -------------------------- | ------------------------------ |
+| Mass                       | 1                              |
+| Radius                     | 0.12                           |
+| Wheel Damping Rate         | 0.25                           |
+| Suspension Distance        | 0.001                          |
+| **Suspension Spring**      |                                |
+| Spring (N/m)               | 35000                          |
+| Damper (N*s/m)             | 3500                           |
+| Target Position            | 0.01                           |
+
 ### センサ構成
 TODO