Giters

tky129 / hakoniwa-px4sim

PX4-compatible drone simulation with physics-based modeling in C, visualizations via game engines, headless operation, and automated test scenarios. Supports external parameterization and MATLAB/Simulink integration.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build

このリポジトリは、PX4と連携可能なドローンのプラントモデル用シミュレーション環境です。このシミュレーション環境は、ドローンの動作を物理式ベースで正確にモデル化し、C言語で実装しています。

目次

特徴

  1. 物理式ベースのプラントモデル: ドローンの動作は、物理学に基づいた高精度なモデルで表現されています。これはC言語で開発されており、PX4とシームレスに連携します。詳細はこちらを参照ください。障害物との衝突時の物理的反応をリアルタイムにシミュレートできます(v1.1.0)。詳細はこちら。

  2. ゲームエンジンによるビジュアライズ: ドローンのビジュアル表現は、ゲームエンジンを使用して実現しています。このビジュアライズは、物理シミュレーションの補助として機能し、主に可視化を目的としています。障害物との衝突時のビジュアル表現も可能です(v1.1.0)。詳細はこちら

  3. エンジンの柔軟性: 現時点ではUnityエンジンをサポートしていますが、アーキテクチャは他のゲームエンジンとの連携も可能に設計されています。Unreal Engine との連携可能なプラグインはこちら(v1.1.0)。

  4. MATLAB/Simulinkとの互換性: 物理式モデルは、MATLAB/Simulinkで作成したモデルとも連携できるようになっています。

  5. センサモデルの整備: センサモデルはアーキテクチャ内で整理され、明確な仕様に基づいています。これにより、ユーザーはセンサモデルを仕様に合わせて交換することが可能です。詳細はこちらを参照ください。

  6. ヘッドレス対応: Unityなしでのシミュレーションが可能です。これにより、グラフィカルなインターフェースを必要としない環境でも、シミュレーションの実行が可能になります。詳細はこちら(v1.1.0)。

  7. 自動テストのサポート: テストシナリオベースでの自動テストが可能です。これにより、繰り返しのテストや連続したテストの自動化が実現可能になり、開発プロセスの効率化が図れます。詳細はこちらを参照ください。

  8. 機体特性の外部パラメータ化: ドローンの機体特性は外部からのパラメータ化が可能です。これにより、さまざまな機体の特性に合わせたシミュレーションが実現でき、より幅広いテストシナリオへの対応が可能になります。パラメータ設定例はこちら。

環境

  • サポートOS
    • Arm系Mac (M1Mac, M2Mac)
    • Windows 10/11
  • 利用する環境
    • Arm系Macの場合
      • Python 3.10
        • pyenvでインストールされたものを推奨
        • Jinja2 (pip install -U jinja2)
    • Windowsの場合
  • 利用するドローン

事前準備

２つのリポジトリをクローンします。

git clone --recursive https://github.com/toppers/hakoniwa-px4sim.git

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

hakoniwa-unity-drone-model のインストール手順は、以下を参照ください。

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

hakoniwa-px4sim のインストール手順

以下の手順に従って、PX4 のインストールを実施します。

https://github.com/toppers/hakoniwa-px4sim/tree/main/px4

箱庭のインストール手順

以下の手順に従って、箱庭のインストールを実施します。

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

シミュレーション実行手順

端末を２つ用意してください。

  • 端末A：PX4のシミュレータ実行用
  • 端末B：箱庭実行用

端末A

cd hakoniwa-px4sim/px4/PX4-Autopilot

PX4 on SITL をを起動します。

bash ../sim/simstart.bash

成功すると、以下のように、TCPポートのコネクション待ちになります。

% bash ../sim/simstart.bash
[0/1] launching px4 none_iris (SYS_AUTOSTART=10016)

______  __   __    ___ 
| ___ \ \ \ / /   /   |
| |_/ /  \ V /   / /| |
|  __/   /   \  / /_| |
| |     / /^\ \ \___  |
\_|     \/   \/     |_/

px4 starting.

INFO  [px4] startup script: /bin/sh etc/init.d-posix/rcS 0
env SYS_AUTOSTART: 10016
INFO  [param] selected parameter default file parameters.bson
INFO  [param] importing from 'parameters.bson'
INFO  [parameters] BSON document size 568 bytes, decoded 568 bytes (INT32:14, FLOAT:13)
INFO  [param] selected parameter backup file parameters_backup.bson
INFO  [dataman] data manager file './dataman' size is 7868392 bytes
INFO  [init] PX4_SIM_HOSTNAME: localhost
INFO  [simulator_mavlink] Waiting for simulator to accept connection on TCP port 4560

ここから先は、端末Bです。

端末B

cd hakoniwa-px4sim/hakoniwa

Windowsの場合は、以下のコマンドで docker コンテナに入ってください。

bash docker/run.bash

箱庭を起動するためのスクリプトを実行します。

bash run.bash

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

% bash run.bash 
HAKO_CAPTURE_SAVE_FILEPATH : ./capture.bin
HAKO_BYPASS_IPADDR : 127.0.0.1
HAKO_CUSTOM_JSON_PATH : ../config/custom.json
DRONE_CONFIG_PATH : ../config/drone_config.json
HAKO_BYPASS_PORTNO : 54001
INFO: shmget() key=255 size=1129352 
INFO: hako_master_init() success
Robot: DroneAvator, PduWriter: DroneAvator_drone_motor
channel_id: 0 pdu_size: 88
INFO: DroneAvator create_lchannel: logical_id=0 real_id=0 size=88
Robot: DroneAvator, PduWriter: DroneAvator_drone_pos
channel_id: 1 pdu_size: 48
INFO: DroneAvator create_lchannel: logical_id=1 real_id=1 size=48
WAIT START
INFO: px4 reciver start
INFO: COMMAND_LONG ack sended

この際、端末A側で、以下のように poll timeout のメッセージが出ますが、特に問題ないです。

ERROR [simulator_mavlink] poll timeout 0, 111
ERROR [simulator_mavlink] poll timeout 0, 111
ERROR [simulator_mavlink] poll timeout 0, 111

Unity

この状態で、Unityのシミュレーションを開始してください。

スクリーンショット 2024-01-26 9 34 16

そして、START ボタンを押下すると、シミュレーションが動き出します。

端末A

この時、端末Aでは以下のように、準備状態になります。

INFO  [lockstep_scheduler] setting initial absolute time to 1699681315573127 us
INFO  [commander] LED: open /dev/led0 failed (22)
WARN  [health_and_arming_checks] Preflight Fail: ekf2 missing data
INFO  [mavlink] mode: Normal, data rate: 4000000 B/s on udp port 18570 remote port 14550
INFO  [mavlink] mode: Onboard, data rate: 4000000 B/s on udp port 14580 remote port 14540
INFO  [mavlink] mode: Onboard, data rate: 4000 B/s on udp port 14280 remote port 14030
INFO  [mavlink] mode: Gimbal, data rate: 400000 B/s on udp port 13030 remote port 13280
INFO  [logger] logger started (mode=all)
INFO  [logger] Start file log (type: full)
INFO  [logger] [logger] ./log/2023-11-11/05_41_55.ulg	
INFO  [logger] Opened full log file: ./log/2023-11-11/05_41_55.ulg
INFO  [mavlink] MAVLink only on localhost (set param MAV_{i}_BROADCAST = 1 to enable network)
INFO  [mavlink] MAVLink only on localhost (set param MAV_{i}_BROADCAST = 1 to enable network)
INFO  [px4] Startup script returned successfully
pxh> INFO  [tone_alarm] home set
INFO  [tone_alarm] notify negative
INFO  [commander] Ready for takeoff!

ここで、端末Aで以下のコマンドを実行してください。

commander takeoff

成功すると、Unity上のドローンがホバリングしてくれます。

スクリーンショット 2024-01-26 9 36 02

シミュレーション停止方法

シミュレーションを停止するには、以下の順番で停止してください。

  1. Unityのシミュレーションを止める
  2. PX4のシミュレーションを CTRL＋Cで止める
  3. 箱庭のシミュレーションを CTRL+C で止める

QGroundControlとの連携方法

QGroundControlをインストールすることで、QGC側から機体を操作できます。

QGCを起動した後に、PX4との接続設定が必要となります。

画面右上のロゴをクリックすると、下図のように「アプリケーション設定」ができますので、クリックします。

image

次に、「通信リンク」をクリックし、「追加」ボタンを押下します。

image

必要な設定をします。

image

以下を設定しましょう。

  • 名前：hakoniwa (お好きな名前を指定できます)
  • タイプ：UDP
  • ポート：18570
  • サーバーアドレス：OSによって設定が違います
    • Windowsの場合：WSL2上で、eth0 のIPアドレスを調べて設定してください。
    • Windows以外の場合：お使いのethernetのIPアドレスを調べて設定してください。

IPアドレスの調べ方（例）

$ ifconfig eth0
eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 172.29.246.4  netmask 255.255.240.0  broadcast 172.29.255.255
        inet6 fe80::215:5dff:feae:5d59  prefixlen 64  scopeid 0x20<link>
        ether 00:15:5d:ae:5d:59  txqueuelen 1000  (Ethernet)
        RX packets 2104410  bytes 2461696811 (2.4 GB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 1152573  bytes 1569239960 (1.5 GB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

設定後、「サーバー追加」ボタンをおして、「OK」ボタンをクリックします。

image

最後に、「接続」ボタンをクリックすれば設定完了です。

image

以下は、QGCの操作例です。

qgc-op.mp4
  1. 離陸
  2. 東へ移動
  3. 北へ移動

環境からの作用

v1.1.0以降のバージョンでは、シミュレーション環境において、ドローンは外部環からの作用が可能です。

例えば、ゲームエンジンを利用してドローンが障害物に衝突した際の物理的な影響をリアルタイムにシミュレートすることができます。

現時点のサポート状況は以下の通りです。

  • 障害物との衝突
  • 風の影響
  • 直射日光による影響

障害物との衝突

ゲームエンジン上に障害物を配置することで、機体が障害物と干渉した情報を物理モデル側にフィードバックできます。

本機能を利用する場合は、機体パラメータdroneDynamics のcollision_detection を true にします。

設定例：

      "droneDynamics": {
          "physicsEquation": "BodyFrame",
          "collision_detection": true,
          "manual_control": false,
          "airFrictionCoefficient": [ 0.0001, 0.0 ],
          "inertia": [ 0.0000625, 0.00003125, 0.00009375 ],
          "mass_kg": 0.1,
          "body_size": [ 0.1, 0.1, 0.01 ],
          "position_meter": [ 0, 0, 0 ],
          "angle_degree": [ 0, 0, 0 ]
        },

実行例：

2024-01-26.7.21.53.mov

ヘッドレス・シミュレーション

箱庭内のドローンは、UnityおよびPX4を利用せずに、PID 制御を試すことができます（ヘッドレス・シミュレーション）。

作成したドローンのダイナミクスを動作チェックしたい場合に便利です。

https://github.com/toppers/hakoniwa-px4sim/tree/main/hakoniwa/src/assets/drone/controller

コミュニティとサポート

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

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

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

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

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

貢献ガイドライン

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

イシューの報告

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

プルリクエスト

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

コミュニケーション

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

その他の貢献

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

About

PX4-compatible drone simulation with physics-based modeling in C, visualizations via game engines, headless operation, and automated test scenarios. Supports external parameterization and MATLAB/Simulink integration.

Languages

Language:C++ 75.0%Language:Python 12.4%Language:Shell 5.9%Language:CMake 4.1%Language:C 1.9%Language:Dockerfile 0.7%