README.md

このリポジトリは、PX4と連携可能なUnityで作られたドローンシミュレータです。

このシミュレータは、リアルタイムでのドローン飛行のシミュレーションや、飛行制御アルゴリズムのテストなどに使用できます。

ネイティブWindowsで箱庭ドローンシミュレータを利用されたい方は、こちらを参照ください。

目次

• 箱庭ドローンモデル
• PX4との連携について
• サポート環境
  • Mac環境
  • Windows環境
• 利用手順
  • Unityアプリを利用する場合
  • Unityエディタを利用する場合
• コミュニティとサポート
• 本リポジトリの内容とライセンスについて
• 貢献ガイドライン

箱庭ドローンモデル

Unityで作られたドローンモデルは、箱庭オリジナルモデルであり、クアッドコプター型でのものです（下図）。

Unity assets of the Hakoniwa Drone Model H1 are based on data provided by Mr. Hodaka Nakamura of Ida B. Wells-Barnett High School. We want to express our deepest gratitude for his awesome contribution :D

箱庭ドローンモデルH1 のUnityアセットは, 中村歩高さんより提供いただいたデータを基に作成しています．箱庭へのOSS貢献に深く感謝いたします．

PX4との連携について

このドローンシミュレータをPX4と連携させるには、別途 hakoniwa-px4sim リポジトリが必要です。PX4との連携方法については、以下のリンク先に詳細な説明がありますので、ご一読ください。

https://github.com/toppers/hakoniwa-px4sim

サポート環境

Mac環境

• Intel系 Mac
• Arm系 Mac

Windows 環境

• Windows 10/11　WSL2
• Windows 10/11

利用手順

Unity向け箱庭ドローンモデルは、以下の２つの利用形態があります。

1. Unityアプリを利用する場合
2. Unityエディタを利用する場合

1 については、ビルド済みのアプリケーションを利用しますので、セットアップの手間は発生しません。

2 については、Unityエディタを利用しますので、セットアップの手間が発生します。

Unityアプリを利用する場合

Unityアプリを利用する場合の必要な環境

Unity関連の環境は特に必要ありません。

Unityアプリを利用する場合のインストール方法

本リポジトリを以下のようにクローンします。

git clone --recursive https://github.com/toppers/hakoniwa-unity-drone-model.git

クローンが終わったら、以下のようにディレクトリ移動します。

cd hakoniwa-unity-drone-model/

以下のサイトから、ご利用環境に応じたアプリケーションをダウンロードしてください。

https://github.com/toppers/hakoniwa-unity-drone-model/releases

ダウンロードしたzipファイルを hakoniwa-unity-drone-model の下で解凍してください。

以下のディレクトリ構成になります。

hakoniwa-unity-drone-model/DroneApp<OS名>

Unityアプリの起動方法

hakoniwa-unity-drone-model 直下でコマンドを実行してください。

bash bash ./plugin/activate_app.bash DroneApp<OS名>

Windows ネイティブアプリの場合は、DroneWinNative/model.exe をダブルクリックします。

成功するとUnityアプリケーションが起動します。

Unityエディタを利用する場合

Unityエディタを利用する場合に必要な環境

• Homebrew(Mac版のみ)
• Unity Hub
• Unity（各CPUアーキテクチャに対応したもの）
  • 2022.3.5f1 以降
• Python 3.12（pyenvでインストールされたものMac版のみ。）

Unityエディタを利用する場合のインストール方法

本リポジトリを以下のようにクローンします。

git clone --recursive https://github.com/toppers/hakoniwa-unity-drone-model.git

クローンが終わったら、以下のようにディレクトリ移動します。

cd hakoniwa-unity-drone-model/

そして、必要な Unity モジュール類をインストールします。

MacOS　および WSL2　の場合：

bash install.bash 

Winodws　の場合：

bash install.bash win

Unity起動

この状態で Unity Hub で当該プロジェクトを開きましょう。

注意：Unityエディタは、当該CPUアーキテクチャに対応したものをインストールしてご利用ください。

対象フォルダ：hakoniwa-unity-drone-model\plugin\plugin-srcs

Unityのバージョン違いに起因するメッセージ（"Opening Project in Non-Matching Editor Installation"）が出る場合は、「Continue」として問題ありません。

以下のダイアログが出ますが、Continue してください。

次に、以下のダイアログが出ますので、Ignore してください。

成功するとこうなります。

起動直後の状態ですと、コンソール上にたくさんエラーが出ています。原因は以下の２点です。 リンク先を参照して、順番に対応してください。

• Newtonsoft.Json が不足している
• gRPC のライブラリ利用箇所がエラー出力している(Mac版のみ)

シミュレーション環境の準備

下図のように、Unity のシーン（Assets/Scenes/Hakoniwa）をダブルクリックします。

WSL2 の場合

ヒエラルキービューのHakoniwa/Hakoniwa/Robot/DroneAvatorをダブルクリックしてください。

DroneAvator のインスペクタビューを開き、Io_methodとComm_methodを編集します。 デフォルトでは、それぞれ SHM、DIRECTとなっています。

これを以下のように変更してください。

それぞれ RPC、UDPとします。

コンフィグファイルを出力

そして、Window -> Hakoniwa -> Generate をクリックします。

成功すると、コンソール上にエラーログ出力がなく、下図のように json のログが出力されています。

Windowsの場合、本オペレーションは、マシン再起動時に必ず再実行してください。

コンフィグファイル

生成されたコンフィグファイルですが、hakoniwa-unity-drone-model\plugin\plugin-srcs 直下に生成されます。

• core_config.json
• custom.json

custom.jsonの出力は以下の通りとなります。

MacおよびWindowsの場合

{
  "robots": [
    {
      "name": "EnvironmentEffector",
      "rpc_pdu_readers": [],
      "rpc_pdu_writers": [],
      "shm_pdu_readers": [],
      "shm_pdu_writers": []
    },
    {
      "name": "DroneAvator",
      "rpc_pdu_readers": [],
      "rpc_pdu_writers": [],
      "shm_pdu_readers": [
        {
          "type": "hako_mavlink_msgs/HakoHilActuatorControls",
          "org_name": "drone_motor",
          "name": "DroneAvator_drone_motor",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReader",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReaderConverter",
          "channel_id": 0,
          "pdu_size": 88,
          "write_cycle": 1,
          "method_type": "SHM"
        },
        {
          "type": "geometry_msgs/Twist",
          "org_name": "drone_pos",
          "name": "DroneAvator_drone_pos",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReader",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReaderConverter",
          "channel_id": 1,
          "pdu_size": 48,
          "write_cycle": 1,
          "method_type": "SHM"
        },
        {
          "type": "hako_msgs/ManualPosAttControl",
          "org_name": "drone_manual_pos_att_control",
          "name": "DroneAvator_drone_manual_pos_att_control",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 3,
          "pdu_size": 56,
          "write_cycle": 1,
          "method_type": "SHM"
        },
        {
          "type": "hako_msgs/HakoDroneCmdTakeoff",
          "org_name": "drone_cmd_takeoff",
          "name": "DroneAvator_drone_cmd_takeoff",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 5,
          "pdu_size": 32,
          "write_cycle": 1,
          "method_type": "SHM"
        },
        {
          "type": "hako_msgs/HakoDroneCmdMove",
          "org_name": "drone_cmd_move",
          "name": "DroneAvator_drone_cmd_move",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 6,
          "pdu_size": 48,
          "write_cycle": 1,
          "method_type": "SHM"
        },
        {
          "type": "hako_msgs/HakoDroneCmdLand",
          "org_name": "drone_cmd_land",
          "name": "DroneAvator_drone_cmd_land",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 7,
          "pdu_size": 32,
          "write_cycle": 1,
          "method_type": "SHM"
        }
      ],
      "shm_pdu_writers": [
        {
          "type": "hako_msgs/Collision",
          "org_name": "drone_collision",
          "name": "DroneAvator_drone_collision",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 2,
          "pdu_size": 280,
          "write_cycle": 1,
          "method_type": "SHM"
        },
        {
          "type": "hako_msgs/Disturbance",
          "org_name": "drone_disturbance",
          "name": "DroneAvator_drone_disturbance",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 4,
          "pdu_size": 8,
          "write_cycle": 1,
          "method_type": "SHM"
        }
      ]
    }
  ]
}

WSL2の場合

{
  "robots": [
    {
      "name": "EnvironmentEffector",
      "rpc_pdu_readers": [],
      "rpc_pdu_writers": [],
      "shm_pdu_readers": [],
      "shm_pdu_writers": []
    },
    {
      "name": "DroneAvator",
      "rpc_pdu_readers": [
        {
          "type": "hako_mavlink_msgs/HakoHilActuatorControls",
          "org_name": "drone_motor",
          "name": "DroneAvator_drone_motor",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReader",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReaderConverter",
          "channel_id": 0,
          "pdu_size": 88,
          "write_cycle": 1,
          "method_type": "UDP"
        },
        {
          "type": "geometry_msgs/Twist",
          "org_name": "drone_pos",
          "name": "DroneAvator_drone_pos",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReader",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduReaderConverter",
          "channel_id": 1,
          "pdu_size": 48,
          "write_cycle": 1,
          "method_type": "UDP"
        },
        {
          "type": "hako_msgs/ManualPosAttControl",
          "org_name": "drone_manual_pos_att_control",
          "name": "DroneAvator_drone_manual_pos_att_control",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 3,
          "pdu_size": 56,
          "write_cycle": 1,
          "method_type": "UDP"
        },
        {
          "type": "hako_msgs/HakoDroneCmdTakeoff",
          "org_name": "drone_cmd_takeoff",
          "name": "DroneAvator_drone_cmd_takeoff",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 5,
          "pdu_size": 32,
          "write_cycle": 1,
          "method_type": "UDP"
        },
        {
          "type": "hako_msgs/HakoDroneCmdMove",
          "org_name": "drone_cmd_move",
          "name": "DroneAvator_drone_cmd_move",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 6,
          "pdu_size": 48,
          "write_cycle": 1,
          "method_type": "UDP"
        },
        {
          "type": "hako_msgs/HakoDroneCmdLand",
          "org_name": "drone_cmd_land",
          "name": "DroneAvator_drone_cmd_land",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 7,
          "pdu_size": 32,
          "write_cycle": 1,
          "method_type": "UDP"
        }
      ],
      "rpc_pdu_writers": [
        {
          "type": "hako_msgs/Collision",
          "org_name": "drone_collision",
          "name": "DroneAvator_drone_collision",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 2,
          "pdu_size": 280,
          "write_cycle": 1,
          "method_type": "UDP"
        },
        {
          "type": "hako_msgs/Disturbance",
          "org_name": "drone_disturbance",
          "name": "DroneAvator_drone_disturbance",
          "class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriter",
          "conv_class_name": "Hakoniwa.PluggableAsset.Communication.Pdu.Raw.RawPduWriterConverter",
          "channel_id": 4,
          "pdu_size": 8,
          "write_cycle": 1,
          "method_type": "UDP"
        }
      ],
      "shm_pdu_readers": [],
      "shm_pdu_writers": []
    }
  ]
}

コミュニティとサポート

このプロジェクトに関する質問やディスカッションは、箱庭コミュニティフォーラムで行われています。ここでは、プロジェクトに関する疑問の解消、アイデアの共有、フィードバックの提供ができます。また、プロジェクトの最新情報やアップデートについても、ここで情報共有されます。

プロジェクトに関する質問や提案がある場合、または同じ問題に直面している他のユーザーと意見交換をしたい場合は、遠慮なくこちらに投稿してください。

本リポジトリの内容とライセンスについて

本リポジトリのコンテンツに関しては、各ファイルにライセンスが明記されている場合、そのライセンスに従います。特に明記されていないコンテンツについては、TOPPERSライセンス に基づいて公開されています。

TOPPERSライセンスは、オープンソースプロジェクトのためのライセンスであり、ソフトウェアの使用、変更、配布に関する条件を定めています。ライセンスの詳細については、上記リンクを参照してください。

貢献ガイドライン

本プロジェクトへの貢献に興味を持っていただき、ありがとうございます。様々な形での貢献を歓迎しています。以下に、プロジェクトへの貢献方法についてのガイドラインを示します。

イシューの報告

• バグの報告や新機能の提案などは、GitHubのIssuesを通じて行ってください。
• issue を作成する前に、同様の issue が既に存在しないかを確認してください。
• issue を作成する際は、できるだけ多くの情報を提供してください。再現手順、期待される挙動、実際の挙動、使用している環境などが含まれます。

プルリクエスト

• 機能追加やバグ修正など、コードに関する貢献はプルリクエストを通じて行ってください。
• 新機能の追加や大きな変更の場合は、事前に関連する issue で議論を行うことを推奨します。
• コードのスタイルやコーディング規約に一貫性を持たせるため、既存のコードスタイルに従ってください。

コミュニケーション

• プロジェクトに関するディスカッションや質問は、Discussionsで行ってください。
• 他の貢献者とのコミュニケーションは、敬意を持って行ってください。

その他の貢献

• ドキュメントの改善や翻訳など、コード以外の貢献も歓迎します。