mavlink-python

MAVLinkを利用した通信・データ処理システムを構築するためのPythonライブラリです。

mavlink-python は、MAVLinkメッセージの送受信だけでなく、メッセージの購読、履歴管理、ログ保存、リプレイなど、MAVLinkを利用するアプリケーションに必要となる機能を提供します。

シミュレーション、Software-in-the-Loop Simulation(SILS)、Hardware-in-the-Loop Simulation(HILS)をはじめ、実機を用いた通信・データ処理にも利用できることを目指しています。

• MAVLink dialectに基づくメッセージの送受信
• Publisher / Subscriberによるメッセージ配信
• マルチスレッド環境を考慮したデータアクセス
• MAVLink telemetry log(.tlog)形式でのログ保存
• コア機能を軽量に保った構成
• 通信媒体をTransportとして抽象化
• 受信したメッセージの履歴管理
• 保存したMAVLinkデータのリプレイ

MAVLinkのメッセージ定義と、通信・データ処理の機能を分離していることが本ライブラリの主要な設計方針です。

バージョンが$(tag)のmavlink-pythonをインストールするには、以下を実行してください。

pip install https://github.com/TeamMeltingPoppo/mavlink-python/releases/download/$(tag)/mavlink-$(tag)-py3-none-any.whl

topic = MAVLinkTopic()
subscriber = topic.create_subscriber(lambda *_: True)
# Connect a transport to the topic.
bridge = MAVLinkBridge(
 transport=transport,
 topic=topic,
)
# Receive messages from the topic.
result = subscriber.get(timeout=1.0)

具体的な実装例についてはexamplesを参照してください。

mavlink-python 自体ではMAVLinkのメッセージを定義しません。

mavlink dialectからコード生成ツールによってPythonのMAVLinkモジュールを生成し、それを mavlink-python から利用します。

MAVLink Dialect
 │
 ▼
Generated MAVLink module
 │
 ├── Message definitions
 ├── Encoder / Decoder
 └── mavlink_map
 │
 ▼
 mavlink-python
 │
 ├── Transport
 ├── Publisher / Subscriber
 ├── History
 └── Logging / Replay

この構成により、MAVLinkのメッセージ定義と、それを利用するアプリケーションの機能を分離できます。

mavlink-python では、以下の分離を重視しています。

1. MAVLinkのメッセージ定義とアプリケーションを分離する
2. 通信媒体とメッセージ処理を分離する
3. メッセージの送受信とアプリケーションによる処理を分離する
4. 記録したMAVLinkデータを、通信入力と同じように再利用できるようにする
5. コアパッケージの依存関係を最小限にする

本ライブラリは、Ground Control Station(GCS)やフライトスタックそのものを置き換えることを目的としていません。

MAVLinkを利用したシステムを構築するための、通信・データ処理の基盤を提供することを目的としています。

mavlink-python は、例えば次のような用途で利用できます。

• SILS / HILS / MILS
• フライトデータロギング
• テレメトリの可視化
• 実機試験
• センサーデータ解析
• 通信試験
• MAVLink通信のリプレイ