Skip to content

Latest commit

 

History

History
 
 

README.md

GT_esmini ドキュメント

GT_esmini (GroundTruth esmini) は、esmini (Environment Simulator Minimalistic) に車両制御・挙動モデル・ライト機能・信号制御・Web UIなどを追加する拡張モジュールです。

入門 (Getting Started)

ドキュメント 内容
概要 GT_esmini の機能と設計思想
ビルド・インストール ビルド手順(Windows / Linux / macOS)
基本的な使い方 API の基本と最初のプログラム
サンプルシナリオ 実用的な使用例とコードサンプル

機能ガイド (Features)

ドキュメント 内容
LightStateAction OpenSCENARIO でのライト制御
AutoLight 自動ライト制御(ブレーキ灯・ウインカー等)

ManualDriveコントローラー

ハンドルコントローラー/ゲームパッドによるリアルタイム車両操作。

ドキュメント 内容
車両パラメータ RealVehicle 物理パラメータ解説

ManualDriveの設定は Web UI の設定パネルまたは config/manual_drive.json で行います。 ボタンマッピング・FFBチューニング・ドメイン制御(横方向/縦方向の手動・シナリオ切り替え)に対応しています。

TrafficSignalController

ドキュメント 内容
(本体コード参照) OpenDRIVE連携の信号制御、フェーズベース自動サイクリング

PythonDriverController (開発凍結中)

Note: Python系機能(PythonDriverController・Embedded Python含む)は v0.8 で開発凍結しています。既存機能は引き続き利用可能です。

ドキュメント 内容
マニュアル 包括的リファレンス(XOSC設定・Python API・物理モデル)
システム構造 アーキテクチャとフレームシーケンス
車両パラメータ RealVehicle 物理パラメータ解説
検証テスト 4段階66テストの構造と実行方法
比較テスト DefaultController との比較テスト
データ形式 .dat バイナリ形式仕様と CSV 変換
信号機修正 + FF制御 信号機再発進修正とモデルベースFF制御

RealDriverController (非推奨・互換用)

ドキュメント 内容
概要 非推奨注記とナビゲーション
コントローラーロジック C++ 側のアーキテクチャ
プロトコル仕様 UDP パケット形式
API リファレンス Python クライアント API
モジュール構成 Python モジュール一覧
サンプルスクリプト 使用例
移行ガイド PythonDriverController への移行手順
LogiDrivePy ステアリングコントローラー連携

Web UI / Electron デスクトップアプリ

ドキュメント 内容
マニュアル Electronアプリ・Web UI の使い方・REST API
API リファレンス 全 REST API エンドポイント仕様

外部連携 (Integration)

ドキュメント 内容
OSI 連携 OSI 統合・デュアル軌跡出力
外部制御 ExternalController / ゴースト設定
FMI 調査 FMU 対応状況の調査結果
TrafficCommand OSI TrafficCommand 調査
外部トリガー シナリオイベントの外部発火
FMU パラメータ制御 FMI パラメータマッピング

リファレンス (Reference)

ドキュメント 内容
アーキテクチャ 設計思想と内部構造
C API リファレンス GT_esminiLib 関数一覧
OpenSCENARIO アクション v1.2 走行関連アクション詳細
RoadManager API Python RM ライブラリ
配布ガイド リリースパッケージ構成

トラブルシューティング

推奨される読む順序

初めて GT_esmini を使う場合

  1. 概要 → 2. ビルド → 3. 基本的な使い方 → 4. サンプル

ManualDriveコントローラーを使いたい場合

  1. 概要 → 2. 車両パラメータ → 3. Web UIマニュアル(ManualDrive設定パネルの使い方)

ライト機能を使いたい場合

  1. LightStateAction → 2. AutoLight → 3. サンプル

Web UI / デスクトップアプリを使いたい場合

  1. Web UIマニュアル → 2. API リファレンス

内部構造を理解したい場合

  1. アーキテクチャ → 2. API リファレンス

外部ドキュメント

ライセンス

GT_esmini は、Mozilla Public License 2.0 の下でライセンスされています。 詳細は LICENSE ファイルを参照してください。